Remove no-jira-todo fixer (#19)

* remove fix rule from no-jira-todo * remove fixable property * remove fixer reference from docs * update tests --------- Co-authored-by: George Wright <[email protected]>
Skyscanner · Jul 17, 2024 · 0c56d51 · 0c56d51
1 parent ff6f9e5
commit 0c56d51
Show file tree

Hide file tree

Showing 3 changed files with 0 additions and 14 deletions.
diff --git a/src/rules/no-jira-todo/README.md b/src/rules/no-jira-todo/README.md
@@ -32,9 +32,3 @@ Examples of invalid comments:
 // @FIXME description of the change needed WALL-1234
 // @TODO: https://skyscanner.atlassian.net/browse/not-a-ticket
 ```
-
-If an invalid `TODO` comment is recognised, there is a auto fix available to update the comment to the format. This should be updated with the ticket and description. This is provided in the format:
-
-```tsx
-// TODO: [JIRA-XXX]
-```
diff --git a/src/rules/no-jira-todo/no-jira-todo.js b/src/rules/no-jira-todo/no-jira-todo.js
@@ -39,7 +39,6 @@ module.exports = {
     messages,
     type: 'suggestion',
     schema: [],
-    fixable: 'code',
   },
   create(context) {
     return {
@@ -60,8 +59,6 @@ module.exports = {
             context.report({
               node: comment,
               messageId: 'todo-error',
-              fix: (fixer) =>
-                fixer.replaceText(comment, '// TODO: [JIRA-XXXX]'),
             });
           }
         }

diff --git a/src/rules/no-jira-todo/no-jira-todo.test.js b/src/rules/no-jira-todo/no-jira-todo.test.js
@@ -49,27 +49,22 @@ ruleTester.run('no-jira-todo', rule, {
     {
       code: '// TODO: please fail',
       errors: [{ messageId: 'todo-error' }],
-      output: '// TODO: [JIRA-XXXX]',
     },
     {
       code: '// TODO: this should also fail WALL-1234',
       errors: [{ messageId: 'todo-error' }],
-      output: '// TODO: [JIRA-XXXX]',
     },
     {
       code: '// FIXME another fail WALL-1234',
       errors: [{ messageId: 'todo-error' }],
-      output: '// TODO: [JIRA-XXXX]',
     },
     {
       code: '// @FIXME and this too [WALL-1234]',
       errors: [{ messageId: 'todo-error' }],
-      output: '// TODO: [JIRA-XXXX]',
     },
     {
       code: '// @TODO: https://skyscanner.atlassian.net/browse/not-a-ticket',
       errors: [{ messageId: 'todo-error' }],
-      output: '// TODO: [JIRA-XXXX]',
     },
   ],
 });