@zgeoff/oxlint-config 0.2.7 → 0.2.8

package/README.md

@@ -8,7 +8,8 @@ await arguments, awaits hidden inside a control-flow condition or a `&&`/`||`/`?
 `switch` statement, every JSDoc block, any run of more than three line comments, and a repo config
 that loosens either comment rule. `zgeoff/function-verb` enforces the function-naming taxonomy from
 the shared agent guidelines, `zgeoff/test-beside-module` keeps each test file beside the module it
-tests, `zgeoff/import-zones` fails an import that crosses a module boundary the repo declares, and
+tests, `zgeoff/import-zones` fails an import that crosses a module boundary the repo declares,
+`zgeoff/no-restricted-words` keeps the words in its `words` option out of a path's text, and
 `zgeoff/no-file-snapshot` bans file snapshots.
 
 ## Usage
@@ -86,6 +87,25 @@ first statement, so put the comment above it:
 A second test file for a module (`<name>.host.test.ts`) needs its own `<name>.host.<ext>`, so the
 rule reports it beside only `<name>.ts`.
 
+## `zgeoff/no-restricted-words`
+
+Off unless a repo configures it. The `words` option lists the words to keep out of the text of a
+file: string literals, template text and comments. A word matches whole and without case, so `imp`
+reports `'IMP daemon'` and `'imp-e2e'` but not `'impl'` or `'imp_name'`. Identifiers are code, not
+text, and the rule never reads them. Scope the rule to a path with `overrides`, and turn it off for
+the paths that may name the words:
+
+```jsonc
+{
+  "rules": {
+    "zgeoff/no-restricted-words": ["error", { "words": ["imp", "impd"] }],
+  },
+  "overrides": [
+    { "files": ["packages/execution/**"], "rules": { "zgeoff/no-restricted-words": "off" } },
+  ],
+}
+```
+
 ## `zgeoff/no-file-snapshot`
 
 Snapshots are inline only, so the golden value sits in the test that pins it. The rule reports every

package/no-restricted-words.js

@@ -0,0 +1,61 @@
+const noRestrictedWords = {
+  meta: {
+    type: 'problem',
+    messages: {
+      restricted:
+        'Remove `{{word}}` from this {{place}}: the repo config restricts the word in this path.',
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          words: { type: 'array', items: { type: 'string', minLength: 1 }, uniqueItems: true },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create(context) {
+    const words = context.options[0]?.words ?? [];
+
+    if (words.length === 0) {
+      return {};
+    }
+
+    const pattern = buildWordPattern(words);
+
+    const checkText = (node, text, place) => {
+      for (const match of text.matchAll(pattern)) {
+        context.report({ node, messageId: 'restricted', data: { word: match[0], place } });
+      }
+    };
+
+    return {
+      Literal(node) {
+        if (typeof node.value === 'string') {
+          checkText(node, node.value, 'string');
+        }
+      },
+      TemplateElement(node) {
+        checkText(node, node.value.cooked ?? node.value.raw, 'template');
+      },
+      Program() {
+        for (const comment of context.sourceCode.getAllComments()) {
+          checkText(comment, comment.value, 'comment');
+        }
+      },
+    };
+  },
+};
+
+// a letter, digit or underscore on either side makes the match part of a
+// longer word (`impl`, `simple`), so only those characters bound it
+function buildWordPattern(words) {
+  const alternatives = words.map((word) =>
+    word.replaceAll(/[$()*+.?[\\\]^{|}]/gu, String.raw`\$&`),
+  );
+
+  return new RegExp(`(?<![\\p{L}\\p{N}_])(?:${alternatives.join('|')})(?![\\p{L}\\p{N}_])`, 'giu');
+}
+
+export default noRestrictedWords;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/oxlint-config",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Shareable oxlint config: strict categories, house-style rules, and a custom JS plugin",
   "license": "MIT",
   "repository": {
@@ -12,6 +12,7 @@
     "oxlintrc.json",
     "plugin.js",
     "function-verb.js",
+    "no-restricted-words.js",
     "max-consecutive-line-comments.js",
     "no-jsdoc.js",
     "no-comment-rule-override.js",

package/plugin.js

@@ -4,6 +4,7 @@ import maxConsecutiveLineComments from './max-consecutive-line-comments.js';
 import noCommentRuleOverride from './no-comment-rule-override.js';
 import noFileSnapshot from './no-file-snapshot.js';
 import noJSDoc from './no-jsdoc.js';
+import noRestrictedWords from './no-restricted-words.js';
 import testBesideModule from './test-beside-module.js';
 
 // custom rules loaded through oxlint's jsPlugins (ESLint v9 rule API): each
@@ -105,6 +106,7 @@ const plugin = {
     'max-consecutive-line-comments': maxConsecutiveLineComments,
     'no-comment-rule-override': noCommentRuleOverride,
     'function-verb': functionVerb,
+    'no-restricted-words': noRestrictedWords,
     'test-beside-module': testBesideModule,
     'no-file-snapshot': noFileSnapshot,
     'import-zones': importZones,