summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJeff Sutherland <jeffdsuth@gmail.com>2017-09-14 00:45:18 +0700
committerJeff Sutherland <jeffdsuth@gmail.com>2017-09-14 01:59:22 +0700
commit7302bedc5edb814c183109422271151af7ad7495 (patch)
tree65a47a32ae1a6816e650ed4e9d0120470028f20b /doc
parent91df9ba2c0ccbe53e7838d16642e00c6280eefaa (diff)
downloadale-7302bedc5edb814c183109422271151af7ad7495.zip
Add solidity linter: solium
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-solidity.txt16
-rw-r--r--doc/ale.txt3
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/ale-solidity.txt b/doc/ale-solidity.txt
new file mode 100644
index 00000000..3dea123e
--- /dev/null
+++ b/doc/ale-solidity.txt
@@ -0,0 +1,16 @@
+===============================================================================
+ALE Solidity Integration *ale-solidity-options*
+
+
+===============================================================================
+solium *ale-solidity-solium*
+
+ Use of Solium linter for Solidity source code requires a .soliumrc.json
+ file in project root. This file can be generated by running `solium --init`.
+ See the corresponding solium usage for detailed instructions
+ (https://github.com/duaraghav8/Solium#usage).
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+
diff --git a/doc/ale.txt b/doc/ale.txt
index ae3aa48e..32ef0a6d 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -146,6 +146,8 @@ CONTENTS *ale-contents*
shellcheck..........................|ale-sh-shellcheck|
sml...................................|ale-sml-options|
smlnj...............................|ale-sml-smlnj|
+ solidity..............................|ale-solidity-options|
+ solium..............................|ale-solidity-solium|
spec..................................|ale-spec-options|
rpmlint.............................|ale-spec-rpmlint|
stylus................................|ale-stylus-options|
@@ -275,6 +277,7 @@ Notes:
* Scala: `scalac`, `scalastyle`
* Slim: `slim-lint`
* SML: `smlnj`
+* Solidity: `solium`
* Stylus: `stylelint`
* SQL: `sqlint`
* Swift: `swiftlint`, `swiftformat`