@perfective/eslint-config

Perfective ESLint Config

@perfective/eslint-config provides a shareable ESLint configuration that is used for the development of the @perfective packages. These rules are primarily configured for TypeScript projects.

In addition to the core ESLint rules and the @typescript-eslint plugin rules, @perfective/eslint-config configures:

• eslint-plugin-array-func;
• eslint-plugin-cypress;
• eslint-plugin-deprecation;
• eslint-plugin-eslint-comments;
• eslint-plugin-import;
• eslint-plugin-jest;
• eslint-plugin-jest-dom;
• eslint-plugin-jest-formatting;
• eslint-plugin-jsdoc;
• eslint-plugin-node;
• eslint-plugin-prefer-arrow;
• eslint-plugin-promise;
• eslint-plugin-rxjs;
• eslint-plugin-simple-import-sort;
• eslint-plugin-sonarjs;
• eslint-plugin-testing-library;
• eslint-plugin-unicorn.

To simplify configuring ESLint support in the IDEs and editors, the severity of all fixable rules is a warning. In addition, it allows distinguishing errors that have to be fixed manually from issues that will be fixed automatically.

Setup

Require @perfective/eslint-config and its peer dependencies as dev dependencies.

npm install --save-dev \
    @perfective/eslint-config \
    @babel/eslint-parser \
    @typescript-eslint/eslint-plugin \
    @typescript-eslint/eslint-plugin-tslint \
    @typescript-eslint/parser \
    eslint \
    eslint-import-resolver-typescript \
    eslint-plugin-array-func \
    eslint-plugin-cypress \
    eslint-plugin-deprecation \
    eslint-plugin-eslint-comments \
    eslint-plugin-import \
    eslint-plugin-jest \
    eslint-plugin-jest-dom \
    eslint-plugin-jest-formatting \
    eslint-plugin-jsdoc \
    eslint-plugin-node \
    eslint-plugin-prefer-arrow \
    eslint-plugin-promise \
    eslint-plugin-rxjs \
    eslint-plugin-simple-import-sort \
    eslint-plugin-sonarjs \
    eslint-plugin-testing-library \
    eslint-plugin-unicorn \
    tslint

Require the configuration in your root .eslintrc.js.

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

TSLint

ESLint and its plugins replace most of the TSLint rules. Yet, a few rules still need to be supported. TSLint rules are executed using the ESLint Plugin TSLint.

Read the full documentation in the repository.