@buames/eslint-config

@buames/eslint-config

Installation

Install with yarn

yarn add --dev @buames/eslint-config

Or install with npm

npm install @buames/eslint-config

Usage

The base config includes rules for any TypeScript-based project. Includes recommended and optional rules from eslint, prettier, eslint-plugin-import, eslint-plugin-unicorn, eslint-plugin-jest, and more. TypeScript specific rules are enabled using @typescript-eslint/eslint-plugin and @typescript-eslint/parser.

module.exports = {
  root: true,
  extends: ['@buames/eslint-config'],
};

Presets

Not included by default, these additional preset configs can also be extended.

Name	Description
node	Sets the environment to Node.js and enabled node specific rules using eslint-plugin-node.
react	Sets the environment to Browser and enabled React specific rules using eslint-config-airbnb.

Be sure to include the full scope name when extending these additional presets.

// .eslintrc.js
module.exports = {
  root: true,
  extends: [
    '@buames/eslint-config',
    '@buames/eslint-config/node',
    // ... and so on
  ],
};