Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-solidity.txt

diff --git a/.vim/bundle/ale/doc/ale-solidity.txt b/.vim/bundle/ale/doc/ale-solidity.txt
new file mode 100644 (file)
index 0000000..7b9e5a7
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-solidity.txt
@@ -0,0 +1,58 @@
+===============================================================================
+ALE Solidity Integration                                 *ale-solidity-options*
+
+
+===============================================================================
+solc                                                        *ale-solidity-solc*
+
+                                         *ale-options.solidity_solc_executable*
+                                               *g:ale_solidity_solc_executable*
+                                                *b:ale_solidity_solc_executable*
+solidity_solc_executable
+g:ale_solidity_solc_executable
+  Type: |String|
+  Default: `'solc'`
+
+  Override the invoked solc binary. For truffle/hardhat binaries.
+
+                                            *ale-options.solidity_solc_options*
+                                                  *g:ale_solidity_solc_options*
+                                                  *b:ale_solidity_solc_options*
+solidity_solc_options
+g:ale_solidity_solc_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass extra options to solc.
+
+
+===============================================================================
+solhint                                                  *ale-solidity-solhint*
+
+  Solhint should work out-of-the-box. You can further configure it using a
+  `.solihint.json` file. See https://github.com/protofire/solhint for more
+  information.
+
+
+===============================================================================
+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).
+
+
+===============================================================================
+forge                                                      *ale-solidity-forge*
+
+  `forge fmt` is not a linter, only a formatter. It should be used only as a
+  fixer.
+
+  `forge fmt` should work out-of-the-box. You can further configure it using
+  `foundry.toml`. See the corresponding documentation for detailed
+  instructions (https://book.getfoundry.sh/reference/config/formatter).
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: