VS Code: Validate generated code #828

petervdonovan · 2022-01-07T03:35:08Z

This PR adds validation on save, with error/warning/info/hint squiggles (usually) reported to the correct lines. In master, this feature only exists for C++.

Changes:

C++
- MSVC: Now syntax checks can be performed on Windows on save, without compiling.
- Known issues:
  - Clang-tidy is too slow to be the default syntax checker on any OS. Clang ~~should later be added~~ has been added as an alternative.
  - MSVC checks syntax slowly.
Python
- Pylint is now the default Python linter. It is used if it is installed.
- compileall is used for syntax checking as a backup.
TypeScript
- ESLint is used for linting. It can always be used (by anyone with npm/pnpm) because it is a dev dependency in package.json.
- tsc is used in addition to ESLint for slower, more thorough checks, but only if ESLint does not find any errors.
Rust
- Clippy is the Rust linter. It can always be used (by anyone with cargo) because it comes with cargo.

Changes will be added for C when that part of the code base stabilizes. Validation on save currently does not work properly for the C target.

(and refactor for code reuse)

This was mentioned during code review. IntelliJ automates this, so this change should make the guideline easier to follow.

…ted-code

I assume that people will be unhappy if compilation fails just because they used `let` instead of `const`.

This change does not affect standalone mode or complete builds.

