summaryrefslogtreecommitdiff
path: root/doc/ale-solidity.txt
blob: 6cf9734439e1d0753cb65b28b2bfb97bd2a07c2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
===============================================================================
ALE Solidity Integration                                 *ale-solidity-options*


===============================================================================
solc                                                        *ale-solidity-solc*

g:ale_solidity_solc_executable                  *g:ale_solidity_solc_executable*
                                                *b:ale_solidity_solc_executable*
  Type: |String|
  Default: `'solc'`

  Override the invoked solc binary. For truffle/hardhat binaries.

g:ale_solidity_solc_options                       *g:ale_solidity_solc_options*
                                                  *b: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: