Beam Style Rules for Solium

This is a plugin for Solium for enforcing Beam's style rules.

License

This software is released under the MIT license. See LICENSE for details.

Usage

Install the beam plugin (list it as a dependency):

npm install -D solium-beam-plugin

Add "beam" to your solium plugins list:

{
  "plugins": [
    "beam"
  ]
}

No configuration is necessary unless you want to deviate from the default rules.

Rules

| Name | Rule | Default | |--------------------------|-------------------------------------------------------|--------:| | underscore-function-args | All function argument identifiers must start with _ | ON |

Contributing

We currently are not accepting outside contributions, but plan to in the future once we've worked out the details of a process.