solium

Solium is a Security & Style focused Linter for your Solidity Smart Contracts.

It provides powerful rules for writing cleaner, more secure contracts, automatic code formatting and simple-to-understand re-distributable configuration files.

Install

npm install -g solium
solium -V

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:all",
  "plugins": ["security"],
  "rules": {
    "quotes": ["error", "double"],
    "indentation": ["error", 4],
    "arg-overflow": ["warning", 3]
  }
}

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

Lint a single Solidity file

solium -f ./contracts/foobar.sol

Lint over a directory

solium -d contracts/

Or over the entire project using solium -d .. Solium lints all the files inside your project with .sol extension.

Fix lint issues

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

solium -d contracts --fix

IDE & Editor Integrations

• VS Code: Solidity with Solium linting by Juan Blanco
• VS Code: Solidity with Solium linting by CodeChain.io
• Sublime Solium Gutter by Florian Sey
• Sublime Solium Linter by Alex Step
• Atom Solium Linter by Travis Jacobs
• Syntastic local solium by Brett Sun

Migrating from v0

If you're currently using Solium v0, we highly recommend you to migrate to v1. v1 is backward compatible and provides you with much greater flexibility to configure rules, powerful security rules and auto code formatting among other features.

Access the complete Documentation