Add @tag

Replace better use match by an avoid regexp include rule
Update dependencies

Author: derjanb

lib/index.js

@@ -19,7 +19,7 @@ module.exports.configs = {
       'userscripts/align-attributes': ['error', 2],
       'userscripts/no-invalid-headers': 'error',
       'userscripts/no-invalid-grant': 'error',
-      'userscripts/better-use-match': 'warning'
+      'userscripts/avoid-regexp-include': 'warning'
     }
   }
 };

lib/rules/align-attributes.js

@@ -20,7 +20,7 @@ module.exports = {
   create: (context) => {
     const spacing = context.options[0] || 2;
 
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const comments = sourceCode.getAllComments();
 
     let inMetadata = false;

lib/rules/avoid-regexp-include.js

@@ -0,0 +1,24 @@
+const createValidator = require('../utils/createValidator');
+
+module.exports = createValidator(
+  'include',
+  false,
+  ({ attrVal, context }) => {
+    const argument = attrVal.val;
+    if (argument.startsWith('/')) {
+      context.report({
+        loc: {
+          start: {
+            line: attrVal.loc.start.line,
+            column: 0
+          },
+          end: attrVal.loc.end
+        },
+        messageId: 'avoidRegExpInclude'
+      });
+    }
+  },
+  {
+    avoidRegExpInclude: "Using a regular expression at '@include' can cause performance issues. Use a regular @include or @match instead."
+  }
+);

lib/rules/better-use-match.js

@@ -38,6 +38,7 @@ const validHeaders = new Set(
     'sandbox',
     'source',
     'supportURL',
+    'tag',
     'unwrap',
     'updateURL',
     'version',

lib/rules/no-invalid-headers.js

@@ -26,7 +26,7 @@ module.exports = {
     ]
   },
   create: (context) => {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
 
     const comments = sourceCode.getAllComments();
     const lines = sourceCode.lines;

lib/rules/no-invalid-metadata.js

@@ -11,7 +11,7 @@ module.exports = {
     schema: []
   },
   create: (context) => {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode;
     const lines = sourceCode.lines;
     let inMetadata = false;
     let done = false;

lib/rules/require-attribute-space-prefix.js

@@ -32,7 +32,7 @@ module.exports = createValidator(
           )
       )
     ) {
-      const sourceCode = context.getSourceCode();
+      const sourceCode = context.sourceCode;
       const comments = sourceCode.getAllComments();
       const endingMetadataComment = comments.find(
         (comment) =>
@@ -64,7 +64,7 @@ module.exports = createValidator(
                     index === 0
                       ? val -
                         context
-                          .getSourceCode()
+                          .sourceCode
                           .lines[deepAttrValue.loc.start.line - 1].split(
                             '//'
                           )[0].length -
@@ -78,7 +78,7 @@ module.exports = createValidator(
           fixerRules.push(
             fixer.insertTextAfterRange(
               context
-                .getSourceCode()
+                .sourceCode
                 .getAllComments()
                 .find((val) => val.value.trim() === '==UserScript==').range,
               attrVal
@@ -93,7 +93,7 @@ module.exports = createValidator(
                   (attrValue) =>
                     `\n${
                       context
-                        .getSourceCode()
+                        .sourceCode
                         .lines[attrValue.loc.start.line - 1].split('//')[0]
                     }//${attrValue.comment.value}`
                 )

lib/rules/require-name.js

@@ -10,14 +10,14 @@ module.exports = createValidator(
         messageId: 'multipleVersions'
       });
     }
-    if (!/^([^.\s]+)(\.[^.\s]*){0,3}\s*$/.test(attrVal.val)) {
+    if (!/^([^\s.]+)(\.[^\s.]+)*$/.test(attrVal.val)) {
       context.report({
         loc: {
           start: {
             line: attrVal.loc.start.line,
             column:
               /^(\s*\/\/\s*)/.exec(
-                context.getSourceCode().lines[attrVal.comment.loc.start.line]
+                context.sourceCode.lines[attrVal.comment.loc.start.line]
               )[1].length - 1
           },
           end: attrVal.loc.end

lib/rules/require-version.js

@@ -18,7 +18,7 @@ module.exports = createValidator(
           return fixer.insertTextAfterRange(
             attrVal.comment.range,
             `\n${context
-              .getSourceCode()
+              .sourceCode
               .lines[attrVal.comment.loc.start.line - 1].replace(
                 /^(\s*\/\/\s*@)\S*/,
                 '$1' + attribute

lib/rules/use-download-and-update-url.js

@@ -20,7 +20,7 @@ module.exports = createValidator(
           return fixer.insertTextAfterRange(
             attrVal.comment.range,
             `\n${context
-              .getSourceCode()
+              .sourceCode
               .lines[attrVal.comment.loc.start.line - 1].replace(
                 /^(\s*\/\/\s*@)\S*/,
                 '$1' + attribute

lib/rules/use-homepage-and-url.js

@@ -65,7 +65,7 @@ module.exports = function createValidator(
       fixable: fixable ? 'code' : undefined
     },
     create: (context) => {
-      const sourceCode = context.getSourceCode();
+      const sourceCode = context.sourceCode;
       const comments = sourceCode.getAllComments();
 
       let inMetadata = false;
@@ -86,12 +86,12 @@ module.exports = function createValidator(
           inMetadata = true;
           wentInMetadata = true;
         } else if (inMetadata && comment.value.trim().startsWith('@')) {
-          const key = comment.value.trim().slice(1).split(/[ \t]/)[0];
+          const key = comment.value.trim().slice(1).split(/[\t ]/)[0];
           const val = {
             val: comment.value
               .trim()
               .slice(1)
-              .split(/[ \t]/)
+              .split(/[\t ]/)
               .slice(1)
               .join(' ')
               .trim(),

lib/utils/createValidator.js

@@ -22,9 +22,9 @@
     "@babel/eslint-parser": "^7.15.8",
     "acorn": "^8.5.0",
     "eslint": "^8.0.0",
-    "eslint-plugin-eslint-plugin": "^4.0.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-unicorn": "^37.0.1",
+    "eslint-plugin-eslint-plugin": ">=4.0.0",
+    "eslint-plugin-import": ">=2.24.2",
+    "eslint-plugin-unicorn": ">=37.0.1",
     "husky": "^7.0.2",
     "mocha": "^9.0.3",
     "nyc": "^15.1.0",

package.json

@@ -1,20 +1,20 @@
-var rule = require('..')['better-use-match'];
+var rule = require('..')['avoid-regexp-include'];
 var RuleTester = require('eslint').RuleTester;
 
 var ruleTester = new RuleTester();
-ruleTester.run('better-use-match', rule, {
+ruleTester.run('avoid-regexp-include', rule, {
   valid: [
     `// ==UserScript==
     // @description This is my description
-    // @match *://*/*
+    // @include https://*
     // ==/UserScript==`,
   ],
   invalid: [
     {
       code: `// ==UserScript==
-      // @include *://*/*
+      // @include /https?:\\/\\/foo.bar\\/.*/
       // ==/UserScript==`,
-      errors: [{ messageId: 'betterUseMatch' }]
+      errors: [{ messageId: 'avoidRegExpInclude' }]
     }
   ]
-});
+});

tests/lib/rules/better-use-match.js renamed to tests/lib/rules/avoid-regexp-include.js

@@ -33,7 +33,10 @@ ruleTester.run('require-version', rule, {
     // ==/UserScript==`,
     `// ==UserScript==
     // @version 1.1.1.1.2.0.1.1.1.1.1
-    // ==/UserScript==`
+    // ==/UserScript==`,
+    `// ==UserScript==
+    // @version @.€.$
+    // ==/UserScript==`,
   ],
   invalid: [
     {
@@ -73,12 +76,6 @@ ruleTester.run('require-version', rule, {
       // @version 5 .6
       // ==/UserScript==`,
       errors: [{ messageId: 'invalidVersion' }]
-    },
-    {
-      code: `// ==UserScript==
-      // @version @.€.$
-      // ==/UserScript==`,
-      errors: [{ messageId: 'invalidVersion' }]
     }
   ]
 });

tests/lib/rules/require-version.js

@@ -1,5 +1,5 @@
 const createValidator = require('../../../lib/utils/createValidator.js');
-const assert = require('assert');
+const assert = require('node:assert');
 
 it('should properly generate description', () => {
   assert.strictEqual(