@kdujs/eslint-config-typescript

eslint-config-typescript for kdu-cli

See @typescript-eslint/eslint-plugin for available rules.

This config is specifically designed to be used by Kdu CLI setups and is not meant for outside use (it can be used but some adaptations on the user side might be needed - for details see the config file).

A part of its design is that this config may implicitly depend on other parts of Kdu CLI setups, such as eslint-plugin-kdu being extended in the same resulting config.

Installation

This config requires several peer dependencies. So it's recommended to use the install-peerdeps command:

npx install-peerdeps --dev @kdujs/eslint-config-typescript

Usage

This package comes with 2 rulesets.

@kdujs/eslint-config-typescript

This ruleset is the base configuration for Kdu-TypeScript projects. Besides setting the parser and plugin options, it also turns off several conflicting rules in the eslint:recommended ruleset. So when used alongside other sharable configs, this config should be placed at the end of the extends array.

An example .eslintrc.js:

module.exports = {
  extends: [
    'plugin:kdu/essential',
    'eslint:recommended',
    '@kdujs/typescript'
  ]
}

@kdujs/eslint-config-typescript/recommended

This is extended from the @typescript-eslint/recommended ruleset, which is an opinionated ruleset. See the original documentation for more information.

Some of its rules, however, might conflict with prettier. So when used alongside other sharable configs, this config should be placed after all other configs except for the one from eslint-plugin-prettier in the extends array.

An example .eslintrc.js:

module.exports = {
  extends: [
    'plugin:kdu/essential',
    '@kdujs/airbnb',
    '@kdujs/typescript/recommended',

    'plugin:prettier/recommended'
  ]
}