mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-10-22 22:46:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: Document upstream JSONC Prettier issues (#19552)

Browse source
This commit is contained in:
Peter Tripp 2024-10-22 14:43:21 +00:00 committed by GitHub
parent b3aa7055e4
commit 270e13bb9a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/src/languages/json.md
View file

@ -10,6 +10,26 @@ JSON support is available natively in Zed.
Zed also supports a super-set of JSON called JSONC, which allows single line comments (`//`) in JSON files.
While editing these files you can use `cmd-/` (macOS) or `ctrl-/` (Linux) to toggle comments on the current line or selection.
## JSONC Prettier Formatting
If you use files with the `*.jsonc` extension when using `Format Document` or have `format_on_save` enabled, Zed invokes Prettier as the formatter. Prettier has an [outstanding issue](https://github.com/prettier/prettier/issues/15956) where it will add trailing commas to files with a `jsonc` extension. JSONC files which have a `.json` extension are unaffected.
To workaround this behavior you can add the following to your `.prettierrc`
```json
{
"overrides": [
{
"files": ["*.jsonc"],
"options": {
"parser": "json",
"trailingComma": "none"
}
}
]
}
```
<!--
TBD: JSONC Example for how to use `file_types`
TBD: Add formatter (prettier) settings (autoformat, tab_size, etc)