This commit addresses a weird special case that we should not support (#657). We should revert it.

This is necessary to keep changes in this branch from making TSGenerator harder to maintain. It also addresses a TODO that has been at the top of doGenerate for some time.

I assume that these bugs were tolerated or ignored because they are in error reporting code, which means they only cause errors when some other error has already occurred.

Resolves conflicts in TSGenerator.kt.

This tests handling of cases in which preferred software is not present on the system.

This reverts commit b5b25ab.

petervdonovan · 2022-01-17T21:58:15Z

Hm, the only difference between the latest commit and c17701b (for which all tests passed, except benchmark tests which were canceled to save resources) is an extra CodeCov report, and now ReflexGameTest seems to fail in a way that I cannot reproduce locally on the same OS. This seems very strange.

Edit: (probably) solved by 49806b3, but still with many unanswered questions.

This reverts commit 8485495.

It is a complete mystery to me why this bug appeared when it did (after a clearly unrelated change), why it did not appear earlier, and why I could not reproduce it on my machine.

This reverts commit 441a11a.

petervdonovan · 2022-01-18T04:34:43Z

I am very glad @lhstrh encouraged me to write more tests in this branch because the tests uncovered several bugs.

#850 should probably be merged before this PR. Other than that, I think this is PR is finally ready, unless there are any last-minute concerns, or unless we would like to merge scalability-banks first so that the conflicts are less bad.

lhstrh

I agree, this looks ready to merge. This represents a really significant chunk of work that's really crosscutting. Truly impressive!

.github/workflows/lsp-tests.yml

example/C/src/ReflexGame/ReflexGameTest.lf

org.lflang/src/org/lflang/ASTUtils.xtend

This reverts commit 4e2fd35.

lhstrh · 2022-01-18T07:55:18Z

Note that CI is not running because of a misconfiguration: https://github.com/lf-lang/lingua-franca/actions/runs/1711584881

petervdonovan · 2022-01-18T08:12:47Z

Right, this is because workflow references have to be changed to master in order for this branch to be deleted. I will revert that change to run CI, but then revert the revert. The inconsistency should be taken care of by the merge.

This reverts commit 5966476.

This reverts commit fe4c64d.

petervdonovan and others added 30 commits December 28, 2021 21:13

Do not fail silently with uncaught exceptions.

95e571f

Add Jackson as dependency.

8139acf

Minor cleanups.

27a34f7

Rust: Report errors on correct lines.

bd720b5

(and refactor for code reuse)

Discourage wildcard imports.

ae862f3

This was mentioned during code review. IntelliJ automates this, so this change should make the guideline easier to follow.

C++, Rust: Increase specificity of diagnostic reports.

1faa529

Discourage wildcard imports in Kotlin files.

d1a36e1

Tag all verbatim code blocks without breaking Python.

f5852ef

TS: Get ESLint up and running.

3096930

TS: Combine linting and more thorough type checks.

465a12f

Do not print possibly non-human-readable command output.

f629b6e

Merge branch 'vscode-handle-build-result' into vscode-validate-genera…

d3bd76c

…ted-code

TS: Do not lint in standalone mode.

f67c608

I assume that people will be unhappy if compilation fails just because they used `let` instead of `const`.

TS: Skip pnpm install if node_modules exists already.

3466cf9

This change does not affect standalone mode or complete builds.

Bugfix.

d90f221

Bugfix.

a96b700

This commit addresses a weird special case that we should not support (#657). We should revert it.

TS: Refactor TSGenerator.

7a65f5b

This is necessary to keep changes in this branch from making TSGenerator harder to maintain. It also addresses a TODO that has been at the top of doGenerate for some time.

Port base Validator to Java; refactor accordingly.

6142f9f

Python: Basic, minimal syntax checking.

4a5bad4

ErrorReporter: Make API more consistent.

c5a0071

Python: The default validator is now Pylint.

9bb9df5

Python: Address false positives from Pylint.

dda288a

Python: Fix some tests.

0da08f2

I assume that these bugs were tolerated or ignored because they are in error reporting code, which means they only cause errors when some other error has already occurred.

C: Tiny progress report change.

d3f3e06

C++: Report MSVC errors in correct locations.

01a69c2

C++ validator: Stylistic cleanups.

da731e6

Python: Silence a false positive (and some true positives).

d30b0cb

Merge branch 'master' into vscode-validate-generated-code

5e22fe2

Resolves conflicts in TSGenerator.kt.

Add comments.

7509f86

Style: Prefer imperatives to third person.

ecbdd04

petervdonovan force-pushed the vscode-validate-generated-code branch 6 times, most recently from 27a6386 to b63c234 Compare January 17, 2022 01:58

Tests: Attempt to uninstall.

c17701b

This tests handling of cases in which preferred software is not present on the system.

petervdonovan force-pushed the vscode-validate-generated-code branch from b63c234 to c17701b Compare January 17, 2022 03:58

petervdonovan added 3 commits January 16, 2022 22:08

CI: Attempt to repair holes in CodeCov reports.

b5b25ab

Revert "CI: Attempt to repair holes in CodeCov reports."

b0196a4

This reverts commit b5b25ab.

CI: Add missing CodeCov report.

8485495

petervdonovan added 6 commits January 17, 2022 14:14

TS: Repair handling of user-provided config files.

acf9859

Revert "CI: Add missing CodeCov report."

441a11a

This reverts commit 8485495.

CI: Attempt to debug failure that cannot be reproduced locally.

4e2fd35

LSP: Repair off-by-one error in GeneratorBase.

49806b3

It is a complete mystery to me why this bug appeared when it did (after a clearly unrelated change), why it did not appear earlier, and why I could not reproduce it on my machine.

LSP: Minor cleanups.

945cd80

Revert "Revert "CI: Add missing CodeCov report.""

97d9354

This reverts commit 441a11a.

CI: Update workflow refs.

5966476

lhstrh approved these changes Jan 18, 2022

View reviewed changes

.github/workflows/lsp-tests.yml Show resolved Hide resolved

example/C/src/ReflexGame/ReflexGameTest.lf Outdated Show resolved Hide resolved

org.lflang/src/org/lflang/ASTUtils.xtend Outdated Show resolved Hide resolved

petervdonovan added 2 commits January 17, 2022 23:47

Comments only.

7ae66a0

Revert "CI: Attempt to debug failure that cannot be reproduced locally."

72d793f

This reverts commit 4e2fd35.

petervdonovan and others added 3 commits January 18, 2022 00:13

Revert "CI: Update workflow refs."

fe4c64d

This reverts commit 5966476.

Merge branch 'master' into vscode-validate-generated-code

c9939f6

Revert "Revert "CI: Update workflow refs.""

b65f376

This reverts commit fe4c64d.

petervdonovan merged commit 1da8d58 into master Jan 18, 2022

petervdonovan deleted the vscode-validate-generated-code branch January 18, 2022 16:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VS Code: Validate generated code #828

VS Code: Validate generated code #828

petervdonovan commented Jan 7, 2022 •

edited

Loading

petervdonovan commented Jan 17, 2022 •

edited

Loading

petervdonovan commented Jan 18, 2022

lhstrh left a comment

lhstrh commented Jan 18, 2022

petervdonovan commented Jan 18, 2022

VS Code: Validate generated code #828

VS Code: Validate generated code #828

Conversation

petervdonovan commented Jan 7, 2022 • edited Loading

petervdonovan commented Jan 17, 2022 • edited Loading

petervdonovan commented Jan 18, 2022

lhstrh left a comment

Choose a reason for hiding this comment

lhstrh commented Jan 18, 2022

petervdonovan commented Jan 18, 2022

petervdonovan commented Jan 7, 2022 •

edited

Loading

petervdonovan commented Jan 17, 2022 •

edited

Loading