eslint-no-restricted 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Brad Zacher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# eslint-no-restricted
+
+An eslint utility for quickly and easily creating no-restricted-syntax rules.
+
+This utility is a more powerful alternative to the core rules [`no-restricted-syntax`](https://eslint.org/docs/latest/rules/no-restricted-syntax), [`no-restricted-globals`](https://eslint.org/docs/latest/rules/no-restricted-globals), and [`no-restricted-properties`](https://eslint.org/docs/latest/rules/no-restricted-properties).
+
+There are two major features you get with this utility over the core rules:
+
+(1) This utility creates one rule per selector/global/property, rather than having one rule for everything.
+Having multiple rules is useful for many reasons! It allows you to:
+
+- Configure each selector/global/property with a different severity
+- Easily enable or disable specific selector/global/property on specific files/folders
+- Ensure that one disable comment does not suppress multiple selector/global/property
+
+(2) This utility allows you to create messages with placeholders.
+This is powerful because it allows you to provide more targeted, less generic messages to provide a better and more understandable DevX.
+
+## Installation
+
+```sh
+npm i eslint-no-restricted
+```
+
+## Example Usage
+
+For brevity following example shows usage of the `no-restricted-syntax` utility - but the same API is available for the `globals` and `properties` variants too.
+
+```ts
+// eslint.config.mjs
+
+import createNoRestrictedSyntax from 'eslint-no-restricted/syntax';
+
+const noRestrictedSyntax = createNoRestrictedSyntax(
+  // define a single selector with a message
+  {
+    message: 'errors on identifiers named foo',
+    name: 'ban-the-name-foo',
+    selector: 'Identifier[name = "foo"]',
+  },
+
+  // define multiple selectors with the same message
+  {
+    message: 'errors on the string "bar"',
+    name: 'do-not-allow-the-string-bar',
+    selector: [
+      'Literal[value = "bar"]',
+      'TemplateLiteral[quasis.length = 1] > TemplateElement[value.cooked = "bar"]',
+    ],
+  },
+
+  // define one or more selectors with a placeholder derived from the matched node
+  {
+    message: 'this message has a placeholder ->{{placeholder}}<-',
+    messageData: (node, sourceCode) => {
+      if (node.parent?.type === 'VariableDeclarator') {
+        return {
+          placeholder: sourceCode.getText(node.parent.id),
+        };
+      }
+      return {
+        placeholder: 'wtf',
+      };
+    },
+    name: 'disallow-the-number-1',
+    selector: 'Literal[value = 1]',
+  },
+);
+
+export default [
+  // turn on all of the rules using the auto-generated configuration
+  noRestrictedSyntax.configs.recommended,
+
+  // you can also manually configure the rules
+  {
+    files: ['**/some-glob/*.js'],
+    plugins: {
+      nrs: noRestrictedSyntax,
+    },
+    rules: {
+      'nrs/disallow-the-number-1': 'off',
+    },
+  },
+];
+```

package/dist/globals.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from './shared';
+import * as shared from './shared';
+import type { TSESTree } from '@typescript-eslint/utils';
+declare namespace create {
+    interface RuleConfig extends shared.RuleBase<TSESTree.Identifier | TSESTree.JSXIdentifier> {
+        /**
+         * The global name to match
+         *
+         * You may pass multiple globals with an array for convenience rather than
+         * trying to merge multiple globals into one, or declaring the same message
+         * multiple times with different globals.
+         */
+        globalName: Array<string> | string;
+    }
+    type CreateFn = typeof create;
+}
+declare function create(...rules: Array<create.RuleConfig>): Plugin;
+export = create;

package/dist/globals.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+const shared = __importStar(require("./shared"));
+function createRule(config) {
+    return function create(context) {
+        const globalNames = Array.isArray(config.globalName)
+            ? config.globalName
+            : [config.globalName];
+        const sourceCode = context.sourceCode;
+        function reportReference(reference) {
+            context.report({
+                data: config.messageData == null
+                    ? {}
+                    : config.messageData(reference.identifier, sourceCode),
+                messageId: 'report',
+                node: reference.identifier,
+            });
+        }
+        return {
+            Program(node) {
+                const scope = sourceCode.getScope(node);
+                // Report variables declared elsewhere (ex: variables defined as "global" by eslint)
+                scope.variables.forEach(variable => {
+                    if (!variable.defs.length && globalNames.includes(variable.name)) {
+                        variable.references.forEach(reportReference);
+                    }
+                });
+                // Report variables not declared at all
+                scope.through.forEach(reference => {
+                    if (globalNames.includes(reference.identifier.name)) {
+                        reportReference(reference);
+                    }
+                });
+            },
+        };
+    };
+}
+function create(...rules) {
+    return shared.createPlugin('globals', rules, createRule);
+}
+module.exports = create;
+//# sourceMappingURL=globals.js.map

package/dist/globals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globals.js","sourceRoot":"","sources":["../src/globals.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,iDAAmC;AAkBnC,SAAS,UAAU,CAAC,MAAyB;IAC3C,OAAO,SAAS,MAAM,CAAC,OAAO;QAC5B,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;YAClD,CAAC,CAAC,MAAM,CAAC,UAAU;YACnB,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEtC,SAAS,eAAe,CAAC,SAAmC;YAC1D,OAAO,CAAC,MAAM,CAAC;gBACb,IAAI,EACF,MAAM,CAAC,WAAW,IAAI,IAAI;oBACxB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;gBAC1D,SAAS,EAAE,QAAQ;gBACnB,IAAI,EAAE,SAAS,CAAC,UAAU;aAC3B,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,OAAO,CAAC,IAAI;gBACV,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAExC,oFAAoF;gBACpF,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjE,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;oBAC/C,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,uCAAuC;gBACvC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;oBAChC,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;wBACpD,eAAe,CAAC,SAAS,CAAC,CAAC;oBAC7B,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,GAAG,KAA+B;IAChD,OAAO,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;AAC3D,CAAC;AAED,iBAAS,MAAM,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import globals = require('./globals.js');
+import properties = require('./properties.js');
+import syntax = require('./syntax.js');
+declare const exprt: {
+    createGlobals: globals.CreateFn;
+    createProperties: properties.CreateFn;
+    createSyntax: syntax.CreateFn;
+};
+export = exprt;

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+const globals = require("./globals.js");
+const properties = require("./properties.js");
+const syntax = require("./syntax.js");
+const exprt = {
+    createGlobals: globals,
+    createProperties: properties,
+    createSyntax: syntax,
+};
+module.exports = exprt;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,wCAAyC;AACzC,8CAA+C;AAC/C,sCAAuC;AAEvC,MAAM,KAAK,GAIP;IACF,aAAa,EAAE,OAAO;IACtB,gBAAgB,EAAE,UAAU;IAC5B,YAAY,EAAE,MAAM;CACrB,CAAC;AACF,iBAAS,KAAK,CAAC"}

package/dist/properties.d.ts

@@ -0,0 +1,30 @@
+import type { Plugin } from './shared';
+import * as shared from './shared';
+import type { TSESTree } from '@typescript-eslint/utils';
+declare namespace create {
+    interface RestrictedProperty {
+        /**
+         * The object name to ban from `object.property`. This is optional; if it is
+         * not provided then the `property` is disallowed for all objects.
+         */
+        object?: string;
+        /**
+         * The property name to ban from `object.property`.
+         * If `object` is not provided then this is disallowed for all objects.
+         */
+        property: string;
+    }
+    interface RuleConfig extends shared.RuleBase<TSESTree.MemberExpression | TSESTree.ObjectPattern> {
+        /**
+         * The properties name to match
+         *
+         * You may pass multiple properties with an array for convenience rather
+         * than trying to merge multiple properties into one, or declaring the same
+         * message multiple times with different properties.
+         */
+        property: Array<RestrictedProperty> | RestrictedProperty;
+    }
+    type CreateFn = typeof create;
+}
+declare function create(...rules: Array<create.RuleConfig>): Plugin;
+export = create;

package/dist/properties.js

@@ -0,0 +1,130 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+const shared = __importStar(require("./shared"));
+const utils_1 = require("@typescript-eslint/utils");
+function getStaticStringValue(node) {
+    switch (node.type) {
+        case utils_1.AST_NODE_TYPES.Literal:
+            if (node.value === null) {
+                if ('regex' in node) {
+                    return `/${node.regex.pattern}/${node.regex.flags}`;
+                }
+                if ('bigint' in node) {
+                    return node.bigint;
+                }
+                return 'null';
+            }
+            else {
+                return String(node.value);
+            }
+        case utils_1.AST_NODE_TYPES.TemplateLiteral:
+            if (node.expressions.length === 0 && node.quasis.length === 1) {
+                return node.quasis[0].value.cooked;
+            }
+            break;
+    }
+    return null;
+}
+function getStaticPropertyName(node) {
+    if (node?.type === utils_1.AST_NODE_TYPES.MemberExpression) {
+        if (node.property.type === utils_1.AST_NODE_TYPES.Identifier && !node.computed) {
+            return node.property.name;
+        }
+        return getStaticStringValue(node.property);
+    }
+    return null;
+}
+function createRule(config) {
+    return function create(context) {
+        const properties = Array.isArray(config.property)
+            ? config.property
+            : [config.property];
+        const sourceCode = context.sourceCode;
+        const restrictedProperties = new Map();
+        const globallyRestrictedProperties = new Set();
+        properties.forEach(option => {
+            const objectName = option.object;
+            const propertyName = option.property;
+            if (objectName == null) {
+                globallyRestrictedProperties.add(propertyName);
+            }
+            else {
+                if (!restrictedProperties.has(objectName)) {
+                    restrictedProperties.set(objectName, new Set());
+                }
+                restrictedProperties.get(objectName)?.add(propertyName);
+            }
+        });
+        /**
+         * Checks to see whether a property access is restricted, and reports it if so.
+         */
+        function checkPropertyAccess(node, objectName, propertyName) {
+            if (propertyName == null) {
+                return;
+            }
+            const matchedObject = objectName && restrictedProperties.get(objectName);
+            const matchedObjectProperty = matchedObject && matchedObject.has(propertyName);
+            const globalMatchedProperty = globallyRestrictedProperties.has(propertyName);
+            if (matchedObjectProperty || globalMatchedProperty) {
+                context.report({
+                    data: config.messageData == null
+                        ? {}
+                        : config.messageData(node, sourceCode),
+                    messageId: 'report',
+                    node,
+                });
+            }
+        }
+        return {
+            MemberExpression(node) {
+                checkPropertyAccess(node, node.object.type === utils_1.AST_NODE_TYPES.Identifier
+                    ? node.object.name
+                    : undefined, getStaticPropertyName(node));
+            },
+            ObjectPattern(node) {
+                let objectName = null;
+                if (node.parent.type === utils_1.AST_NODE_TYPES.VariableDeclarator) {
+                    if (node.parent.init?.type === utils_1.AST_NODE_TYPES.Identifier) {
+                        objectName = node.parent.init.name;
+                    }
+                }
+                else if (node.parent.type === utils_1.AST_NODE_TYPES.AssignmentExpression ||
+                    node.parent.type === utils_1.AST_NODE_TYPES.AssignmentPattern) {
+                    if (node.parent.right.type === utils_1.AST_NODE_TYPES.Identifier) {
+                        objectName = node.parent.right.name;
+                    }
+                }
+                node.properties.forEach(property => {
+                    checkPropertyAccess(node, objectName, getStaticPropertyName(property));
+                });
+            },
+        };
+    };
+}
+function create(...rules) {
+    return shared.createPlugin('globals', rules, createRule);
+}
+module.exports = create;
+//# sourceMappingURL=properties.js.map

package/dist/properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.js","sourceRoot":"","sources":["../src/properties.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,iDAAmC;AAEnC,oDAA0D;AA+B1D,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,sBAAc,CAAC,OAAO;YACzB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBACxB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACpB,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACtD,CAAC;gBACD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;oBACrB,OAAO,IAAI,CAAC,MAAM,CAAC;gBACrB,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;QAEH,KAAK,sBAAc,CAAC,eAAe;YACjC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;YACrC,CAAC;YACD,MAAM;IACV,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AACD,SAAS,qBAAqB,CAAC,IAA+B;IAC5D,IAAI,IAAI,EAAE,IAAI,KAAK,sBAAc,CAAC,gBAAgB,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvE,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC5B,CAAC;QAED,OAAO,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AACD,SAAS,UAAU,CAAC,MAAyB;IAC3C,OAAO,SAAS,MAAM,CAAC,OAAO;QAC5B,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC/C,CAAC,CAAC,MAAM,CAAC,QAAQ;YACjB,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEtC,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC5D,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAU,CAAC;QAEvD,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC1B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;YACjC,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;YAErC,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,4BAA4B,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACjD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1C,oBAAoB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBAClD,CAAC;gBAED,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,SAAS,mBAAmB,CAC1B,IAAwD,EACxD,UAAqC,EACrC,YAAuC;YAEvC,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,MAAM,aAAa,GAAG,UAAU,IAAI,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzE,MAAM,qBAAqB,GACzB,aAAa,IAAI,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACnD,MAAM,qBAAqB,GACzB,4BAA4B,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAEjD,IAAI,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;gBACnD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI,EACF,MAAM,CAAC,WAAW,IAAI,IAAI;wBACxB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC;oBAC1C,SAAS,EAAE,QAAQ;oBACnB,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO;YACL,gBAAgB,CAAC,IAAI;gBACnB,mBAAmB,CACjB,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;oBAC5C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI;oBAClB,CAAC,CAAC,SAAS,EACb,qBAAqB,CAAC,IAAI,CAAC,CAC5B,CAAC;YACJ,CAAC;YACD,aAAa,CAAC,IAAI;gBAChB,IAAI,UAAU,GAAkB,IAAI,CAAC;gBAErC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,kBAAkB,EAAE,CAAC;oBAC3D,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;wBACzD,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;oBACrC,CAAC;gBACH,CAAC;qBAAM,IACL,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,oBAAoB;oBACxD,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,iBAAiB,EACrD,CAAC;oBACD,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;wBACzD,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;oBACtC,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACjC,mBAAmB,CACjB,IAAI,EACJ,UAAU,EACV,qBAAqB,CAAC,QAAQ,CAAC,CAChC,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,GAAG,KAA+B;IAChD,OAAO,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;AAC3D,CAAC;AAED,iBAAS,MAAM,CAAC"}

package/dist/shared.d.ts

@@ -0,0 +1,39 @@
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+export interface WithLoc {
+    loc: TSESTree.SourceLocation;
+}
+export interface RuleBase<TNode> {
+    /**
+     * The level to use for the rule in the generated "recommended" config
+     * @default 'error'
+     */
+    defaultLevel?: 'error' | 'off' | 'warn';
+    /**
+     * A URL for more information
+     */
+    docUrl?: string;
+    /**
+     * The message to display when reporting the error. You may define
+     * placeholders in the message and use `messageData` to fill in the data for
+     * the report.
+     */
+    message: string;
+    /**
+     * An optional function that can be used to generate message placeholders
+     * {@link https://eslint.org/docs/latest/extend/custom-rules#using-message-placeholders}
+     */
+    messageData?(node: TNode, sourceCode: TSESLint.SourceCode): Record<string, number | string>;
+    /**
+     * The name of the rule -- must be a kebab-cased-name
+     */
+    name: string;
+}
+export interface Plugin {
+    configs: {
+        recommended: TSESLint.FlatConfig.Config;
+    };
+    meta: NonNullable<TSESLint.FlatConfig.Plugin['meta']>;
+    rules: NonNullable<TSESLint.FlatConfig.Plugin['rules']>;
+}
+export type RuleCreateFunction = TSESLint.RuleCreateFunction<'report', []>;
+export declare function createPlugin<TNode, TConfig extends RuleBase<TNode>>(pluginName: 'globals' | 'properties' | 'syntax', rules: Array<TConfig>, createRule: (config: TConfig) => RuleCreateFunction): Plugin;

package/dist/shared.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPlugin = createPlugin;
+const utils_1 = require("@typescript-eslint/utils");
+// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+const packageVersion = require('../package.json').version;
+function createPlugin(pluginName, rules, createRule) {
+    const pluginPrefix = `no-restricted-${pluginName}`;
+    const plugin = {
+        configs: {
+            recommended: {
+                name: `no-restricted-${pluginName}/recommended`,
+                plugins: {
+                // assigned below to maintain plugin referential equality
+                },
+                rules: Object.fromEntries(rules
+                    .filter(config => config.defaultLevel !== 'off')
+                    .map(config => [
+                    `${pluginPrefix}/${config.name}`,
+                    config.defaultLevel ?? 'error',
+                ])),
+            },
+        },
+        meta: {
+            name: `no-restricted-${pluginName}`,
+            version: packageVersion,
+        },
+        rules: Object.fromEntries(rules.map(config => {
+            if (config.message.includes('{{') &&
+                config.message.includes('}}') &&
+                !config.messageData) {
+                throw new Error(`Rule '${config.name}' defined a message with a {{placeholder}} but did not provide a \`messageData\` function.\nYou must provide a \`messageData\` function.`);
+            }
+            return [
+                config.name,
+                utils_1.ESLintUtils.RuleCreator.withoutDocs({
+                    create: createRule(config),
+                    defaultOptions: [],
+                    meta: {
+                        docs: {
+                            description: config.message,
+                            url: config.docUrl,
+                        },
+                        messages: {
+                            report: config.message,
+                        },
+                        schema: [],
+                        type: 'problem',
+                    },
+                }),
+            ];
+        })),
+    };
+    plugin.configs.recommended.plugins = {
+        [pluginPrefix]: plugin,
+    };
+    return plugin;
+}
+//# sourceMappingURL=shared.js.map

package/dist/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":";;AAiDA,oCAiEC;AAjHD,oDAAuD;AA2CvD,sHAAsH;AACtH,+GAA+G;AAC/G,MAAM,cAAc,GAAW,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;AAGlE,SAAgB,YAAY,CAC1B,UAA+C,EAC/C,KAAqB,EACrB,UAAmD;IAEnD,MAAM,YAAY,GAAG,iBAAiB,UAAU,EAAE,CAAC;IACnD,MAAM,MAAM,GAAG;QACb,OAAO,EAAE;YACP,WAAW,EAAE;gBACX,IAAI,EAAE,iBAAiB,UAAU,cAAc;gBAC/C,OAAO,EAAE;gBACP,yDAAyD;iBAC1D;gBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,KAAK;qBACF,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,KAAK,CAAC;qBAC/C,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACb,GAAG,YAAY,IAAI,MAAM,CAAC,IAAI,EAAE;oBAChC,MAAM,CAAC,YAAY,IAAI,OAAO;iBAC/B,CAAC,CACL;aACF;SACF;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,iBAAiB,UAAU,EAAE;YACnC,OAAO,EAAE,cAAc;SACxB;QACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACjB,IACE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC7B,CAAC,MAAM,CAAC,WAAW,EACnB,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,SAAS,MAAM,CAAC,IAAI,0IAA0I,CAC/J,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,MAAM,CAAC,IAAI;gBACX,mBAAW,CAAC,WAAW,CAAC,WAAW,CAAC;oBAClC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;oBAC1B,cAAc,EAAE,EAAE;oBAClB,IAAI,EAAE;wBACJ,IAAI,EAAE;4BACJ,WAAW,EAAE,MAAM,CAAC,OAAO;4BAC3B,GAAG,EAAE,MAAM,CAAC,MAAM;yBACnB;wBACD,QAAQ,EAAE;4BACR,MAAM,EAAE,MAAM,CAAC,OAAO;yBACvB;wBACD,MAAM,EAAE,EAAE;wBACV,IAAI,EAAE,SAAS;qBAChB;iBACF,CAAC;aACH,CAAC;QACJ,CAAC,CAAC,CACH;KACF,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,GAAG;QACnC,CAAC,YAAY,CAAC,EAAE,MAAM;KACvB,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/syntax.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from './shared';
+import * as shared from './shared';
+declare namespace create {
+    interface RuleConfig extends shared.RuleBase<unknown> {
+        /**
+         * The ESQuery selector to match
+         * {@link https://eslint.org/docs/latest/extend/selectors}
+         *
+         * You may pass multiple selectors with an array for convenience rather than
+         * trying to merge multiple selectors into one, or declaring the same message
+         * multiple times with slightly different selectors.
+         */
+        selector: Array<string> | string;
+    }
+    type CreateFn = typeof create;
+}
+declare function create(...rules: Array<create.RuleConfig>): Plugin;
+export = create;

package/dist/syntax.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+const shared = __importStar(require("./shared"));
+function createRule(config) {
+    return function create(context) {
+        const selectors = Array.isArray(config.selector)
+            ? config.selector
+            : [config.selector];
+        const sourceCode = context.sourceCode;
+        return Object.fromEntries(selectors.map(selector => [
+            selector,
+            (node) => {
+                context.report({
+                    data: config.messageData == null
+                        ? {}
+                        : config.messageData(node, sourceCode),
+                    loc: node.loc,
+                    messageId: 'report',
+                });
+            },
+        ]));
+    };
+}
+function create(...rules) {
+    return shared.createPlugin('syntax', rules, createRule);
+}
+module.exports = create;
+//# sourceMappingURL=syntax.js.map

package/dist/syntax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"syntax.js","sourceRoot":"","sources":["../src/syntax.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,iDAAmC;AAiBnC,SAAS,UAAU,CAAC,MAAyB;IAC3C,OAAO,SAAS,MAAM,CAAC,OAAO;QAC5B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC9C,CAAC,CAAC,MAAM,CAAC,QAAQ;YACjB,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEtC,OAAO,MAAM,CAAC,WAAW,CACvB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxB,QAAQ;YACR,CAAC,IAAa,EAAE,EAAE;gBAChB,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI,EACF,MAAM,CAAC,WAAW,IAAI,IAAI;wBACxB,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC;oBAC1C,GAAG,EAAE,IAAI,CAAC,GAAG;oBACb,SAAS,EAAE,QAAQ;iBACpB,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,GAAG,KAA+B;IAChD,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;AAC1D,CAAC;AAED,iBAAS,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "eslint-no-restricted",
+  "version": "0.0.4",
+  "keywords": [
+    "eslint"
+  ],
+  "homepage": "https://github.com/bradzacher/eslint-no-restricted",
+  "bugs": {
+    "url": "https://github.com/bradzacher/eslint-no-restricted/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bradzacher/eslint-no-restricted.git"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://github.com/sponsors/bradzacher/"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Brad Zacher <brad.zacher@gmail.com>"
+  ],
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./globals": {
+      "types": "./dist/globals.d.ts",
+      "default": "./dist/globals.js"
+    },
+    "./properties": {
+      "types": "./dist/properties.d.ts",
+      "default": "./dist/properties.js"
+    },
+    "./syntax": {
+      "types": "./dist/syntax.d.ts",
+      "default": "./dist/syntax.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rimraf dist .build.tsbuildinfo && tsc --project tsconfig.build.json",
+    "ci": "pnpm run build && pnpm run typecheck && pnpm run lint && pnpm run lint:knip && pnpm run lint:format && pnpm run lint:spelling",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "lint:attw": "attw",
+    "lint:format": "prettier --check .",
+    "lint:knip": "knip",
+    "lint:spelling": "cspell --config=.cspell.json \"**/*.{md,mdx,ts,mts,cts,js,cjs,mjs,tsx,jsx}\" --no-progress --show-context --show-suggestions",
+    "test": "vitest",
+    "typecheck": "tsc --project tsconfig.build.json --noEmit && tsc --project tsconfig.tools.json --noEmit && tsc --project tsconfig.test.json --noEmit"
+  },
+  "dependencies": {
+    "@arethetypeswrong/cli": "^0.16.4",
+    "@typescript-eslint/utils": "^8.13.0"
+  },
+  "devDependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "@eslint/js": "^9.14.0",
+    "@tsconfig/node20": "^20",
+    "@types/node": "^20",
+    "cspell": "^8.15.7",
+    "eslint": "^9.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsonc": "^2.16.0",
+    "eslint-plugin-markdown": "^5.1.0",
+    "eslint-plugin-n": "^17.12.0",
+    "eslint-plugin-package-json": "^0.15.4",
+    "eslint-plugin-perfectionist": "^3.9.1",
+    "eslint-plugin-regexp": "^2.6.0",
+    "eslint-plugin-yml": "^1.15.0",
+    "knip": "^5.36.2",
+    "prettier": "^3.3.3",
+    "prettier-plugin-curly": "^0.3.1",
+    "prettier-plugin-packagejson": "^2.5.3",
+    "prettier-plugin-sh": "^0.14.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.13.0",
+    "vitest": "^2.1.4"
+  },
+  "peerDependencies": {
+    "eslint": "^8.57.0 || ^9"
+  },
+  "engines": {
+    "node": "^20.18.0 || >=22.0.0"
+  }
+}