eslint-plugin-greasemonkey 1.8.1 → 1.8.3

package/README.md

@@ -6,7 +6,8 @@
     <img alt="[Latest Build]" src="https://img.shields.io/npm/v/eslint-plugin-greasemonkey?logo=icinga&style=for-the-badge&label=Latest%20Build&color=32fcee"></a>
 <a href="#license">
     <img alt="[License: MIT]" src="https://img.shields.io/badge/License-MIT-f1f20a.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<img src="https://img.shields.io/npm/dm/eslint-plugin-greasemonkey?style=for-the-badge&logo=npm&color=black">
+<a>
+    <img src="https://img.shields.io/npm/dm/eslint-plugin-greasemonkey?style=for-the-badge&logo=npm&color=black"></a>
 <a target="_blank" href="https://eslint.org/">
     <img alt="[Requires ESLint >=9.0.0]" src="https://img.shields.io/badge/Requires-ESLint_%3E%3D9.0.0-4B32C3?style=for-the-badge&logo=eslint"></a>
 <br><br>
@@ -51,7 +52,7 @@ export default [
 ]
 ```
 
-Available bundles: `recommended`, `strict`, `problem`, `tampermonkey`, `violentmonkey`, `greasemonkey`, `scriptcat`, `adguard`
+Available bundles: `recommended`, `strict` (everything), `problem` (deterministic bugs only), `tampermonkey`, `violentmonkey`, `greasemonkey`, `scriptcat`, `adguard`
 
 **Note:** Rule config is either a severity string (`'off'`, `'warn'`, `'error'`) or an array `[severity, options]` when the rule accepts options.
 
@@ -1087,8 +1088,6 @@ If you prefer shorter URLs, or don't support users who strictly enforce subresou
 
 #### See also
 
-- [`no-invalid-headers`](#no-invalid-headers)
-- [`require-required-fields`](#require-required-fields)
 - <a target="_blank" href="https://www.tampermonkey.net/documentation.php?q=sri">Tampermonkey — Subresource Integrity</a>
 - <a target="_blank" href="https://docs.scriptcat.org/en/docs/dev/meta/#resource-integrity-verification">ScriptCat — Resource Integrity Verification</a>
 
@@ -1140,7 +1139,7 @@ If you prefer shorter URLs, or don't support users who strictly enforce subresou
 
 #### When not to use it
 
-If you don't target Tampermonkey, ScriptCat or AdGuard (where `@updateURL` avoids re-downloading the full script on every update check).
+If you don't strictly target Tampermonkey, ScriptCat or AdGuard (where `@updateURL` avoids re-downloading the full script on every update check).
 
 #### Introduced in
 
@@ -1148,7 +1147,6 @@ If you don't target Tampermonkey, ScriptCat or AdGuard (where `@updateURL` avoid
 
 #### See also
 
-- [`require-homepage-pair`](#require-homepage-pair)
 - <a target="_blank" href="https://www.tampermonkey.net/documentation.php?q=update_url#meta:updateURL">Tampermonkey — `@updateURL`</a>
 - <a target="_blank" href="https://docs.scriptcat.org/en/docs/dev/meta/#updateurl">ScriptCat — `@updateURL`</a>
 
@@ -1262,7 +1260,7 @@ If you use a custom versioning scheme or URLs that aren't standard.
 #### See also
 
 - [`no-invalid-grants`](#no-invalid-grants)
-- [`no-missing-resources`](#no-missing-resources)
+- [`no-invalid-headers`](#no-invalid-headers)
 
 <div align="center">
 
@@ -1274,7 +1272,7 @@ If you use a custom versioning scheme or URLs that aren't standard.
 
 ---
 
-## <img height=30 align="top" src="https://api.iconify.design/boxicons/code-alt-filled.svg?color=%232b2b2a"> Shield embed
+## <img width=30 align="top" src="https://api.iconify.design/boxicons/code-alt-filled.svg?color=%232b2b2a"> Shield embed
 
 <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-greasemonkey/#readme">
     <img height=32 alt="[Linted by eslint-plugin-greasemonkey]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--greasemonkey-black?logo=eslint&logoColor=white&labelColor=464646&style=for-the-badge"></a>
@@ -1282,7 +1280,7 @@ If you use a custom versioning scheme or URLs that aren't standard.
 #### HTML
 
 ```html
