Read This!

The JSON files in this directory are not meant to be edited by hand.

If you need to make modification, the respective files should be changed within the repository's syntaxes/src directory.

Running yarn build:syntaxes will then appropriately update the files in this directory.

Syntaxes

This directory specifies TextMate grammars used by VSCode to syntax highlight Angular source code.

Adding a new grammar

To add a new grammar (not modifying an existing one), write the grammar as a JSON file in this directory and register it in the root directory's package.json under the contributes.grammars array.

Testing grammars

This repository uses vscode-tmgrammar-test for testing VSCode TextMate grammars.

Snapshot Tests

Snapshot test cases are specified in test/cases.json.

• The source file to test the grammar on should go in test/data/.
• If an external grammar is needed (e.g. for HTML) is needed, a dummy grammar can be specified in test/dummy/ and will be automatically picked up by the grammar test driver.
• Each snapshot tests requires a language scope to test. Generally, this is the scope name of the grammar being tested (e.g. inline-template.ng for the inline template grammar). This scope will become the base name of the grammar matched for everything in the source file being tested, upon which more specific grammar matches will be stacked.

Snapshot golden files can be updated by running

yarn test:legacy-syntaxes -u

in the root directory of this repository. Goldens must be updated when a new test case is added. Be sure to check that the updated golden file looks as you expect.