Mark the indentStyle config option as deprecated

sql-formatter-org · Jan 22, 2024 · 9c4073c · 9c4073c
1 parent ee56459
commit 9c4073c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -181,7 +181,7 @@ All fields are optional and all fields that are not specified will be filled wit
 - [**`dataTypeCase`**](docs/dataTypeCase.md) uppercases or lowercases data types.
 - [**`functionCase`**](docs/functionCase.md) uppercases or lowercases function names.
 - [**`identifierCase`**](docs/identifierCase.md) uppercases or lowercases identifiers. (**experimental!**)
-- [**`indentStyle`**](docs/indentStyle.md) defines overall indentation style.
+- [**`indentStyle`**](docs/indentStyle.md) defines overall indentation style. (**deprecated!**)
 - [**`logicalOperatorNewline`**](docs/logicalOperatorNewline.md) newline before or after boolean operator (AND, OR, XOR).
 - [**`expressionWidth`**](docs/expressionWidth.md) maximum number of characters in parenthesized expressions to be kept on single line.
 - [**`linesBetweenQueries`**](docs/linesBetweenQueries.md) how many newlines to insert between queries.

diff --git a/docs/indentStyle.md b/docs/indentStyle.md
@@ -1,4 +1,4 @@
-# indentStyle
+# indentStyle (DEPRECATED!)
 
 Switches between different indentation styles.
 
@@ -11,6 +11,7 @@ Switches between different indentation styles.
 Caveats of using `"tabularLeft"` and `"tabularRight"`:
 
 - `tabWidth` option is ignored. Indentation will always be 10 spaces, regardless of what is specified by `tabWidth`.
+- The implementation of these styles is more of a bolted-on feature which has never worked quite as well as the `"standard"` style.
 
 ### standard