hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

testing_highlighting.md: Describe syntax highlighting test file format and init approach

Browse Source
This commit is contained in:
Karol Lewandowski 2023-06-26 13:00:25 +02:00
parent b5c5baed38
commit 494db77225
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
topics/basics/testing_plugins/testing_highlighting.md
View File

@ -25,6 +25,22 @@ This is done by calling `CodeInsightTestFixture.enableInspections()` in the setu
To test syntax highlighting provided by [Lexer](implementing_lexer.md), use [`EditorTestUtil.testFileSyntaxHighlighting()`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/EditorTestUtil.java). To test syntax highlighting provided by [Lexer](implementing_lexer.md), use [`EditorTestUtil.testFileSyntaxHighlighting()`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/EditorTestUtil.java).
This method takes the tested file and the answer file describing expected highlighting information for each token.
The answer file format is as follows:
```
token_value
EXPECTED_TEXT_ATTRIBUTE_KEY => FALLBACK_KEY
string␣value
MY_TEXT_ATTRIBUTE_KEY => MY_FALLBACK_KEY => DEFAULT_STRING
```
It starts with token value, which is the actual token value from the tested file (space characters in token value are replaced with `␣`).
It is followed by indented list of text attribute keys, starting with the key defined for the given token, followed by fallback keys separated by ` => `.
Creating an answer file from scratch would be cumbersome process, so it is recommended to provide only the tested file and executing the test.
Test will fail and the expected answer file will be generated.
Review the generated file carefully, and provide fixes to the syntax highlighter and the answer file if needed.
## Expected Highlighting Results ## Expected Highlighting Results
The expected results of the highlighting are specified directly in the source file. The expected results of the highlighting are specified directly in the source file.