summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKevin Kays <kkays@raybeam.com>2017-07-13 18:41:01 -0400
committerw0rp <w0rp@users.noreply.github.com>2017-07-13 23:41:01 +0100
commit4c50aec79c158a61de27f273e1d338fb1d817021 (patch)
treed37c582252ac0655e732545f85930b97567a1eb5 /doc
parent4c6c5bf84fa31ab18ff83122c12b7e8edb18bd1e (diff)
downloadale-4c50aec79c158a61de27f273e1d338fb1d817021.zip
Add scalastyle linter (#766)
* Add support for scalastyle * Add scalastyle docs * scalastyle support for column numbers * off by one column * Add tests for scalastyle command and handler * update readme for scalastyle * allow full scalastyle options instead of just config file * fix indentation * allow scalastyle config file in parent directories by a couple names. * check for missing match args with empty * remove echo * use a for loop
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-scala-scalastyle.txt25
-rw-r--r--doc/ale.txt4
2 files changed, 28 insertions, 1 deletions
diff --git a/doc/ale-scala-scalastyle.txt b/doc/ale-scala-scalastyle.txt
new file mode 100644
index 00000000..c819e003
--- /dev/null
+++ b/doc/ale-scala-scalastyle.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Scala Integration *ale-scala-options*
+
+
+===============================================================================
+scalastyle *ale-scala-scalastyle*
+
+g:ale_scalastyle_config_loc *g:ale_scalastyle_config_loc*
+
+ Type: |String|
+ Default: `''`
+
+ A string containing the location of a global fallback config file.
+ By default, ALE will look for a config file named `scalastyle_config.xml` or
+ `scalastyle-config.xml` in the current file's directory or parent directories.
+
+g:ale_scala_scalastyle_options *g:ale_scala_scalastyle_options*
+
+ Type: |String|
+ Default: `''`
+
+ A string containing additional options to pass to scalastyle.
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index eafbbcc3..e027ef16 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -93,6 +93,8 @@ CONTENTS *ale-contents*
rustc...............................|ale-rust-rustc|
sass..................................|ale-sass-options|
stylelint...........................|ale-sass-stylelint|
+ scala.................................|ale-scala-options|
+ scalastyle..........................|ale-scala-scalastyle|
scss..................................|ale-scss-options|
stylelint...........................|ale-scss-stylelint|
sh....................................|ale-sh-options|
@@ -206,7 +208,7 @@ The following languages and tools are supported.
* Ruby: 'reek', 'rubocop'
* SASS: 'sasslint', 'stylelint'
* SCSS: 'sasslint', 'scsslint', 'stylelint'
-* Scala: 'scalac'
+* Scala: 'scalac', 'scalastyle'
* Slim: 'slim-lint'
* SML: 'smlnj'
* Stylus: 'stylelint'