feat(eslint-plugin): update recommended sets (#2001)

typescript-eslint · May 21, 2020 · 0126b4f · 0126b4f
1 parent cd14482
commit 0126b4f
Show file tree

Hide file tree

Showing 43 changed files with 277 additions and 297 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -80,6 +80,7 @@
     "rulesets",
     "superset",
     "thenables",
+    "transpiles",
     "tsconfigs",
     "tsutils",
     "typedef",

diff --git a/.eslintrc.js b/.eslintrc.js
@@ -14,32 +14,43 @@ module.exports = {
   },
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:@typescript-eslint/recommended-requiring-type-checking',
   ],
+  parserOptions: {
+    sourceType: 'module',
+    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
+    tsconfigRootDir: __dirname,
+  },
   rules: {
     //
     // our plugin :D
     //
 
     '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
     '@typescript-eslint/explicit-function-return-type': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-function': [
+      'error',
+      { allow: ['arrowFunctions'] },
+    ],
     '@typescript-eslint/no-explicit-any': 'error',
     '@typescript-eslint/no-non-null-assertion': 'off',
-    '@typescript-eslint/no-throw-literal': 'off',
-    '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/no-var-requires': 'off',
     '@typescript-eslint/prefer-nullish-coalescing': 'error',
     '@typescript-eslint/prefer-optional-chain': 'error',
     '@typescript-eslint/unbound-method': 'off',
-    '@typescript-eslint/prefer-as-const': 'error',
 
-    'no-empty-function': 'off',
-    '@typescript-eslint/no-empty-function': [
-      'error',
-      { allow: ['arrowFunctions'] },
-    ],
+    // TODO - enable these new recommended rules
+    '@typescript-eslint/no-floating-promises': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    // TODO - enable this
+    '@typescript-eslint/naming-convention': 'off',
 
     //
     // Internal repo rules