-<a href="https://codeberg.org/adamlui/eslint-plugin-greasemonkey/#readme">
+<a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-greasemonkey/#readme">
     <img height=32 alt="[Linted by eslint-plugin-greasemonkey]" src="https://img.shields.io/badge/Linted_by-eslint--plugin--greasemonkey-black?logo=eslint&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 ```
 
@@ -1316,6 +1314,20 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ## <img height=30 width=29 align="top" src="https://api.iconify.design/bxs/package.svg?color=%232b2b2a"> Related
 
+<!-- eslint-plugin-chrome-extensions -->
+
+### <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-chrome-extensions/#readme"><img height=15 width=auto src="https://cdn.staticdelivr.com/gl/adamlui/eslint-plugin-greasemonkey/e9128375d4/assets/images/icons/eslint/purple/icon16.png"> eslint-plugin-chrome-extensions</a>
+
+<details>
+
+<summary>ESLint rules for Chrome extensions.</summary><br>
+
+> <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-chrome-extensions/#readme"><img width=555 src="https://cdn.staticdelivr.com/gl/adamlui/eslint-plugin-chrome-extensions/0b5e3e49/assets/images/screenshots/vs-code/squiggles.png"></a>
+
+> <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-chrome-extensions/#installation"><b>Install</b></a> / <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-chrome-extensions/#readme">Readme</a> / <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-chrome-extensions/#supported-rules">Supported rules</a>
+
+</details>
+
 <!-- eslint-plugin-constructors -->
 
 ### <a target="_blank" href="https://codeberg.org/adamlui/eslint-plugin-constructors/#readme"><img height=15 width=auto src="https://cdn.staticdelivr.com/gl/adamlui/eslint-plugin-greasemonkey/e9128375d4/assets/images/icons/eslint/purple/icon16.png"> eslint-plugin-constructors</a>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-greasemonkey",
