Skip to content

Commit 1d434e2

Browse files
committed
fix: custom description, add readme desc
1 parent 07ae785 commit 1d434e2

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,14 @@ This makes SQL Formatter available as a global variable `window.sqlFormatter`.
202202
- [Vim extension](https://github.com/fannheyward/coc-sql/)
203203
- [Prettier plugin](https://github.com/un-ts/prettier/tree/master/packages/sql)
204204

205+
We provide **JSON Schema** for `.sql-formatter.json` configuration file, enabling autocompletion and IntelliSense support in editors.
206+
207+
- [JSON Schema link](https://raw.githubusercontent.com/sql-formatter-org/sql-formatter/refs/heads/master/schema.json)
208+
- **Usage Guides:**
209+
- [Using the schema in VSCode](https://code.visualstudio.com/docs/languages/json#_mapping-in-the-user-settings)
210+
- [Using the schema in Zed](https://zed.dev/docs/languages/json#schema-specification-via-settings)
211+
212+
205213
### Usage as ESLint plugin
206214

207215
- Inside `eslint-plugin-sql` by using the rule [eslint-plugin-sql#format](https://github.com/gajus/eslint-plugin-sql#format).

json-schema/schema.json renamed to schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
}
104104
},
105105
"custom": {
106-
"description": "To allow for :name, @name and/or $name syntax for named placholders.",
106+
"description": "An option to implement custom syntax for parameter placeholders. See below for details.",
107107
"type": "array",
108108
"items": {
109109
"type": "object",

0 commit comments

Comments
 (0)