@@ -53,8 +64,6 @@ module.exports = {
     // eslint base
     //
 
-    'comma-dangle': ['error', 'always-multiline'],
-    'constructor-super': 'off',
     curly: ['error', 'all'],
     'no-mixed-operators': 'error',
     'no-console': 'error',
@@ -128,14 +137,6 @@ module.exports = {
     // Require modules with a single export to use a default export
     'import/prefer-default-export': 'off', // we want everything to be named
   },
-  parserOptions: {
-    sourceType: 'module',
-    ecmaFeatures: {
-      jsx: false,
-    },
-    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
-    tsconfigRootDir: __dirname,
-  },
   overrides: [
     // all test files
     {

diff --git a/docs/getting-started/linting/README.md b/docs/getting-started/linting/README.md
@@ -24,7 +24,6 @@ module.exports = {
   ],
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
   ],
 };
@@ -41,7 +40,6 @@ Explaining the important bits:
   - This allows you to use the rules within your codebase.
 - `extends: [ ... ]` tells ESLint that your config extends the given configurations.
   - `eslint:recommended` is ESLint's inbuilt "recommended" config - it turns on a small, sensible set of rules which lint for well-known best-practices.
-  - `plugin:@typescript-eslint/eslint-recommended` is a configuration we provide which disables a few of the recommended rules from the previous set that we know are already covered by TypeScript's typechecker.
   - `plugin:@typescript-eslint/recommended` is our "recommended" config - it's just like `eslint:recommended`, except it only turns on rules from our TypeScript-specific plugin.
 
 Further reading:

diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
diff --git a/packages/eslint-plugin/src/configs/all.json b/packages/eslint-plugin/src/configs/all.json
diff --git a/packages/eslint-plugin/src/configs/all.ts b/packages/eslint-plugin/src/configs/all.ts
@@ -0,0 +1,126 @@
+export = {
+  extends: ['./configs/base', './configs/eslint-recommended'],
+  rules: {
+    '@typescript-eslint/adjacent-overload-signatures': 'error',
+    '@typescript-eslint/array-type': 'error',
+    '@typescript-eslint/await-thenable': 'error',
+    '@typescript-eslint/ban-ts-comment': 'error',
+    '@typescript-eslint/ban-types': 'error',
+    'brace-style': 'off',
+    '@typescript-eslint/brace-style': 'error',
+    '@typescript-eslint/class-literal-property-style': 'error',
+    'comma-spacing': 'off',
+    '@typescript-eslint/comma-spacing': 'error',
+    '@typescript-eslint/consistent-type-assertions': 'error',
+    '@typescript-eslint/consistent-type-definitions': 'error',
+    'default-param-last': 'off',
+    '@typescript-eslint/default-param-last': 'error',
+    'dot-notation': 'off',
+    '@typescript-eslint/dot-notation': 'error',
+    '@typescript-eslint/explicit-function-return-type': 'error',
+    '@typescript-eslint/explicit-member-accessibility': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    'func-call-spacing': 'off',
+    '@typescript-eslint/func-call-spacing': 'error',
+    indent: 'off',
+    '@typescript-eslint/indent': 'error',
+    'init-declarations': 'off',
+    '@typescript-eslint/init-declarations': 'error',
+    'keyword-spacing': 'off',
+    '@typescript-eslint/keyword-spacing': 'error',
+    'lines-between-class-members': 'off',
+    '@typescript-eslint/lines-between-class-members': 'error',
+    '@typescript-eslint/member-delimiter-style': 'error',
+    '@typescript-eslint/member-ordering': 'error',
+    '@typescript-eslint/method-signature-style': 'error',
+    '@typescript-eslint/naming-convention': 'error',
+    'no-array-constructor': 'off',
+    '@typescript-eslint/no-array-constructor': 'error',
+    '@typescript-eslint/no-base-to-string': 'error',
+    'no-dupe-class-members': 'off',
+    '@typescript-eslint/no-dupe-class-members': 'error',
+    '@typescript-eslint/no-dynamic-delete': 'error',
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': 'error',
+    '@typescript-eslint/no-empty-interface': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-extra-non-null-assertion': 'error',
+    'no-extra-parens': 'off',
+    '@typescript-eslint/no-extra-parens': 'error',
+    'no-extra-semi': 'off',
+    '@typescript-eslint/no-extra-semi': 'error',
+    '@typescript-eslint/no-extraneous-class': 'error',
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    '@typescript-eslint/no-implied-eval': 'error',
+    '@typescript-eslint/no-inferrable-types': 'error',
+    'no-invalid-this': 'off',
+    '@typescript-eslint/no-invalid-this': 'error',
+    '@typescript-eslint/no-invalid-void-type': 'error',
+    'no-magic-numbers': 'off',
+    '@typescript-eslint/no-magic-numbers': 'error',
+    '@typescript-eslint/no-misused-new': 'error',
+    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-namespace': 'error',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'error',
+    '@typescript-eslint/no-parameter-properties': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-this-alias': 'error',
+    '@typescript-eslint/no-throw-literal': 'error',
+    '@typescript-eslint/no-type-alias': 'error',
+    '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/no-unsafe-assignment': 'error',
+    '@typescript-eslint/no-unsafe-call': 'error',
+    '@typescript-eslint/no-unsafe-member-access': 'error',
+    '@typescript-eslint/no-unsafe-return': 'error',
+    'no-unused-expressions': 'off',
+    '@typescript-eslint/no-unused-expressions': 'error',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-unused-vars-experimental': 'error',
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': 'error',
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    '@typescript-eslint/no-var-requires': 'error',
+    '@typescript-eslint/prefer-as-const': 'error',
+    '@typescript-eslint/prefer-for-of': 'error',
+    '@typescript-eslint/prefer-function-type': 'error',
+    '@typescript-eslint/prefer-includes': 'error',
+    '@typescript-eslint/prefer-namespace-keyword': 'error',
+    '@typescript-eslint/prefer-nullish-coalescing': 'error',
+    '@typescript-eslint/prefer-optional-chain': 'error',
+    '@typescript-eslint/prefer-readonly': 'error',
+    '@typescript-eslint/prefer-readonly-parameter-types': 'error',
+    '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+    '@typescript-eslint/prefer-regexp-exec': 'error',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/prefer-ts-expect-error': 'error',
+    '@typescript-eslint/promise-function-async': 'error',
+    quotes: 'off',
+    '@typescript-eslint/quotes': 'error',
+    '@typescript-eslint/require-array-sort-compare': 'error',
+    'require-await': 'off',
+    '@typescript-eslint/require-await': 'error',
+    '@typescript-eslint/restrict-plus-operands': 'error',
+    '@typescript-eslint/restrict-template-expressions': 'error',
+    'no-return-await': 'off',
+    '@typescript-eslint/return-await': 'error',
+    semi: 'off',
+    '@typescript-eslint/semi': 'error',
+    'space-before-function-paren': 'off',
+    '@typescript-eslint/space-before-function-paren': 'error',
+    '@typescript-eslint/strict-boolean-expressions': 'error',
+    '@typescript-eslint/switch-exhaustiveness-check': 'error',
+    '@typescript-eslint/triple-slash-reference': 'error',
+    '@typescript-eslint/type-annotation-spacing': 'error',
+    '@typescript-eslint/typedef': 'error',
+    '@typescript-eslint/unbound-method': 'error',
+    '@typescript-eslint/unified-signatures': 'error',
+  },
+};
diff --git a/packages/eslint-plugin/src/configs/base.json b/packages/eslint-plugin/src/configs/base.json
diff --git a/packages/eslint-plugin/src/configs/base.ts b/packages/eslint-plugin/src/configs/base.ts
@@ -0,0 +1,5 @@
+export = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: { sourceType: 'module' },
+  plugins: ['@typescript-eslint'],
+};
diff --git a/packages/eslint-plugin/src/configs/eslint-recommended.ts b/packages/eslint-plugin/src/configs/eslint-recommended.ts
@@ -1,8 +1,9 @@
 /**
- * This is a compatibility ruleset that disables rules from eslint:recommended
- * which are already handled by TypeScript.
+ * This is a compatibility ruleset that:
+ * - disables rules from eslint:recommended which are already handled by TypeScript.
+ * - enables rules that make sense due to TS's typechecking / transpilation.
  */
-export default {
+export = {
   overrides: [
     {
       files: ['*.ts', '*.tsx'],
@@ -14,6 +15,7 @@ export default {
         'no-dupe-class-members': 'off', // ts(2393) & ts(2300)
         'no-dupe-keys': 'off', // ts(1117)
         'no-func-assign': 'off', // ts(2539)
+        'no-import-assign': 'off', // ts(2539) & ts(2540)
         'no-new-symbol': 'off', // ts(2588)
         'no-obj-calls': 'off', // ts(2349)
         'no-redeclare': 'off', // ts(2451)
@@ -22,6 +24,10 @@ export default {
         'no-undef': 'off', // ts(2304)
         'no-unreachable': 'off', // ts(7027)
         'no-unsafe-negation': 'off', // ts(2365) & ts(2360) & ts(2358)
+        'no-var': 'error', // ts transpiles let/const to var, so no need for vars any more
+        'prefer-const': 'error', // ts provides better types with const
+        'prefer-rest-params': 'error', // ts provides better types with rest args over arguments
+        'prefer-spread': 'error', // ts transpiles spread to apply, so no need for manual apply
         'valid-typeof': 'off', // ts(2367)
       },
     },