chore: Update eslint dependencies and add new rule for disallowed comments

Author: tomerh2001

package.json

@@ -18,11 +18,11 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "@babel/eslint-parser": "^7.25.1",
     "eslint-config-jsdoc": "^15.4.0",
     "eslint-config-xo": "^0.46.0",
     "eslint-config-xo-react": "^0.27.0",
     "eslint-plugin-jsdoc": "^50.2.2",
-    "eslint-plugin-no-comments": "^1.1.10",
     "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.2",
     "eslint-plugin-react-native": "^4.1.0",

src/index.js

@@ -18,6 +18,7 @@ configs.recommended = {
 	rules: {
 		'th-rules/no-destructuring': 'error',
 		'th-rules/no-default-export': 'error',
+		'th-rules/no-comments': 'error',
 		'unicorn/prefer-module': 'warn',
 		'unicorn/filename-case': 'off',
 		'unicorn/no-array-callback-reference': 'off',
@@ -27,13 +28,6 @@ configs.recommended = {
 		'new-cap': 'off',
 		'no-await-in-loop': 'off',
 		camelcase: 'warn',
-		'no-comments/disallowComments': [
-			'error',
-			{
-				allow: ['^\\*\\*', 'eslint-disable', 'global', 'TODO', 'FIXME', 'NOTE', 'DEBUG'],
-			},
-		],
-
 	},
 	env: {
 		node: true,

src/rules/no-comments.js

@@ -0,0 +1,96 @@
+/* eslint-disable unicorn/prefer-module */
+
+const allowedPatterns = [
+/todo/i, // Allow TODO (case-insensitive)
+/warning/i, // Allow WARNING (case-insensitive)
+/error/i, // Allow ERROR (case-insensitive)
+/info/i, // Allow INFO (case-insensitive)
+/^\s*eslint-(disable|enable|env|globals|ignore|directive)/, // Allow ESLint directives
+];
+
+const meta = {
+type: 'problem',
+docs: {
+    description: 'Disallow comments except for specified allowed patterns.',
+},
+fixable: 'code',
+schema: [
+    {
+    type: 'object',
+    properties: {
+        allow: {
+        type: 'array',
+        items: {
+            type: 'string',
+        },
+        description: 'Additional patterns to allow in comments.',
+        },
+        disallow: {
+        type: 'array',
+        items: {
+            type: 'string',
+        },
+        description: 'Additional patterns to disallow in comments.',
+        },
+    },
+    additionalProperties: false,
+    },
+],
+};
+
+function create(context) {
+const options = context.options[0] || {};
+const userAllowedPatterns = (options.allow || []).map((pattern) => new RegExp(pattern));
+const userDisallowedPatterns = (options.disallow || []).map((pattern) => new RegExp(pattern));
+
+function isCommentAllowed(comment) {
+    const text = comment.value.trim();
+
+    // Check if the comment is a valid JSDoc comment
+    if (comment.type === 'Block' && comment.value.startsWith('*')) {
+    return true; // Allow any JSDoc-style block comment (/** ... */)
+    }
+
+    // Check if the comment matches any allowed pattern
+    for (const pattern of [...allowedPatterns, ...userAllowedPatterns]) {
+    if (pattern.test(text)) {
+        return true;
+    }
+    }
+
+    // Check if the comment matches any disallowed pattern
+    for (const pattern of userDisallowedPatterns) {
+    if (pattern.test(text)) {
+        return false;
+    }
+    }
+
+    return false; // Disallow by default if no match
+}
+
+return {
+    Program() {
+    const sourceCode = context.getSourceCode();
+    const comments = sourceCode.getAllComments();
+
+    comments.forEach((comment) => {
+        if (!isCommentAllowed(comment)) {
+        context.report({
+            node: comment,
+            message: 'Comment not allowed.',
+            fix(fixer) {
+            return fixer.remove(comment);
+            },
+        });
+        }
+    });
+    },
+};
+}
+
+const rule = {
+meta,
+create,
+};
+
+module.exports = rule;

src/tests/no-comments.js

@@ -0,0 +1,115 @@
+/* eslint-disable unicorn/prefer-module */
+
+const { RuleTester } = require('eslint');
+const rule = require('../rules/no-comments.js');
+
+// Initialize RuleTester without the old parserOptions, using the new format
+const ruleTester = new RuleTester({
+  parser: require.resolve('@babel/eslint-parser'),
+});
+
+ruleTester.run('no-disallowed-comments', rule, {
+  valid: [
+    {
+      code: `
+        /**
+         * JSDoc comment
+         * @param {string} name - The name of the person.
+         */
+        function foo(name) {}
+      `,
+    },
+    {
+      code: `
+        // TODO: this needs to be refactored
+        const x = 5;
+      `,
+    },
+    {
+      code: `
+        /* WARNING: temporary fix */
+        const y = 10;
+      `,
+    },
+    {
+      code: `
+        // eslint-disable-next-line no-console
+        console.log("hello");
+      `,
+    },
+    {
+      code: `
+        // keep this comment
+        const z = 15;
+      `,
+      options: [{ allow: ['keep'] }],
+    },
+  ],
+
+  invalid: [
+    {
+      code: `
+        // Regular comment
+        const a = 5;
+      `,
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        const a = 5;
+      `,
+    },
+    {
+      code: `
+        // Some disallowed comment
+        const b = 10;
+      `,
+      options: [{ disallow: ['disallowed'] }],
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        const b = 10;
+      `,
+    },
+    {
+      code: `
+        // DEPRECATED: Remove this function in the next version
+        function deprecatedFunc() {}
+      `,
+      options: [{ disallow: ['deprecated'] }],
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        function deprecatedFunc() {}
+      `,
+    },
+    {
+      code: `
+        // important comment
+        const c = 20;
+      `,
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        const c = 20;
+      `,
+    },
+    {
+      code: `
+        // A completely random comment
+        const d = 25;
+      `,
+      options: [{ allow: ['keep'] }],
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        const d = 25;
+      `,
+    },
+    {
+      code: `
+        // @ts-ignore
+        const e = "typescript";
+      `,
+      options: [{ disallow: ['@ts-ignore'] }],
+      errors: [{ message: 'Comment not allowed.' }],
+      output: `
+        const e = "typescript";
+      `,
+    },
+  ],
+});

yarn.lock

@@ -22,6 +22,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@babel/eslint-parser@npm:^7.25.1":
+  version: 7.25.1
+  resolution: "@babel/eslint-parser@npm:7.25.1"
+  dependencies:
+    "@nicolo-ribaudo/eslint-scope-5-internals": "npm:5.1.1-v1"
+    eslint-visitor-keys: "npm:^2.1.0"
+    semver: "npm:^6.3.1"
+  peerDependencies:
+    "@babel/core": ^7.11.0
+    eslint: ^7.5.0 || ^8.0.0 || ^9.0.0
+  checksum: 10c0/9f98351b32edfced9e6308a80ad69af1210d9c9780f19339cb286d0c9be0a9afac80d1df3b3793112e720675ce5b927920b19454d0f48ddf8370d08ab62d0dc2
+  languageName: node
+  linkType: hard
+
 "@babel/helper-validator-identifier@npm:^7.22.20":
   version: 7.22.20
   resolution: "@babel/helper-validator-identifier@npm:7.22.20"
@@ -238,6 +252,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@nicolo-ribaudo/eslint-scope-5-internals@npm:5.1.1-v1":
+  version: 5.1.1-v1
+  resolution: "@nicolo-ribaudo/eslint-scope-5-internals@npm:5.1.1-v1"
+  dependencies:
+    eslint-scope: "npm:5.1.1"
+  checksum: 10c0/75dda3e623b8ad7369ca22552d6beee337a814b2d0e8a32d23edd13fcb65c8082b32c5d86e436f3860dd7ade30d91d5db55d4ef9a08fb5a976c718ecc0d88a74
+  languageName: node
+  linkType: hard
+
 "@nodelib/fs.scandir@npm:2.1.5":
   version: 2.1.5
   resolution: "@nodelib/fs.scandir@npm:2.1.5"
@@ -3148,13 +3171,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-plugin-no-comments@npm:^1.1.10":
-  version: 1.1.10
-  resolution: "eslint-plugin-no-comments@npm:1.1.10"
-  checksum: 10c0/75549d56ccc73b7a1ead94efbca80610b6c74a417dc2a3436b87ea938d50eb208977d0ed4a43674f2794cee1d1e8446d07ccdffb76468d05bed8213a0ad61de4
-  languageName: node
-  linkType: hard
-
 "eslint-plugin-no-use-extend-native@npm:^0.5.0":
   version: 0.5.0
   resolution: "eslint-plugin-no-use-extend-native@npm:0.5.0"
@@ -3289,6 +3305,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "eslint-plugin-th-rules@workspace:."
   dependencies:
+    "@babel/eslint-parser": "npm:^7.25.1"
     "@codedependant/semantic-release-docker": "npm:^5.0.3"
     "@eslint/js": "npm:^9.9.0"
     "@semantic-release/changelog": "npm:^6.0.3"
@@ -3309,7 +3326,6 @@ __metadata:
     eslint-doc-generator: "npm:^1.7.1"
     eslint-plugin-eslint-plugin: "npm:^6.2.0"
     eslint-plugin-jsdoc: "npm:^50.2.2"
-    eslint-plugin-no-comments: "npm:^1.1.10"
     eslint-plugin-node: "npm:^11.1.0"
     eslint-plugin-react: "npm:^7.35.0"
     eslint-plugin-react-hooks: "npm:^4.6.2"
@@ -3388,7 +3404,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-scope@npm:^5.1.1":
+"eslint-scope@npm:5.1.1, eslint-scope@npm:^5.1.1":
   version: 5.1.1
   resolution: "eslint-scope@npm:5.1.1"
   dependencies:
@@ -3445,7 +3461,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-visitor-keys@npm:^2.0.0":
+"eslint-visitor-keys@npm:^2.0.0, eslint-visitor-keys@npm:^2.1.0":
   version: 2.1.0
   resolution: "eslint-visitor-keys@npm:2.1.0"
   checksum: 10c0/9f0e3a2db751d84067d15977ac4b4472efd6b303e369e6ff241a99feac04da758f46d5add022c33d06b53596038dbae4b4aceb27c7e68b8dfc1055b35e495787