Skip to content
(Formerly Solium) Linter to identify and fix style & security issues in Solidity
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix PR template broken link & refactor Feb 11, 2019
art rename npm package Dec 23, 2018
bin
config Add tests for rule no-trailing-whitespace Apr 8, 2019
docs
lib fixed no-empty-blocks to not report inherited constructors Sep 14, 2019
snap Add visibility-order rule Jun 16, 2018
test fixed no-empty-blocks to not report inherited constructors Sep 14, 2019
.eslintrc.js eslint: use object-curly-spacing Jan 28, 2019
.gitattributes Ensure git stores the line endings Jun 14, 2018
.gitignore Added getLines() in source code utils Mar 17, 2019
.travis.yml
CHANGELOG.md
CONTRIBUTING.md Added contribution guidelines (#211) Jan 11, 2019
LICENSE
README.md update readme May 25, 2019
package-lock.json 1.2.5 Sep 14, 2019
package.json

README.md


Build Status Gitter chat

Ethlint (Formerly Solium) analyzes your Solidity code for style & security issues and fixes them.

See Documentation, Changelog and upcoming releases.

Before beginning to work on a contribution, please read the Guidelines.

Install

npm install -g ethlint
solium -V

For backward-compatibility, you can still use npm install -g solium.

If you're currently using the solium package for npm install, it is highly recommended that you move to ethlint. The solium package will not receive updates after December, 2019. There are no differences between the updates pushed to ethlint and solium packages.

Usage

In the root directory of your DApp:

solium --init

This creates 2 files for you:

  • .soliumignore - contains names of files and directories to ignore while linting
  • .soliumrc.json - contains configuration that tells Solium how to lint your project. You should modify this file to configure rules, plugins and sharable configs.

.soliumrc.json looks like:

{
  "extends": "solium:recommended",
  "plugins": ["security"],
  "rules": {
    "quotes": ["error", "double"],
    "indentation": ["error", 4],
    "linebreak-style": ["error", "unix"]
  }
}

To know which lint rules Solium applies for you, see Style rules and Security rules.


NOTE

Solium does not strictly adhere to Solidity Style Guide. It aims to promote coding practices agreed upon by the community at large.


Lint

solium -f foobar.sol
solium -d contracts/

Configure with comments

Comment Directives can be used to configure Solium to ignore specific pieces of code. They follow the pattern solium-disable<optional suffix>.

If you only use the directive, Solium disables all rules for the marked code. If that's not desirable, specify the rules to disable after the directive, separated by comma.

  • Disable linting on a specific line
contract Foo {
	/* solium-disable-next-line */
	function() {
		bytes32 bar = 'Hello world';	// solium-disable-line quotes

		// solium-disable-next-line security/no-throw, indentation
						throw;
	}
}
  • Disable linting on entire file
/* solium-disable */

contract Foo {
	...
}

Fix

Solium automatically fixes your code to resolve whatever issues it can.

solium -d contracts/ --fix

Our supporters

Ethereum Augur    Gitcoin

If Ethlint helped make your life simpler, please consider donating ETH to 0xacc661A56af9793a4437876a52F4Ad3fc3C443d6

IDE and Editor Integrations | Documentation | Demo Video

You can’t perform that action at this time.