ESLint config for TypeScript

A shareable ESLint config for TypeScript projects.

Development

Run npm install to install the project dependencies.

Publishing a new version

1. Run npm version patch (replace patch as necessary) to increase the version number.
2. Run git push && git push --tags to push the version commit and tag.
3. Run npm publish to publish the new version.

Unused rules

Has issues

• @typescript-eslint/no-extraneous-class
  • https://github.com/typescript-eslint/typescript-eslint/issues/812
• @typescript-eslint/no-floating-promises
  • https://github.com/typescript-eslint/typescript-eslint/issues/815
• @typescript-eslint/no-unnecessary-condition
  • https://github.com/typescript-eslint/typescript-eslint/issues/996
  • https://github.com/typescript-eslint/typescript-eslint/issues/1015
• @typescript-eslint/strict-boolean-expressions
  • https://github.com/typescript-eslint/typescript-eslint/issues/754
• @typescript-eslint/unbound-method
  • https://github.com/typescript-eslint/typescript-eslint/issues/636
  • https://github.com/typescript-eslint/typescript-eslint/issues/700
  • https://github.com/typescript-eslint/typescript-eslint/issues/743

Too strict

• @typescript-eslint/no-extra-parens – extra parentheses sometimes aid readability.
• @typescript-eslint/no-magic-numbers – difficult to follow, especially in existing projects.
• @typescript-eslint/no-type-alias – partly handled by @typescript-eslint/consistent-type-definitions.
• @typescript-eslint/prefer-readonly – team decision.

Handled by TypeScript

• @typescript-eslint/no-unused-vars – noUnusedLocals and noUnusedParameters.
• @typescript-eslint/typedef – noImplicitAny.
• getter-return – ts(2378).
• no-dupe-args – ts(2300).
• no-dupe-keys – ts(1117).
• no-func-assign – ts(2539).
• no-import-assign – ts(2539).
• no-unreachable – ts(7027).
• valid-typeof – ts(2367).

Unnecessary

• no-async-promise-executor – unnecessary with @typescript-eslint/no-misused-promises.

Used rules with issues

• @typescript-eslint/ban-types
  • https://github.com/typescript-eslint/typescript-eslint/issues/842
• @typescript-eslint/member-naming
  • https://github.com/typescript-eslint/typescript-eslint/issues/816
• @typescript-eslint/member-ordering
  • https://github.com/typescript-eslint/typescript-eslint/issues/395
  • https://github.com/typescript-eslint/typescript-eslint/issues/929