Add no-jira-ticket rule (#13)

* add a rule to error when a TODO does not have a JIRA ticket

* pr comments

* remove log and update license

* update to support multi TODO files

---------

Co-authored-by: YJ Lee <youngji.lee@skyscanner.net>

Author: youngji0827

index.js

@@ -16,10 +16,12 @@
 
 const noAxios = require('./src/rules/no-axios/no-axios');
 const forbidComponentProps = require('./src/rules/forbid-component-props/forbid-component-props');
+const noJiraTodo = require('./src/rules/no-jira-todo/no-jira-todo');
 
 module.exports = {
   rules: {
     'no-axios': noAxios,
     'forbid-component-props': forbidComponentProps,
+    'no-jira-todo': noJiraTodo,
   },
 };

src/rules/no-jira-todo/README.md

@@ -0,0 +1,40 @@
+## Asserting all TODO comments have a linked JIRA ticket
+
+This rule when enabled would require every `TODO` style comnent to be linked to an associated JIRA ticket.
+
+The format of the comment is required to match:
+
+- `TODO:`/`FIXME:`/`@TODO:`/`@FIXME:`
+- followed by the Jira url or the ticket reference in square brackets, eg:
+  - `https://skyscanner.atlassian.net/browse/JIRA-0000`
+  - `[JIRA-0000]`
+- then an optional description about the changes needed by the linked ticket
+
+Examples of valid comments:
+
+```tsx
+// TODO: [WALL-1234] description of the change needed
+// FIXME: [CASTLE-5678]
+// FIXME: [WOM-2468] comment
+// @TODO: [WALL-1234] description of the change needed
+// @FIXME: [WALL-1234] description of the change needed
+// TODO: https://skyscanner.atlassian.net/browse/SHIBA-1234 description of the change needed
+// @FIXME: https://skyscanner.atlassian.net/browse/WOODPECKER-1010 description of the change needed
+// TODO: [JIRA-XXXX] fixed
+```
+
+Examples of invalid comments:
+
+```tsx
+// TODO: WALL-1234 description of the change needed
+// TODO: description of the change needed
+// FIXME description of the change needed WALL-1234
+// @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]
+```

src/rules/no-jira-todo/no-jira-todo.js

@@ -0,0 +1,71 @@
+/**
+ * Copyright 2023-present Skyscanner Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+const messages = {
+  'todo-error':
+    'JIRA ticket numbers must be added to all TODO/FIXME comments (e.g. TODO: DINGO-123)',
+};
+
+const verifyCommentPrefix = (comment) =>
+  ['TODO', 'FIXME', '@TODO', '@FIXME'].find((prefix) =>
+    comment.startsWith(prefix),
+  );
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'All TODO comments must have a linked JIRA ticket',
+      category: 'Best Practices',
+      recommended: 'error',
+      url: 'https://github.com/Skyscanner/eslint-plugin-rules#no-jira-todo',
+    },
+    messages,
+    type: 'suggestion',
+    schema: [],
+    fixable: 'code',
+  },
+  create(context) {
+    return {
+      Program() {
+        const prefix = new RegExp('@?(TODO|FIXME)');
+        const ticket = new RegExp('[A-Z]{2,255}-(\\d|X){2,8}');
+        const jiraUrl = new RegExp(
+          `https://([a-zA-Z0-9.\/-]\+)/${ticket.source}`,
+        );
+        const regex = new RegExp(
+          `${prefix.source}:\\s(${jiraUrl.source}|\\[\?${ticket.source}\\]\?)(\\s.*)?`,
+        );
+
+        for (const comment of context.getSourceCode().getAllComments()) {
+          const value = comment.value.trimStart();
+
+          if (verifyCommentPrefix(value) && !regex.test(value)) {
+            context.report({
+              node: comment,
+              messageId: 'todo-error',
+              fix: (fixer) =>
+                fixer.replaceText(comment, '// TODO: [JIRA-XXXX]'),
+            });
+          }
+        }
+      },
+    };
+  },
+};

src/rules/no-jira-todo/no-jira-todo.test.js

@@ -0,0 +1,75 @@
+/**
+ * Copyright 2023-present Skyscanner Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const { RuleTester } = require('eslint');
+
+const rule = require('./no-jira-todo');
+
+const parserOptions = {
+  ecmaVersion: 2018,
+  sourceType: 'module',
+  ecmaFeatures: {
+    jsx: true,
+  },
+};
+
+const ruleTester = new RuleTester({ parserOptions });
+
+ruleTester.run('no-jira-todo', rule, {
+  valid: [
+    'const variable = "Non comment"',
+    '// TODO: [WALL-1234] description',
+    '// TODO: DINGO-123 description',
+    '// TODO: [JIRA-XXXX] fixed',
+    '// FIXME: [CASTLE-5678]',
+    '// FIXME: [WOM-2468] comment',
+    '// @TODO: [WALL-1234] description',
+    '// @FIXME: [WALL-1234] description',
+    '// TODO: https://skyscanner.atlassian.net/browse/SHIBA-1234 description',
+    '// TODO: https://atlassian-upgrade.net/browse/WALL-1234',
+    '// @FIXME: https://skyscanner.atlassian.net/browse/WOODPECKER-1010 description',
+    'const regex = new RegExp("expression", "i"); // TODO: [JIRA-4321] comment',
+    `// TODO: ST-123 first of multiple TODOs
+    const { locale } = context[requestContextParameters.CULTURE];
+    // TODO: DINGO-123 another TODO`,
+  ],
+  invalid: [
+    {
+      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]',
+    },
+  ],
+});