Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation about LSP tests in README.md #1587

Merged
merged 2 commits into from
Mar 2, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ cd $LF
./gradlew test --tests org.lflang.tests.runtime.CTest.runConcurrentTests
```

### LSP tests

LSP tests run target language tools to lint and find errors in target code such as reaction bodies.
They work by inserting errors into files in this directory, running LFC on them in LSP mode, and
verifying that errors are reported correctly. When a test fails, an error message is printed that
explains why; such an error message will include the string "the expected error could not be found."
The contents of the altered LF file (including the inserted error) are printed, with an arrow `->`
marking the line on which an error message should have been reported.

### See also

Expand Down