eslint-plugin-greasemonkey 1.3.0 → 1.5.0

package/src/rules/valid-grants.js

@@ -1,12 +1,10 @@
 import { extractMetadata } from '../utils.js'
-import { gmLegacyAPIs, gmModernAPIs, scAPIs } from '../apis.js'
+import { allAPIs, supportsAPI } from '../data/apis.js'
 
-const specialGrants = new Set([
-    'none', 'unsafeWindow', 'window.close', 'window.focus', 'window.onurlchange'
-])
-
-const grants = new Set([...gmLegacyAPIs, ...gmModernAPIs, ...scAPIs, ...specialGrants]),
-      sortedGrants = new Map(Array.from(grants, grant => [grant.toLowerCase(), grant]))
+const managers = ['tampermonkey', 'violentmonkey', 'greasemonkey', 'scriptcat'],
+      specialGrants = new Set(['none', 'unsafeWindow', 'window.close', 'window.focus', 'window.onurlchange']),
+      allGrants = new Set([...allAPIs, ...specialGrants]),
+      sortedGrants = new Map(Array.from(allGrants, grant => [grant.toLowerCase(), grant]))
 
 export default {
     meta: {
@@ -19,9 +17,18 @@ export default {
         schema: [{
             type: 'object',
             properties: {
+                target: {
+                    anyOf: [
+                        { type: 'string', enum: ['all', ...managers] },
+                        { type: 'array', items: { type: 'string', enum: managers }, minItems: 1, uniqueItems: true }
+                    ],
+                    description: 'Manager(s) whose grants to validate against (default: all)'
+                },
                 allowedGrants: {
-                    type: 'array',
-                    items: { type: 'string' },
+                    anyOf: [
+                        { type: 'string' },
+                        { type: 'array', items: { type: 'string' }, minItems: 1, uniqueItems: true }
+                    ],
                     description: 'Additional @grant values to allow beyond the built-in list'
                 }
             },
@@ -30,25 +37,40 @@ export default {
         defaultOptions: [{}],
         messages: {
             invalidGrant: 'Invalid @grant: "{{grant}}"',
+            unsupportedGrant: '"@{{grant}}" is not supported by {{target}} (only by {{supporting}})',
             wrongCase: 'Invalid @grant: "{{grant}}" (did you mean "{{suggestion}}"?)'
         }
     },
 
     create(context) {
         const options = context.options[0] || {},
-              allowedGrants = options.allowedGrants || []
+              rawTarget = options.target ?? 'all',
+              targets = Array.isArray(rawTarget) ? rawTarget : [rawTarget],
+              allowedGrants = [options.allowedGrants ?? []].flat()
         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 (grants.has(grantName) || allowedGrants.includes(grantName)) continue
-                    const suggestion = sortedGrants.get(grantName.toLowerCase())
-                    context.report(suggestion
-                        ? { node: grant.comment, messageId: 'wrongCase', data: { grant: grantName, suggestion }}
-                        : { node: grant.comment, messageId: 'invalidGrant', data: { grant: grantName }}
-                    )
+                    if (specialGrants.has(grantName) || allowedGrants.includes(grantName)) continue
+                    if (!allGrants.has(grantName)) {
+                        const suggestion = sortedGrants.get(grantName.toLowerCase())
+                        if (suggestion && suggestion != grantName)
+                            context.report({ node: grant.comment, messageId: 'wrongCase',
+                                data: { grant: grantName, suggestion }})
+                        else
+                            context.report({ node: grant.comment, messageId: 'invalidGrant',
+                                data: { grant: grantName }})
+                        continue
+                    }
+                    if (!targets.includes('all')
+                        && !targets.some(manager => supportsAPI({ manager, api: grantName }))
+                    ) {
+                        const supporting = managers.filter(manager => supportsAPI({ manager, api: grantName }))
+                        context.report({ node: grant.comment, messageId: 'unsupportedGrant',
+                            data: { grant: grantName, target: targets.join(', '), supporting: supporting.join(', ') }})
+                    }
                 }
             }
         }