feat(eslint-plugin): [explicit-member-accessibility] autofix no-public (typescript-eslint#1548)

pablobirukov · web-flow · commit dd233b52dcd5 · 2020-02-28T18:21:51.000-08:00
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
@@ -102,7 +102,7 @@ Pro Tip: For larger codebases you may want to consider splitting our linting int
 | [`@typescript-eslint/consistent-type-assertions`](./docs/rules/consistent-type-assertions.md)                         | Enforces consistent usage of type assertions                                                                            | :heavy_check_mark: |          |                   |
 | [`@typescript-eslint/consistent-type-definitions`](./docs/rules/consistent-type-definitions.md)                       | Consistent with type definition either `interface` or `type`                                                            |                    | :wrench: |                   |
 | [`@typescript-eslint/explicit-function-return-type`](./docs/rules/explicit-function-return-type.md)                   | Require explicit return types on functions and class methods                                                            | :heavy_check_mark: |          |                   |
-| [`@typescript-eslint/explicit-member-accessibility`](./docs/rules/explicit-member-accessibility.md)                   | Require explicit accessibility modifiers on class properties and methods                                                |                    |          |                   |
+| [`@typescript-eslint/explicit-member-accessibility`](./docs/rules/explicit-member-accessibility.md)                   | Require explicit accessibility modifiers on class properties and methods                                                |                    | :wrench: |                   |
 | [`@typescript-eslint/explicit-module-boundary-types`](./docs/rules/explicit-module-boundary-types.md)                 | Require explicit return and argument types on exported functions' and classes' public class methods                     |                    |          |                   |
 | [`@typescript-eslint/member-delimiter-style`](./docs/rules/member-delimiter-style.md)                                 | Require a specific member delimiter style for interfaces and type literals                                              | :heavy_check_mark: | :wrench: |                   |
 | [`@typescript-eslint/member-ordering`](./docs/rules/member-ordering.md)                                               | Require a consistent member declaration order                                                                           |                    |          |                   |
diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
@@ -1,6 +1,8 @@
 import {
   AST_NODE_TYPES,
   TSESTree,
+  AST_TOKEN_TYPES,
+  TSESLint,
 } from '@typescript-eslint/experimental-utils';
 import * as util from '../util';
 
@@ -38,6 +40,7 @@ export default util.createRule<Options, MessageIds>({
       // too opinionated to be recommended
       recommended: false,
     },
+    fixable: 'code',
     messages: {
       missingAccessibility:
         'Missing accessibility modifier on {{type}} {{name}}.',
@@ -91,6 +94,7 @@ export default util.createRule<Options, MessageIds>({
       nodeType: string,
       node: TSESTree.Node,
       nodeName: string,
+      fix: TSESLint.ReportFixFunction | null = null,
     ): void {
       context.report({
         node: node,
@@ -99,6 +103,7 @@ export default util.createRule<Options, MessageIds>({
           type: nodeType,
           name: nodeName,
         },
+        fix: fix,
       });
     }
 
@@ -140,6 +145,7 @@ export default util.createRule<Options, MessageIds>({
           nodeType,
           methodDefinition,
           methodName,
+          getUnwantedPublicAccessibilityFixer(methodDefinition),
         );
       } else if (check === 'explicit' && !methodDefinition.accessibility) {
         reportIssue(
@@ -151,6 +157,47 @@ export default util.createRule<Options, MessageIds>({
       }
     }
 
+    /**
+     * Creates a fixer that removes a "public" keyword with following spaces
+     */
+    function getUnwantedPublicAccessibilityFixer(
+      node:
+        | TSESTree.MethodDefinition
+        | TSESTree.ClassProperty
+        | TSESTree.TSParameterProperty,
+    ): TSESLint.ReportFixFunction {
+      return function(fixer: TSESLint.RuleFixer): TSESLint.RuleFix {
+        const tokens = sourceCode.getTokens(node);
+        let rangeToRemove: TSESLint.AST.Range;
+        for (let i = 0; i < tokens.length; i++) {
+          const token = tokens[i];
+          if (
+            token.type === AST_TOKEN_TYPES.Keyword &&
+            token.value === 'public'
+          ) {
+            const commensAfterPublicKeyword = sourceCode.getCommentsAfter(
+              token,
+            );
+            if (commensAfterPublicKeyword.length) {
+              // public /* Hi there! */ static foo()
+              // ^^^^^^^
+              rangeToRemove = [
+                token.range[0],
+                commensAfterPublicKeyword[0].range[0],
+              ];
+              break;
+            } else {
+              // public static foo()
+              // ^^^^^^^
+              rangeToRemove = [token.range[0], tokens[i + 1].range[0]];
+              break;
+            }
+          }
+        }
+        return fixer.removeRange(rangeToRemove!);
+      };
+    }
+
     /**
      * Checks if property has an accessibility modifier.
      * @param classProperty The node representing a ClassProperty.
@@ -170,6 +217,7 @@ export default util.createRule<Options, MessageIds>({
           nodeType,
           classProperty,
           propertyName,
+          getUnwantedPublicAccessibilityFixer(classProperty),
         );
       } else if (propCheck === 'explicit' && !classProperty.accessibility) {
         reportIssue(
@@ -217,6 +265,7 @@ export default util.createRule<Options, MessageIds>({
               nodeType,
               node,
               nodeName,
+              getUnwantedPublicAccessibilityFixer(node),
             );
           }
           break;
diff --git a/packages/eslint-plugin/tests/rules/explicit-member-accessibility.test.ts b/packages/eslint-plugin/tests/rules/explicit-member-accessibility.test.ts
