]> git.madduck.net Git - etc/vim.git/blob - .vim/bundle/ale/doc/ale-solidity.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge commit '56df844d3c39ec494dacc69eae34272b27db185a' as '.vim/bundle/asyncomplete'
[etc/vim.git] / .vim / bundle / ale / doc / ale-solidity.txt
1 ===============================================================================
2 ALE Solidity Integration                                 *ale-solidity-options*
3
4
5 ===============================================================================
6 solc                                                        *ale-solidity-solc*
7
8                                          *ale-options.solidity_solc_executable*
9                                                *g:ale_solidity_solc_executable*
10                                                 *b:ale_solidity_solc_executable*
11 solidity_solc_executable
12 g:ale_solidity_solc_executable
13   Type: |String|
14   Default: `'solc'`
15
16   Override the invoked solc binary. For truffle/hardhat binaries.
17
18                                             *ale-options.solidity_solc_options*
19                                                   *g:ale_solidity_solc_options*
20                                                   *b:ale_solidity_solc_options*
21 solidity_solc_options
22 g:ale_solidity_solc_options
23   Type: |String|
24   Default: `''`
25
26   This variable can be set to pass extra options to solc.
27
28
29 ===============================================================================
30 solhint                                                  *ale-solidity-solhint*
31
32   Solhint should work out-of-the-box. You can further configure it using a
33   `.solihint.json` file. See https://github.com/protofire/solhint for more
34   information.
35
36
37 ===============================================================================
38 solium                                                    *ale-solidity-solium*
39
40   Use of Solium linter for Solidity source code requires a .soliumrc.json
41   file in project root. This file can be generated by running `solium --init`.
42   See the corresponding solium usage for detailed instructions
43   (https://github.com/duaraghav8/Solium#usage).
44
45
46 ===============================================================================
47 forge                                                      *ale-solidity-forge*
48
49   `forge fmt` is not a linter, only a formatter. It should be used only as a
50   fixer.
51
52   `forge fmt` should work out-of-the-box. You can further configure it using
53   `foundry.toml`. See the corresponding documentation for detailed
54   instructions (https://book.getfoundry.sh/reference/config/formatter).
55
56
57 ===============================================================================
58   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: