summaryrefslogtreecommitdiff
path: root/doc/ale-thrift.txt
diff options
context:
space:
mode:
authorJon Parise <jon@indelible.org>2017-08-30 10:59:40 -0700
committerJon Parise <jon@indelible.org>2017-08-30 11:08:06 -0700
commitf4c5d29c64ccb1aa02a0d77ca84e52b0ef84eca0 (patch)
tree9fd69f2c9933766853c8481416efc3fa0cc22653 /doc/ale-thrift.txt
parentc7536fb4fdf76747dc3920cb21f39fd702477c90 (diff)
downloadale-f4c5d29c64ccb1aa02a0d77ca84e52b0ef84eca0.zip
Add a linter for Apache Thrift IDL files
This linter works by invoking the `thrift` compiler with the buffer contents and reporting any parser and code generation issues. The handler rolls its own output-matching loop because we have the (unfortunate) requirement of handling error output that spans multiple lines. Unit tests cover both the command callback and handler, and there is initial documentation for all of the option variables.
Diffstat (limited to 'doc/ale-thrift.txt')
-rw-r--r--doc/ale-thrift.txt46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/ale-thrift.txt b/doc/ale-thrift.txt
new file mode 100644
index 00000000..ed858db8
--- /dev/null
+++ b/doc/ale-thrift.txt
@@ -0,0 +1,46 @@
+===============================================================================
+ALE Thrift Integration *ale-thrift-options*
+
+
+===============================================================================
+thrift *ale-thrift-thrift*
+
+The `thrift` linter works by compiling the buffer's contents and reporting any
+errors reported by the parser and the configured code generator(s).
+
+g:ale_thrift_thrift_executable *g:ale_thrift_thrift_executable*
+ *b:ale_thrift_thrift_executable*
+ Type: |String|
+ Default: `'thrift'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_thrift_thrift_generators *g:ale_thrift_thrift_generators*
+ *b:ale_thrift_thrift_generators*
+ Type: |List| of |String|s
+ Default: `['cpp']`
+
+ This list must contain one or more named code generators. Generator options
+ can be included as part of each string, e.g. `['py:dynamic']`.
+
+
+g:ale_thrift_thrift_includes *g:ale_thrift_thrift_includes*
+ *b:ale_thrift_thrift_includes*
+ Type: |List| of |String|s
+ Default: `[]`
+
+ This list contains paths that will be searched for thrift `include`
+ directives.
+
+
+g:ale_thrift_thrift_options *g:ale_thrift_thrift_options*
+ *b:ale_thrift_thrift_options*
+ Type: |String|
+ Default: `'-strict'`
+
+ This variable can be changed to customize the additional command-line
+ arguments that are passed to the thrift compiler.
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: