Skip to content

Commit

Permalink
Document the reasons why identifierCase is experimental
Browse files Browse the repository at this point in the history
Refs #809
  • Loading branch information
nene committed Dec 20, 2024
1 parent e1c3df3 commit f4cda21
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/identifierCase.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ This option doesn't yet support all types of identifiers:
- prefixed variables like `@my_var` are not converted.
- parameter placeholders like `:param` are not converted.

**NB!** The use of this option is generally not recommended,
because SQL Formatter leans on the side of detecting as few keywords as possible
(to avoid converting them to uppercase when `keywordCase: "upper"` is used),
which on the flip side means that everything else will be labeled as identifiers.

The only reasonable cases to use this option is when you want all your SQL to
be either in uppercase or lowercase. But if you only want keywords to be in
uppercase, only use the `keywordCase: "upper"` option.

## Options

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

0 comments on commit f4cda21

Please sign in to comment.