navapbc / eslint-config-nava

ESLint shareable config for Navanauts and beyond.

eslint-config-nava

Important

This package is no longer maintained. We recommend using a layering of: Prettier for code formatting, eslint:recommended for basic JS linting, the linting config provided by your project's React framework (Next.js, Remix), and typescript-eslint if your project uses TypeScript. You can reference Nava's Next.js template for an example.

---

ESLint shareable config for Navanauts and beyond.

We're based on Standard JS, which provides a complete node/browser/react ruleset, with a few changes:

• using eslint-config-standard instead of standard, since we want to add additional rules
• adding additional rules that either promote correctness or a higher signal-to-noise ratio
• avoiding rules that are purely stylistic in nature

See the full Standard JS ruleset here and the Standard React ruleset here.

Installation

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

or

$ yarn add eslint eslint-config-nava --dev

Usage

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

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