eslint-config-auditor

Shareable ESLint Config to help you write clear, efficient JavaScript code. 😼

Auditor uses sane defaults focused on code readability. The Auditor's philosophy is that good code means easy to understand code.

Along with its own rules, Auditor by default includes battle-tested rules from eslint:recommended, plugin:import, plugin:promise, and plugin:node. Both on browser and Node.js, Auditor gives you the confidence you need to write efficient JavaScript code.

Besides linting standard JavaScript code gracefully, Auditor also has first-class support to React, Jest, and TypeScript. See rules about usage.

Installation

npm install --save-dev eslint-config-auditor

Usage

Auditor's shareable config is meant to be the source of rules for another application (yet to be built), but as a shareable config, you can use it the same way by installing its peer dependencies.

npm install --save-dev eslint-plugin-{import,promise,node}

Will install import, promise, and node plugins. You can now extend your config as you usually would.

In your .eslintrc

{
  "extends": "auditor"
}

Rules

Installing the above adds all default rules for Auditor. Auditor has two main rule configs:

• auditor/recommended all the needed rules to write consise JavaScript. Includes all best-practices, Node.js, import, and promise rules. Recommended for most users.
• auditor/finest Auditor at its finest. Strict rules for advanced use cases such as code refactors and open-source software where code changes can break infinite clients. Includes the recommended config.

Auditor also offers first-class support to Jest, React, and TypeScript but since these are opinionated tools, you need to activate them for usage manually.

Jest

Uses eslint-plugin-jest.

npm install --save-dev eslint-plugin-jest -D

{
  "extends": [
    "auditor",
    "auditor/jest"
  ]
}

React

Uses eslint-plugin-react, eslint-plugin-react-hooks, and eslint-plugin-jsx-a11y.

npm install --save-dev eslint-plugin-{react,react-hooks,jsx-a11y} -D

{
  "extends": [
    "auditor",
    "auditor/react"
  ]
}

TypeScript

Uses @typescript-eslint/eslint-plugin, eslint-plugin-import, and@typescript-eslint/parser.

npm install --save-dev @typescript-eslint/{eslint-plugin,parser} -D

{
  "extends": [
    "auditor",
    "auditor/typescript"
  ]
}

License

MIT (c) Cezar Augusto.