summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-09-09 11:55:42 +0100
committerGitHub <noreply@github.com>2018-09-09 11:55:42 +0100
commit0948dcc435201f0ea62a22c53ce31971a75cba35 (patch)
treeb63ae0f4a50b62703823b56bf63987747046748e /doc
parent395aba19c37a4bc4ead34f115381227d7b71bc0a (diff)
parenta97ef49c5174f5d60f2dc68718d96965361f3d4e (diff)
downloadale-0948dcc435201f0ea62a22c53ce31971a75cba35.zip
Merge pull request #1897 from LEI/add-sqlfmt-fixer
Add support for sqlfmt
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-sql.txt25
-rw-r--r--doc/ale.txt4
2 files changed, 28 insertions, 1 deletions
diff --git a/doc/ale-sql.txt b/doc/ale-sql.txt
new file mode 100644
index 00000000..75d4b0cf
--- /dev/null
+++ b/doc/ale-sql.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE SQL Integration *ale-sql-options*
+
+
+===============================================================================
+sqlfmt *ale-sql-sqlfmt*
+
+g:ale_sql_sqlfmt_executable *g:ale_sql_sqlfmt_executable*
+ *b:ale_sql_sqlfmt_executable*
+ Type: |String|
+ Default: `'sqlfmt'`
+
+ This variable sets executable used for sqlfmt.
+
+g:ale_sql_sqlfmt_options *g:ale_sql_sqlfmt_options*
+ *b:ale_sql_sqlfmt_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the sqlfmt fixer.
+ At this time only the -u flag is available to format with upper-case.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 983fa462..1799f413 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -279,6 +279,8 @@ CONTENTS *ale-contents*
solium..............................|ale-solidity-solium|
spec..................................|ale-spec-options|
rpmlint.............................|ale-spec-rpmlint|
+ sql...................................|ale-sql-options|
+ sqlfmt..............................|ale-sql-sqlfmt|
stylus................................|ale-stylus-options|
stylelint...........................|ale-stylus-stylelint|
tcl...................................|ale-tcl-options|
@@ -451,7 +453,7 @@ Notes:
* SML: `smlnj`
* Solidity: `solhint`, `solium`
* Stylus: `stylelint`
-* SQL: `sqlint`
+* SQL: `sqlint`, `sqlfmt`
* Swift: `swiftlint`, `swiftformat`
* Tcl: `nagelfar`!!
* Terraform: `tflint`