Custom ESLint rules for Lob repositories
npm install eslint-plugin-lob
Custom ESLint rules for Lob repositories
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.
Add lob to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
`json`
{
"plugins": [
"lob"
]
}
Then configure the rules you want to use under the rules section.
`json`
{
"rules": {
"lob/rule-name": 2
}
}
* align-equals - equal signs of variable declarations involving require, Factory.build (including named factories like UserFactory.build), Bluebird.promisify, or Bluebird.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
To run the test suite, just clone the repository and run the following:
`bash`
$ npm i
$ npm test
To contribute, please see the CONTRIBUTING.md file.
This project is released under the MIT license, which can be found in LICENSE.txt`.