feat(eslint-plugin)!: change recommended config (typescript-eslint#729)

BREAKING CHANGE: recommended config changes are considered breaking
hughns · Aug 13, 2019 · 428567d · 428567d
1 parent de6cc1d
commit 428567d
Show file tree

Hide file tree

Showing 100 changed files with 470 additions and 341 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,23 +21,12 @@ module.exports = {
     // our plugin :D
     //
 
-    '@typescript-eslint/ban-ts-ignore': 'error',
-    '@typescript-eslint/consistent-type-definitions': 'error',
-    '@typescript-eslint/explicit-function-return-type': 'off',
-    '@typescript-eslint/explicit-member-accessibility': 'off',
-    '@typescript-eslint/indent': 'off',
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/no-inferrable-types': 'error',
-    '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+    '@typescript-eslint/no-explicit-any': 'error',
     '@typescript-eslint/no-non-null-assertion': 'off',
-    '@typescript-eslint/no-object-literal-type-assertion': 'off',
-    '@typescript-eslint/no-parameter-properties': 'off',
-    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
     '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/no-var-requires': 'off',
-    '@typescript-eslint/prefer-includes': 'error',
-    '@typescript-eslint/prefer-regexp-exec': 'error',
-    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/unbound-method': 'off',
 
     //
     // eslint base
@@ -110,12 +99,12 @@ module.exports = {
     'import/no-mutable-exports': 'error',
     // Prevent importing the default as if it were named
     'import/no-named-default': 'error',
-    // Prohibit named exports // we want everything to be a named export
-    'import/no-named-export': 'off',
+    // Prohibit named exports
+    'import/no-named-export': 'off', // we want everything to be a named export
     // Forbid a module from importing itself
     'import/no-self-import': 'error',
-    // Require modules with a single export to use a default export // we want everything to be named
-    'import/prefer-default-export': 'off',
+    // 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',

diff --git a/.prettierrc → .prettierrc.json b/.prettierrc → .prettierrc.json
diff --git a/packages/eslint-plugin-tslint/src/custom-linter.ts b/packages/eslint-plugin-tslint/src/custom-linter.ts
@@ -1,5 +1,5 @@
 import { ILinterOptions, Linter, LintResult } from 'tslint';
-import { Program } from 'typescript';
+import { Program, SourceFile } from 'typescript';
 
 // We need to access the program, but Linter has private program already
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -14,7 +14,7 @@ export class CustomLinter extends TSLintLinter {
     return super.getResult();
   }
 
-  getSourceFile(fileName: string) {
+  getSourceFile(fileName: string): SourceFile | undefined {
     return this.program.getSourceFile(fileName);
   }
 }
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
diff --git a/packages/eslint-plugin/docs/rules/no-inferrable-types.md b/packages/eslint-plugin/docs/rules/no-inferrable-types.md
@@ -24,8 +24,8 @@ The default options are:
 
 ```JSON
 {
-  "ignoreParameters": true,
-  "ignoreProperties": true,
+  "ignoreParameters": false,
+  "ignoreProperties": false,
 }
 ```
 

diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -49,8 +49,10 @@
   "devDependencies": {
     "@types/json-schema": "^7.0.3",
     "@types/marked": "^0.6.5",
+    "@types/prettier": "^1.18.0",
     "chalk": "^2.4.2",
     "marked": "^0.7.0",
+    "prettier": "*",
     "typescript": "*"
   },
   "peerDependencies": {

diff --git a/packages/eslint-plugin/src/configs/all.json b/packages/eslint-plugin/src/configs/all.json
@@ -24,6 +24,7 @@
     "@typescript-eslint/member-ordering": "error",
     "no-array-constructor": "off",
     "@typescript-eslint/no-array-constructor": "error",
+    "no-empty-function": "off",
     "@typescript-eslint/no-empty-function": "error",
     "@typescript-eslint/no-empty-interface": "error",
     "@typescript-eslint/no-explicit-any": "error",
@@ -62,6 +63,7 @@
     "@typescript-eslint/prefer-string-starts-ends-with": "error",
     "@typescript-eslint/promise-function-async": "error",
     "@typescript-eslint/require-array-sort-compare": "error",
+    "require-await": "off",
     "@typescript-eslint/require-await": "error",
     "@typescript-eslint/restrict-plus-operands": "error",
     "semi": "off",

diff --git a/packages/eslint-plugin/src/configs/base.json b/packages/eslint-plugin/src/configs/base.json
@@ -1,9 +1,5 @@
 {
   "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "sourceType": "module"
-  },
-  "plugins": [
-    "@typescript-eslint"
-  ]
+  "parserOptions": { "sourceType": "module" },
+  "plugins": ["@typescript-eslint"]
 }
diff --git a/packages/eslint-plugin/src/configs/recommended.json b/packages/eslint-plugin/src/configs/recommended.json
@@ -1,38 +1,48 @@
 {
   "extends": "./configs/base.json",
   "rules": {
-    "no-var": "error",
-    "prefer-const": "error",
-    "prefer-rest-params": "error",
-    "prefer-spread": "error",
     "@typescript-eslint/adjacent-overload-signatures": "error",
-    "@typescript-eslint/array-type": "error",
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/ban-ts-ignore": "error",
     "@typescript-eslint/ban-types": "error",
     "camelcase": "off",
     "@typescript-eslint/camelcase": "error",
     "@typescript-eslint/class-name-casing": "error",
     "@typescript-eslint/consistent-type-assertions": "error",
     "@typescript-eslint/explicit-function-return-type": "warn",
-    "@typescript-eslint/explicit-member-accessibility": "error",
-    "indent": "off",
-    "@typescript-eslint/indent": "error",
     "@typescript-eslint/interface-name-prefix": "error",
     "@typescript-eslint/member-delimiter-style": "error",
     "no-array-constructor": "off",
     "@typescript-eslint/no-array-constructor": "error",
+    "no-empty-function": "off",
+    "@typescript-eslint/no-empty-function": "error",
     "@typescript-eslint/no-empty-interface": "error",
     "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-for-in-array": "error",
     "@typescript-eslint/no-inferrable-types": "error",
     "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/no-misused-promises": "error",
     "@typescript-eslint/no-namespace": "error",
-    "@typescript-eslint/no-non-null-assertion": "error",
-    "@typescript-eslint/no-parameter-properties": "error",
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    "@typescript-eslint/no-this-alias": "error",
+    "@typescript-eslint/no-unnecessary-type-assertion": "error",
     "no-unused-vars": "off",
     "@typescript-eslint/no-unused-vars": "warn",
     "no-use-before-define": "off",
     "@typescript-eslint/no-use-before-define": "error",
     "@typescript-eslint/no-var-requires": "error",
+    "@typescript-eslint/prefer-includes": "error",
     "@typescript-eslint/prefer-namespace-keyword": "error",
-    "@typescript-eslint/type-annotation-spacing": "error"
+    "@typescript-eslint/prefer-regexp-exec": "error",
+    "@typescript-eslint/prefer-string-starts-ends-with": "error",
+    "require-await": "off",
+    "@typescript-eslint/require-await": "error",
+    "@typescript-eslint/triple-slash-reference": "error",
+    "@typescript-eslint/type-annotation-spacing": "error",
+    "@typescript-eslint/unbound-method": "error",
+    "no-var": "error",
+    "prefer-const": "error",
+    "prefer-rest-params": "error",
+    "prefer-spread": "error"
   }
 }
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -94,7 +94,8 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description: 'Requires using either `T[]` or `Array<T>` for arrays',
       category: 'Stylistic Issues',
-      recommended: 'error',
+      // too opinionated to be recommended
+      recommended: false,
     },
     fixable: 'code',
     messages: {
@@ -168,7 +169,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSArrayType(node: TSESTree.TSArrayType) {
+      TSArrayType(node): void {
         if (
           isArrayOption ||
           (isArraySimpleOption && isSimpleType(node.elementType))
@@ -241,7 +242,7 @@ export default util.createRule<Options, MessageIds>({
         });
       },
 
-      TSTypeReference(node: TSESTree.TSTypeReference) {
+      TSTypeReference(node): void {
         if (
           isGenericOption ||
           node.typeName.type !== AST_NODE_TYPES.Identifier

diff --git a/packages/eslint-plugin/src/rules/await-thenable.ts b/packages/eslint-plugin/src/rules/await-thenable.ts
@@ -9,7 +9,7 @@ export default util.createRule({
     docs: {
       description: 'Disallows awaiting a value that is not a Thenable',
       category: 'Best Practices',
-      recommended: false,
+      recommended: 'error',
     },
     messages: {
       await: 'Unexpected `await` of a non-Promise (non-"Thenable") value.',
@@ -24,7 +24,7 @@ export default util.createRule({
     const checker = parserServices.program.getTypeChecker();
 
     return {
-      AwaitExpression(node) {
+      AwaitExpression(node): void {
         const originalNode = parserServices.esTreeNodeToTSNodeMap.get<
           ts.AwaitExpression
         >(node);

diff --git a/packages/eslint-plugin/src/rules/ban-ts-ignore.ts b/packages/eslint-plugin/src/rules/ban-ts-ignore.ts
@@ -7,7 +7,7 @@ export default util.createRule({
     docs: {
       description: 'Bans “// @ts-ignore” comments from being used',
       category: 'Best Practices',
-      recommended: false,
+      recommended: 'error',
     },
     schema: [],
     messages: {

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -25,7 +25,7 @@ function stringifyTypeName(
 
 function getCustomMessage(
   bannedType: null | string | { message?: string; fixWith?: string },
-) {
+): string {
   if (bannedType === null) {
     return '';
   }
@@ -108,7 +108,7 @@ export default util.createRule<Options, MessageIds>({
   ],
   create(context, [{ types: bannedTypes }]) {
     return {
-      TSTypeReference({ typeName }) {
+      TSTypeReference({ typeName }): void {
         const name = stringifyTypeName(typeName, context.getSourceCode());
 
         if (name in bannedTypes) {
@@ -124,6 +124,7 @@ export default util.createRule<Options, MessageIds>({
               name: name,
               customMessage,
             },
+            // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
             fix: fixWith ? fixer => fixer.replaceText(typeName, fixWith) : null,
           });
         }

diff --git a/packages/eslint-plugin/src/rules/camelcase.ts b/packages/eslint-plugin/src/rules/camelcase.ts
@@ -90,7 +90,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      Identifier(node) {
+      Identifier(node): void {
         /*
          * Leading and trailing underscores are commonly used to flag
          * private/protected identifiers, strip them

diff --git a/packages/eslint-plugin/src/rules/class-name-casing.ts b/packages/eslint-plugin/src/rules/class-name-casing.ts
@@ -64,15 +64,15 @@ export default util.createRule({
           | TSESTree.ClassDeclaration
           | TSESTree.TSInterfaceDeclaration
           | TSESTree.ClassExpression,
-      ) {
+      ): void {
         // class expressions (i.e. export default class {}) are OK
         if (node.id && !isPascalCase(node.id.name)) {
           report(node, node.id);
         }
       },
       "VariableDeclarator[init.type='ClassExpression']"(
         node: TSESTree.VariableDeclarator,
-      ) {
+      ): void {
         if (
           node.id.type === AST_NODE_TYPES.ArrayPattern ||
           node.id.type === AST_NODE_TYPES.ObjectPattern

diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
@@ -77,7 +77,7 @@ export default util.createRule<Options, MessageIds>({
 
     function reportIncorrectAssertionType(
       node: TSESTree.TSTypeAssertion | TSESTree.TSAsExpression,
-    ) {
+    ): void {
       const messageId = options.assertionStyle;
       context.report({
         node,
@@ -89,7 +89,7 @@ export default util.createRule<Options, MessageIds>({
       });
     }
 
-    function checkType(node: TSESTree.TypeNode) {
+    function checkType(node: TSESTree.TypeNode): boolean {
       switch (node.type) {
         case AST_NODE_TYPES.TSAnyKeyword:
         case AST_NODE_TYPES.TSUnknownKeyword:
@@ -107,7 +107,7 @@ export default util.createRule<Options, MessageIds>({
 
     function checkExpression(
       node: TSESTree.TSTypeAssertion | TSESTree.TSAsExpression,
-    ) {
+    ): void {
       if (
         options.assertionStyle === 'never' ||
         options.objectLiteralTypeAssertions === 'allow' ||
@@ -137,15 +137,15 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSTypeAssertion(node) {
+      TSTypeAssertion(node): void {
         if (options.assertionStyle !== 'angle-bracket') {
           reportIncorrectAssertionType(node);
           return;
         }
 
         checkExpression(node);
       },
-      TSAsExpression(node) {
+      TSAsExpression(node): void {
         if (options.assertionStyle !== 'as') {
           reportIncorrectAssertionType(node);
           return;

diff --git a/packages/eslint-plugin/src/rules/consistent-type-definitions.ts b/packages/eslint-plugin/src/rules/consistent-type-definitions.ts
@@ -9,6 +9,7 @@ export default util.createRule({
       description:
         'Consistent with type definition either `interface` or `type`',
       category: 'Stylistic Issues',
+      // too opinionated to be recommended
       recommended: false,
     },
     messages: {
@@ -29,7 +30,7 @@ export default util.createRule({
     return {
       "TSTypeAliasDeclaration[typeAnnotation.type='TSTypeLiteral']"(
         node: TSESTree.TSTypeAliasDeclaration,
-      ) {
+      ): void {
         if (option === 'interface') {
           context.report({
             node: node.id,
@@ -63,7 +64,7 @@ export default util.createRule({
           });
         }
       },
-      TSInterfaceDeclaration(node) {
+      TSInterfaceDeclaration(node): void {
         if (option === 'type') {
           context.report({
             node: node.id,

diff --git a/packages/eslint-plugin/src/rules/explicit-function-return-type.ts b/packages/eslint-plugin/src/rules/explicit-function-return-type.ts
@@ -47,8 +47,8 @@ export default util.createRule<Options, MessageIds>({
   defaultOptions: [
     {
       allowExpressions: false,
-      allowTypedFunctionExpressions: false,
-      allowHigherOrderFunctions: false,
+      allowTypedFunctionExpressions: true,
+      allowHigherOrderFunctions: true,
     },
   ],
   create(context, [options]) {

diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
@@ -33,8 +33,9 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Require explicit accessibility modifiers on class properties and methods',
-      category: 'Best Practices',
-      recommended: 'error',
+      category: 'Stylistic Issues',
+      // too opinionated to be recommended
+      recommended: false,
     },
     messages: {
       missingAccessibility:
@@ -82,7 +83,7 @@ export default util.createRule<Options, MessageIds>({
       nodeType: string,
       node: TSESTree.Node,
       nodeName: string,
-    ) {
+    ): void {
       context.report({
         node: node,
         messageId: messageId,
@@ -179,7 +180,7 @@ export default util.createRule<Options, MessageIds>({
      */
     function checkParameterPropertyAccessibilityModifier(
       node: TSESTree.TSParameterProperty,
-    ) {
+    ): void {
       const nodeType = 'parameter property';
       // HAS to be an identifier or assignment or TSC will throw
       if (