-  "version": "1.8.1",
+  "version": "1.8.3",
   "description": "ESLint rules for Greasemonkey/Tampermonkey userscripts",
   "type": "module",
   "engines": {
@@ -68,11 +68,11 @@
     "@eslint/json": "^2.1.0",
     "@eslint/markdown": "^8.0.3",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "eslint": "^10.11.0",
-    "eslint-plugin-constructors": "^1.4.0",
+    "eslint": "^10.12.0",
+    "eslint-plugin-constructors": "^1.4.1",
     "eslint-plugin-eslint-plugin": "^7.6.2",
     "eslint-plugin-import-x": "^4.17.1",
-    "eslint-plugin-n": "^18.4.0",
+    "eslint-plugin-n": "^18.4.1",
     "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-no-unsanitized": "^4.1.5",
     "eslint-plugin-promise": "^7.3.0",

package/src/index.js

@@ -22,7 +22,7 @@ import requireUpdateDownloadPair from './rules/require-update-download-pair.js'
 import requireUserJsFilename from './rules/require-user-js-filename.js'
 import validFieldValues from './rules/valid-field-values.js'
 
-import { initDeprecatedAlias } from './utils.js'
+import { bundleRules, initDeprecatedAlias } from './utils.js'
 
 const plugin = {
     rules: {
@@ -57,33 +57,15 @@ for (const entry of Object.entries(oldRules))
 plugin.configs = {
     recommended: {
         plugins: { greasemonkey: plugin },
-        rules: {
-            'greasemonkey/meta-spacing': 'error',
-            'greasemonkey/no-duplicate-keys': 'error',
-            'greasemonkey/no-invalid-grants': 'error',
-            'greasemonkey/no-invalid-headers': 'error',
-            'greasemonkey/no-missing-grants': 'error',
-            'greasemonkey/no-unused-grants': 'error',
-            'greasemonkey/no-missing-resources': 'error',
-            'greasemonkey/no-unused-resources': 'error',
-            'greasemonkey/prefer-match': 'error',
-            'greasemonkey/require-blank-line-after-meta-block': 'error',
-            'greasemonkey/require-matching-localized-fields': 'error',
-            'greasemonkey/require-required-fields': 'error',
-            'greasemonkey/require-space-before-meta-key': 'error',
-            'greasemonkey/require-user-js-filename': 'error',
-            'greasemonkey/valid-field-values': 'error'
-        }
+        rules: bundleRules(plugin.rules, rule => rule.meta.docs.recommended, 'greasemonkey')
     },
     strict: {
         plugins: { greasemonkey: plugin },
-        rules: Object.fromEntries(Object.keys(plugin.rules).map(ruleId => [`greasemonkey/${ruleId}`, 'error']))
+        rules: bundleRules(plugin.rules, () => true, 'greasemonkey')
     },
     problem: {
         plugins: { greasemonkey: plugin },
-        rules: Object.fromEntries(Object.entries(plugin.rules)
-            .filter(([, rule]) => rule.meta.type == 'problem')
-            .map(([ruleId]) => [`greasemonkey/${ruleId}`, 'error']))
+        rules: bundleRules(plugin.rules, rule => rule.meta.type == 'problem', 'greasemonkey')
     }
 }
 

package/src/rules/meta-order.js

@@ -39,13 +39,13 @@ export default {
             properties: {
                 order: {
                     type: 'array', items: { type: 'string' },
-                    description: 'Metadata keys in preferred order; unspecified keys are ignored'
+                    description: 'Metadata keys in preferred order'
                 }
             },
             additionalProperties: false
         }],
         defaultOptions: [{ order: [] }],
-        messages: { wrongOrder: '@{{first}} should appear before @{{second}}' }
+        messages: { wrongOrder: '@{{first}} should appear before @{{second}}.' }
     },
 
     create(context) {

package/src/rules/meta-spacing.js

@@ -22,7 +22,7 @@ export default {
             additionalProperties: false
         }],
         defaultOptions: [{ spaces: 3 }],
-        messages: { misaligned: 'Metadata values should be aligned at column {{column}}' }
+        messages: { misaligned: 'Metadata values should be aligned at column {{column}}.' }
     },
 
     create(context) {

package/src/rules/no-duplicate-keys.js

@@ -14,7 +14,7 @@ export default {
             recommended: true
         },
         schema: [],
-        messages: { dupeKey: 'Duplicate @{{key}}' }
+        messages: { dupeKey: 'Duplicate @{{key}}.' }
     },
 
     create(context) {

package/src/rules/no-invalid-grants.js

@@ -1,6 +1,7 @@
-import { extractMetadata } from '../utils.js'
 import { allAPIs, supportsAPI } from '../data/apis.js'
 
+import { extractMetadata } from '../utils.js'
+
 const managers = ['tampermonkey', 'violentmonkey', 'greasemonkey', 'scriptcat', 'adguard'],
       specialGrants = new Set(['none', 'unsafeWindow', 'window.close', 'window.focus', 'window.onurlchange']),
       allGrants = new Set([...allAPIs, ...specialGrants]),
@@ -37,7 +38,7 @@ export default {
         defaultOptions: [{}],
         messages: {
             invalidGrant: 'Invalid @grant: "{{grant}}"',
-            unsupportedGrant: '"@{{grant}}" is not supported by {{target}} (only by {{supporting}})',
+            unsupportedGrant: '"@{{grant}}" is not supported by {{target}} (only by {{supporting}}).',
             wrongCase: 'Invalid @grant: "{{grant}}" (did you mean "{{suggestion}}"?)'
         }
     },
@@ -46,14 +47,15 @@ export default {
         const options = context.options[0] || {},
               rawTarget = options.target ?? 'all',
               targets = Array.isArray(rawTarget) ? rawTarget : [rawTarget],
-              allowedGrants = [options.allowedGrants ?? []].flat()
+              rawAllowed = options.allowedGrants ?? [],
+              allowedGrants = new Set(Array.isArray(rawAllowed) ? rawAllowed : [rawAllowed])
         return {
             Program() {
                 const metaEntries = extractMetadata(context.sourceCode),
                       grantEntries = metaEntries.filter(entry => entry.key == 'grant')
                 for (const grant of grantEntries) {
                     const grantName = grant.value.trim()
-                    if (specialGrants.has(grantName) || allowedGrants.includes(grantName)) continue
+                    if (specialGrants.has(grantName) || allowedGrants.has(grantName)) continue
                     if (!allGrants.has(grantName)) {
                         const suggestion = sortedGrants.get(grantName.toLowerCase())
                         if (suggestion && suggestion != grantName)

package/src/rules/no-invalid-headers.js

@@ -1,6 +1,7 @@
-import { extractMetadata } from '../utils.js'
 import { managerHeaders, managers, localizedHeaders, validHeaders } from '../data/headers.js'
 
+import { extractMetadata } from '../utils.js'
+
 function parseAllowedPattern(entry) {
     if (typeof entry != 'string' || !entry.startsWith('/')) return null
     const lastSlash = entry.lastIndexOf('/')
@@ -37,8 +38,8 @@ export default {
         }],
         defaultOptions: [{ allowedHeaders: [] }],
         messages: {
-            invalidHeader: 'Invalid header: "@{{header}}"',
-            unsupportedHeader: '"@{{header}}" is not supported by {{target}} (only by {{supporting}})'
+            invalidHeader: 'Invalid header: "@{{header}}".',
+            unsupportedHeader: '"@{{header}}" is not supported by {{target}} (only by {{supporting}}).'
         }
     },
 

package/src/rules/no-missing-grants.js

@@ -1,6 +1,7 @@
-import { extractMetadata } from '../utils.js'
 import { gmLegacyAPIs, gmModernAPIs, scAPIs } from '../data/apis.js'
 
+import { extractMetadata } from '../utils.js'
+
 const apis = new Set([...gmLegacyAPIs, ...gmModernAPIs, ...scAPIs]),
       grantlessAPIs = new Set(['GM_info', 'GM.info']) // always available, no grant required
 
@@ -13,7 +14,7 @@ export default {
             recommended: true
         },
         schema: [],
-        messages: { missingGrant: 'Missing @grant: "{{api}}"' }
+        messages: { missingGrant: 'Missing @grant: "{{api}}".' }
     },
 
     create(context) {

package/src/rules/no-missing-resources.js

@@ -13,8 +13,8 @@ export default {
         },
         schema: [],
         messages: {
-            missingResource: 'Missing @resource: "{{name}}"',
-            noMatchingResource: 'No declared @resource matches `{{pattern}}`'
+            missingResource: 'Missing @resource: "{{name}}".',
+            noMatchingResource: 'No declared @resource matches `{{pattern}}`.'
         }
     },
 

package/src/rules/prefer-match.js

@@ -9,7 +9,7 @@ export default {
             recommended: true
         },
         schema: [],
-        messages: { preferMatch: 'Use @match instead of @include' }
+        messages: { preferMatch: 'Use @match instead of @include.' }
     },
 
     create(context) {

package/src/rules/require-blank-line-after-meta-block.js

@@ -8,7 +8,7 @@ export default {
         },
         fixable: 'whitespace',
         schema: [],
-        messages: { missingBlankLine: 'Missing blank line after metadata block' }
+        messages: { missingBlankLine: 'Missing blank line after metadata block.' }
     },
 
     create(context) {

package/src/rules/require-homepage-pair.js

@@ -10,7 +10,7 @@ export default {
         },
         fixable: 'code',
         schema: [],
-        messages: { missingPair: 'Missing @{{missing}} (required when @{{present}} is used)' }
+        messages: { missingPair: 'Missing @{{missing}} (required when @{{present}} is used).' }
     },
 
     create(context) {

package/src/rules/require-matching-localized-fields.js

@@ -4,7 +4,7 @@ export default {
     meta: {
         type: 'problem',
         docs: {
-            description: 'Require matching localized name and description fields',
+            description: 'Require matching localized @name and @description fields',
             category: 'Possible Errors',
             recommended: true
         },
@@ -22,12 +22,13 @@ export default {
             additionalProperties: false
         }],
         defaultOptions: [{}],
-        messages: { missingPair: 'Missing matching @{{missing}} for @{{present}}' }
+        messages: { missingPair: 'Missing matching @{{missing}} for @{{present}}.' }
     },
 
     create(context) {
         const options = context.options[0] || {},
-              ignoreLanguages = [options.ignoreLanguages ?? []].flat()
+              rawLangs = options.ignoreLanguages ?? [],
+              ignoreLangs = new Set(Array.isArray(rawLangs) ? rawLangs : [rawLangs])
         return {
             Program() {
                 const metaEntries = extractMetadata(context.sourceCode),
@@ -36,14 +37,14 @@ export default {
                       nameLangs = new Set(nameEntries.map(entry => entry.key.split(':')[1])),
                       descLangs = new Set(descEntries.map(entry => entry.key.split(':')[1]))
                 for (const lang of nameLangs)
-                    if (!ignoreLanguages.includes(lang) && !descLangs.has(lang))
+                    if (!ignoreLangs.has(lang) && !descLangs.has(lang))
                         context.report({
                             node: nameEntries.find(entry => entry.key == `name:${lang}`).comment,
                             messageId: 'missingPair',
                             data: { missing: `description:${lang}`, present: `name:${lang}` }
                         })
                 for (const lang of descLangs)
-                    if (!ignoreLanguages.includes(lang) && !nameLangs.has(lang))
+                    if (!ignoreLangs.has(lang) && !nameLangs.has(lang))
                         context.report({
                             node: descEntries.find(entry => entry.key == `description:${lang}`).comment,
                             messageId: 'missingPair',

package/src/rules/require-required-fields.js

@@ -24,7 +24,7 @@ export default {
             additionalProperties: false
         }],
         defaultOptions: [{}],
-        messages: { missingField: 'Missing required metadata field: @{{field}}' }
+        messages: { missingField: 'Missing required metadata field: @{{field}}.' }
     },
 
     create(context) {

package/src/rules/require-space-before-meta-key.js

@@ -12,7 +12,7 @@ export default {
         },
         fixable: 'whitespace',
         schema: [],
-        messages: { badPrefix: '`{{actual}}` should be `// @{{key}}`' }
+        messages: { badPrefix: '`{{actual}}` should be `// @{{key}}`.' }
     },
 
     create(context) {

package/src/rules/require-update-download-pair.js

@@ -9,7 +9,7 @@ export default {
             recommended: false
         },
         schema: [],
-        messages: { missingPair: 'Missing @{{missing}} (required when @{{present}} is used)' }
+        messages: { missingPair: 'Missing @{{missing}} (required when @{{present}} is used).' }
     },
 
     create(context) {

package/src/rules/require-user-js-filename.js

@@ -9,7 +9,7 @@ export default {
             recommended: true
         },
         schema: [],
-        messages: { requireUserJS: 'Userscript filename should end in ".user.js"' }
+        messages: { requireUserJS: 'Userscript filename should end in ".user.js".' }
     },
 
     create(context) {

package/src/rules/valid-field-values.js

@@ -42,17 +42,17 @@ export default {
         }],
         defaultOptions: [{}],
         messages: {
-            invalidVersion: 'Invalid @version: must be a valid {{versionType}} (expected format: {{example}})',
-            futureVersion: 'Invalid @version: date cannot be in the future',
-            invalidURL: 'Invalid URL for @{{field}}',
-            invalidGrant: 'Unknown @grant: "{{grant}}"'
+            invalidVersion: 'Invalid @version: must be a valid {{versionType}} (expected format: {{example}}).',
+            futureVersion: 'Invalid @version: date cannot be in the future.',
+            invalidURL: 'Invalid URL for @{{field}}.',
+            invalidGrant: 'Unknown @grant: "{{grant}}".'
         }
     },
 
     create(context) {
         const options = context.options[0] || {},
               versionType = options.versionType || 'semver',
-              allowedGrants = options.allowedGrants || [],
+              allowedGrants = new Set(options.allowedGrants || []),
               allowFutureDate = options.allowFutureDate ?? false,
               timezone = options.timezone,
               example = versionType == 'semver' ? '1.2.3' : 'YYYY.M.D or YYYY.MM.DD'
@@ -66,7 +66,7 @@ export default {
             Program() {
                 const metaEntries = extractMetadata(context.sourceCode)
                 for (const entry of metaEntries) {
-                    if (entry.key == 'grant' && allowedGrants.length && !allowedGrants.includes(entry.value))
+                    if (entry.key == 'grant' && allowedGrants.size && !allowedGrants.has(entry.value))
                         context.report({ node: entry.comment, messageId: 'invalidGrant', data: { grant: entry.value }})
                     else if (entry.key == 'resource') {
                         const url = entry.value.trim().split(re.whitespace)[1]

package/src/utils.js

@@ -1,5 +1,11 @@
 const re = { whitespace: /\s/ }
 
+export function bundleRules(rules, predicate, pluginName) {
+    return Object.fromEntries(Object.entries(rules)
+        .filter(([, rule]) => predicate(rule))
+        .map(([ruleId]) => [`${pluginName}/${ruleId}`, 'error']))
+}
+
 export function extractMetadata(sourceCode) {
     const comments = sourceCode.getAllComments(),
           metaEntries = []