Skip to content

Commit f4cda21

Browse files
committed
Document the reasons why identifierCase is experimental
Refs #809
1 parent e1c3df3 commit f4cda21

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/identifierCase.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ This option doesn't yet support all types of identifiers:
77
- prefixed variables like `@my_var` are not converted.
88
- parameter placeholders like `:param` are not converted.
99

10+
**NB!** The use of this option is generally not recommended,
11+
because SQL Formatter leans on the side of detecting as few keywords as possible
12+
(to avoid converting them to uppercase when `keywordCase: "upper"` is used),
13+
which on the flip side means that everything else will be labeled as identifiers.
14+
15+
The only reasonable cases to use this option is when you want all your SQL to
16+
be either in uppercase or lowercase. But if you only want keywords to be in
17+
uppercase, only use the `keywordCase: "upper"` option.
18+
1019
## Options
1120

1221
- `"preserve"` (default) preserves the original case.

0 commit comments

Comments
 (0)