Add @tag support

Replace better-use-match by avoid-regexp-include

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/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

@@ -10,7 +10,7 @@ module.exports = createValidator(
         messageId: 'multipleVersions'
       });
     }
-    if (!/^([^.\s]+)(\.[^.\s]*){0,3}\s*$/.test(attrVal.val)) {
+    if (!/^([^\s.]+)(\.[^\s.]+)*$/.test(attrVal.val)) {
       context.report({
         loc: {
           start: {

lib/rules/require-version.js

@@ -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

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-userscripts",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Implements rules for userscripts metadata in eslint",
   "keywords": [
     "eslint",
@@ -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",
@@ -34,7 +34,7 @@
     "eslint": ">=6.0.0 <=^8.0.0"
   },
   "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+    "node": ">=16.0.0"
   },
   "license": "MIT",
   "homepage": "https://github.com/Yash-Singh1/eslint-plugin-userscripts#readme",

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(