Skip to content

Commit df7f7ed

Browse files
committed
chore: Update readme
1 parent 0393f0f commit df7f7ed

1 file changed

Lines changed: 22 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JSON Embedded Languages
22
Syntax Highlighting for embedded languages within `JSON` and `JSONC` files.
3-
It does so by overriding the default `JSON` and `JSONC` languages and assigning a scopeName to each object with the form `.meta.embedded.objectkey.`.
3+
It does so by overriding the default `JSON` and `JSONC` languages and assigning a scopeName to each object with the form `.meta.objectkey.`.
44
Then using multiple injection grammars that target those scopeNames and inject specific languages into it.
55

66

@@ -9,19 +9,33 @@ Then using multiple injection grammars that target those scopeNames and inject s
99
* ShellScript within `"scripts"` for `package.json` (`JSON`)
1010
![Example `package.json/scripts`](images/Example-scripts.png)
1111

12-
* [when-clause-contexts](https://code.visualstudio.com/api/references/when-clause-contexts) within `"when"` for `package.json` and `keybindings.json` (`JSON`)
12+
* [when-clause-contexts](https://code.visualstudio.com/api/references/when-clause-contexts) within `"when"` for `package.json` (`JSON`) & `keybindings.json` (`JSONC`)
1313
![Example `package.json/when`](images/Example-when.png)
1414

15-
* JSON escaped JavaScript Regular Expressions within `"wordPattern"`, `"folding"`, `"onEnterRules"` and `"indentationRules"` for `language-configuration.json` (`JSONC`)
15+
* JSON escaped JavaScript Regular Expressions within `"wordPattern"`, `"folding"`, `"onEnterRules"` & `"indentationRules"` for `language-configuration.json` (`JSONC`) and `"regexp"`, `"beginsPattern"` & `"endsPattern"` for `package.json` (`JSON`), `tasks.json` & `workspace.code-workspace` (`JSONC`)
1616
![Example `language-configuration.json`](images/Example-language-configuration.png)
1717

18-
* Snippets, Regex and Markdown within `"defaultSnippets"`, `"pattern"` and `"markdownDescription"` for `.schema.json` (`JSON`)
18+
* Snippets, Regex and Markdown within `"defaultSnippets"`, `"patternProperties"`, `"pattern"` and `"markdownDescription"` for `.schema.json` (`JSON`)
1919
Recommend the [Snippets Snippets](https://marketplace.visualstudio.com/items?itemName=RedCMD.snippets-snippets) extension
2020
![Example `schema.json`](images/Example-schema.png)
2121

22-
* Glob patterns within `"filenamePatterns"` and `"fileMatch"` for `package.json`
22+
* Glob patterns within `"activationEvents"`, `"files"`, `"workspaces"`, `"jsonValidation"`, `"filenamePattern"`, `"filenamePatterns"` & `"fileMatch"` for `package.json`
2323
![Example `package.json/filenamePatterns`](images/Example-filenamePatterns.png)
2424

25+
## Supported Files
26+
#### JSON
27+
* `package.json`
28+
* `schema.json`
29+
* `colorize-results.json`
30+
* `color-theme.json`
31+
#### JSONC
32+
* `language-configuration.json`
33+
* `keybindings.json`
34+
* `settings.json`
35+
* `launch.json`
36+
* `tasks.json`
37+
* `tsconfig.json`
38+
* `workspace.code-workspace`
2539

2640
## Known Issues
2741

@@ -31,7 +45,7 @@ Please report any [issues](https://github.com/RedCMD/JSON-Embedded-Languages/iss
3145

3246
VSCode TextMate injections are rather slow.
3347
It may take longer for documents to fully syntax highlight.
34-
The `"injectionSelector"` for `regexp` is almost 10,000 characters long.
48+
The `"injectionSelector"` for `regexp` is well over 10,000 characters long.
3549

3650

3751
## For more information
@@ -47,6 +61,6 @@ The `"injectionSelector"` for `regexp` is almost 10,000 characters long.
4761

4862

4963
## TODO:
50-
* Support args
64+
* Support command arguments inside `"args"`
65+
* Support Markdown Links inside `"contents"` under `"viewsWelcome"`
5166
* Improve performance
52-
* Fix false positives

0 commit comments

Comments
 (0)