eslint-plugin-lob

Custom ESLint rules for Lob repositories

Installation

Requirements: Node.js >=24.15.0, ESLint >=10.0.0.

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 in your eslint.config.js (flat config). You can omit the eslint-plugin- prefix:

import pluginLob from 'eslint-plugin-lob';

export default [
  {
    plugins: { lob: pluginLob },
    rules: {
      'lob/rule-name': 'error'
    }
  }
];

For CommonJS projects:

const pluginLob = require('eslint-plugin-lob');

module.exports = [
  {
    plugins: { lob: pluginLob },
    rules: {
      'lob/rule-name': 'error'
    }
  }
];

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.