Eslint-config-ts-guard NPM

eslint-config-ts-guard

Set of configuration files (shareable configs) for ESLint to guard/protect from problems in different areas of JavaScript and TypeScript development.

Extends eslint-config-guard.

Includes:

ts-guard - configuration for TypeScript-related rules; extends guard/optimum-next and plugin:@typescript-eslint/recommended;
ts-guard/ext - configuration for TypeScript-related type-aware rules; extends ts-guard and plugin:@typescript-eslint/recommended-requiring-type-checking; to use the configuration you should specify parserOptions.project in ESLint config file (see details).
ts-guard/test - appropriate for use in tests (relaxes some rules from other configs); extends guard/test;
ts-guard/test-jest - appropriate for use in Jest tests; extends ts-guard/test and guard/test-jest;
ts-guard/test-mocha - appropriate for use in Mocha tests; extends ts-guard/test and guard/test-mocha.

The following files re-export corresponding configs from eslint-config-guard:

ts-guard/guard - re-exports guard;
ts-guard/editor - re-exports guard/editor;
ts-guard/esnext - re-exports guard/esnext;
ts-guard/ext-style - re-exports guard/ext-style;
ts-guard/indent - re-exports guard/indent;
ts-guard/jsdoc - re-exports guard/jsdoc;
ts-guard/no-prettier - re-exports guard/no-prettier;
ts-guard/node - re-exports guard/node;
ts-guard/optimum - re-exports guard/optimum;
ts-guard/optimum-next - re-exports guard/optimum-next;
ts-guard/proper-arrows - re-exports guard/proper-arrows;
ts-guard/react - re-exports guard/react;
ts-guard/style - re-exports guard/style.

Installation

Besides eslint-config-ts-guard you should install @typescript-eslint/eslint-plugin:

npm install eslint-config-ts-guard @typescript-eslint/eslint-plugin --save-dev

If you are going to use ts-guard/node you should install eslint-plugin-node:

npm install eslint-plugin-node --save-dev

If you are going to use ts-guard/proper-arrows you should install @getify/eslint-plugin-proper-arrows:

npm install @getify/eslint-plugin-proper-arrows --save-dev

If you are going to use ts-guard/react you should install eslint-plugin-react:

npm install eslint-plugin-react --save-dev

Usage

In a .eslintrc.json file:

{
    "extends": [
        "ts-guard",
        "ts-guard/node"
    ]
}

In a package.json:

{
    "eslintConfig": {
        "extends": [
            "ts-guard/ext",
            "ts-guard/proper-arrows",
            "ts-guard/react"
        ]
    }
}