feat(eslint-plugin-tslint): add fixer for config rule (typescript-eslint#1342)

johnwiseheart · bradzacher · bradzacher · commit c52c5c997e76 · 2019-12-17T16:04:55.000+10:30
Co-authored-by: Brad Zacher &lt;brad.zacher@gmail.com&gt;
diff --git a/packages/eslint-plugin-tslint/src/rules/config.ts b/packages/eslint-plugin-tslint/src/rules/config.ts
@@ -67,6 +67,7 @@ export default createRule<Options, MessageIds>({
       category: 'TSLint' as any, // eslint-disable-line @typescript-eslint/no-explicit-any
       recommended: false,
     },
+    fixable: 'code',
     type: 'problem',
     messages: {
       failure: '{{message}} (tslint:{{ruleName}})',
@@ -165,6 +166,23 @@ export default createRule<Options, MessageIds>({
               column: end.character,
             },
           },
+          fix: fixer => {
+            const replacements = failure.getFix();
+
+            return Array.isArray(replacements)
+              ? replacements.map(replacement =>
+                  fixer.replaceTextRange(
+                    [replacement.start, replacement.end],
+                    replacement.text,
+                  ),
+                )
+              : replacements !== undefined
+              ? fixer.replaceTextRange(
+                  [replacements.start, replacements.end],
+                  replacements.text,
+                )
+              : [];
+          },
         });
       });
     }
diff --git a/packages/eslint-plugin-tslint/tests/index.spec.ts b/packages/eslint-plugin-tslint/tests/index.spec.ts
@@ -86,7 +86,7 @@ ruleTester.run('tslint/config', rule, {
     {
       code: 'var foo = true // semicolon',
       options: tslintRulesConfig,
-      output: 'var foo = true // semicolon',
+      output: 'var foo = true; // semicolon',
       filename: './tests/fixture-project/4.ts',
       errors: [
         {
diff --git a/tests/integration/fixtures/typescript-and-tslint-plugins-together/test.js.snap b/tests/integration/fixtures/typescript-and-tslint-plugins-together/test.js.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "errorCount": 1,
     "filePath": "/usr/linked/index.ts",
-    "fixableErrorCount": 0,
+    "fixableErrorCount": 1,
     "fixableWarningCount": 0,
     "messages": Array [
       Object {
@@ -22,6 +22,13 @@ Array [
         "column": 20,
         "endColumn": 20,
         "endLine": 1,
+        "fix": Object {
+          "range": Array [
+            19,
+            19,
+          ],
+          "text": ";",
+        },
         "line": 1,
         "message": "Missing semicolon (tslint:semicolon)",
         "messageId": "failure",

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ ruleTester.run('tslint/config', rule, {`
`86`	`86`	`{`
`87`	`87`	`code: 'var foo = true // semicolon',`
`88`	`88`	`options: tslintRulesConfig,`
`89`		`- output: 'var foo = true // semicolon',`
	`89`	`+ output: 'var foo = true; // semicolon',`
`90`	`90`	`filename: './tests/fixture-project/4.ts',`
`91`	`91`	`errors: [`
`92`	`92`	`{`