eslint-config-equitybee

ESLint shareable config for the recommended EquityBee JavaScript style

Installation

$ npm install --save-dev eslint eslint-config-equitybee

Usage

Once the eslint-config-equitybee package is installed, you can use it by specifying equitybee in the extends section of your ESLint configuration.

{
  "extends": "equitybee",
  "rules": {
    // Additional, per-project rules...
  }
}

Using the equitybee config with eslint:recommended

There are several rules in the eslint:recommended ruleset that EquityBee style is not opinionated about that you might want to enforce in your project.

To use the EquityBee style in conjunction with ESLint's recommended rule set, extend them both, making sure to list equitybee last:

{
  "extends": ["eslint:recommended", "equitybee"],
  "rules": {
    // Additional, per-project rules...
  }
}

How to make a new release

1. Test your changes by running npm link. Then open EquityBee's main app repo, cd into a service you want to test and run npm link /Users/{YOUR_USERNAME}/{YOUR_LOCAL_PATH}/eslint-config-equitybee. Finally, modify the config import "eslint-config-equitybee": "/Users/{YOUR_USERNAME}/{YOUR_LOCAL_PATH}/eslint-config-equitybee" in the service's package.json. For more information on testing shareable ESLint configs, read this.

2. Run:

npm run release

and follow the interactive instructions.

3. Open EquityBee's main app repo and cd into every service and run npm update eslint-config-equitybee, then npm i.

License

Apache-2 © EquityBee