eslint-plugin-lob
v1.2.0
Published
Custom ESLint rules for Lob repositories
Downloads
14,868
Maintainers
Readme
eslint-plugin-lob
Custom ESLint rules for Lob repositories
Installation
You'll first need to install ESLint:
$ npm i eslint -D
Next, install eslint-plugin-lob
:
$ npm install eslint-plugin-lob -D
Note: If you installed ESLint globally (using the -g
flag) then you must also install eslint-plugin-lob
globally.
Usage
Add lob
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"lob"
]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"lob/rule-name": 2
}
}
Supported Rules
align-equals
- equal signs of variable declarations involvingrequire
,Factory.build
(including named factories likeUserFactory.build
),Bluebird.promisify
, orBluebird.promisifyAll
must be alignednewline-after-mocha
- new lines must be between mocha blocks (describe
,it
,beforeEach
, etc)padded-describes
-describe
blocks must be padded by blank lines
Testing
To run the test suite, just clone the repository and run the following:
$ npm i
$ npm test
Contributing
To contribute, please see the CONTRIBUTING.md file.
License
This project is released under the MIT license, which can be found in LICENSE.txt
.