solhint-plugin-beam

Solhint Plugin for the Beam Network Style Guide (solhint-plugin-beam)

A solhint plugin to enforce Beam's style rules

Provides solhint rules to enforce the extra Solidity style rules used at Beam Network.

Table of Contents

• Install
• Usage
• Contributing
• License

Install

Install via NPM:

npm install --save-dev solhint-plugin-beam

Add to your solhint configuration and enable some rules:

{
  "plugins": [
    "beam"
  ],
  "rules": {
    "beam/underscore-function-args": "error"
  }
}

Usage

Provides the following rules:

• beam/underscore-function-args Function arguments must start with _ to help distinguish them from storage variables.

License

MIT (c) Beam Network