eslint-plugin-lob

1.2.0 • Public • Published

eslint-plugin-lob

Build Status Coverage Status

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 involving require, Factory.build (including named factories like UserFactory.build), Bluebird.promisify, or Bluebird.promisifyAll must be aligned
  • newline-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.

Package Sidebar

Install

npm i eslint-plugin-lob

Weekly Downloads

3,753

Version

1.2.0

License

MIT

Last publish

Collaborators

  • jayteelob
  • erik.forsman-lob
  • jkleung11
  • tanya.sah
  • hunteryoakum
  • rdimouro7373
  • lobstertroy
  • joshnkoy
  • michel_lob
  • haroutrs
  • kjones_lob
  • eamon-barisone
  • nathanielwaldschmidtlob
  • zach.reed
  • richpodrazalob
  • kencrim
  • jorgelob
  • nick-place-lob
  • andrew.guterres
  • ajorczak
  • hanqingchen-lob
  • juan.frissdekereki
  • mmorgan-lob
  • karankwatra-lob
  • joey-bates-lob
  • luke.birdeau
  • mg-lob
  • vmangwani
  • sachinlob
  • nick.perri
  • siddharthpant92
  • bethqiang
  • kplob
  • samkitsheth95
  • erin-doyle
  • jfdavidson
  • meussdorffer
  • shannamurry
  • amaan_lob
  • team.platform.lob.com
  • elijah-lob
  • jlowsley-lob
  • barnabygo
  • james.cho
  • douglaje
  • lob-owner
  • graeme.lowe.lob