@agaroot/eslint-config-common NPM

@agaroot/eslint-config-common

This is a ESLint config commonly inherited by AGAROOT products.

Use this setting to ensure consistent code writing and maintain high code quality.

🚀 Installation

$ npm install -D @agaroot/eslint-config-common

# Needs install peer dependencies
$ npm install -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-import-resolver-typescript eslint-plugin-import eslint-plugin-unicorn eslint-plugin-unused-imports

👏 Getting Started

Create a .eslintrc.js file in the root directory of your project, and add @agaroot/eslint-config-common to the extends array.

/** @type {import('eslint').Linter.Config} */
module.exports = {
  root: true,
  extends: [
    '@agaroot/eslint-config-common',
  ],
};

If you are using TypeScript, you need to add the parserOptions and import/resolver settings.

/** @type {import('eslint').Linter.Config} */
module.exports = {
  root: true,
  extends: [
    '@agaroot/eslint-config-common',
  ],
  parserOptions: {
    project: './tsconfig.json',
  },
  settings: {
    'import/resolver': {
      typescript: {
        project: './tsconfig.json',
      },
    },
  },
};