@zgeoff/oxlint-config 0.2.1 → 0.2.3

package/README.md

@@ -5,10 +5,10 @@ restriction-rule cherry-picks, comment-style enforcement via `@stylistic`, and a
 (`zgeoff/*` rules) banning shapes no native oxlint rule can express — top-level arrows, nested
 function declarations, bare named exports, destructured and inline-typed parameters, ternary and
 await arguments, awaits hidden inside a control-flow condition or a `&&`/`||`/`??` chain, every
-JSDoc block, and any run of more than three line comments. `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, and `zgeoff/import-zones` fails an import that crosses a
-module boundary the repo declares.
+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, and
+`zgeoff/import-zones` fails an import that crosses a module boundary the repo declares.
 
 ## Usage
 
@@ -65,13 +65,9 @@ comments longer than `max` (default 3); tool directives (`oxlint-`, `eslint-`, `
 count nor join the prose around them. Neither rule fixes: a deleted comment is a decision, not a
 whitespace change.
 
-```jsonc
-{
-  "rules": {
-    "zgeoff/max-consecutive-line-comments": ["error", { "max": 3 }],
-  },
-}
-```
+Every repo runs both rules as this config ships them. `zgeoff/no-comment-rule-override` reports a
+repo-root `.oxlintrc*.json` that sets either rule, once per lint run, so a repo cannot turn them off
+or loosen `max`.
 
 ## `zgeoff/test-beside-module`
 

package/function-verb.js

@@ -25,6 +25,7 @@ const taxonomyVerbs = [
   'format',
   'render',
   'normalize',
+  'sanitize',
   'resolve',
   'expand',
   'compress',
@@ -33,18 +34,28 @@ const taxonomyVerbs = [
   'transform',
   'apply',
   'create',
+  'mint',
+  'open',
+  'dispose',
   'claim',
+  'release',
+  'revoke',
   'read',
   'load',
   'write',
   'remove',
   'update',
+  'refresh',
   'upsert',
   'set',
   'toggle',
   'reset',
+  'restore',
   'print',
+  'record',
   'run',
+  'spawn',
+  'schedule',
   'check',
   'try',
   'register',
@@ -60,6 +71,8 @@ const taxonomyVerbs = [
   'teardown',
   'start',
   'stop',
+  'restart',
+  'advance',
   'drain',
   'with',
   'make',

package/no-comment-rule-override.js

@@ -0,0 +1,74 @@
+import { readFileSync, readdirSync } from 'node:fs';
+import { join } from 'node:path';
+import findRepoRoot from './find-repo-root.js';
+
+// every repo runs the comment rules exactly as this config ships them
+const lockedRules = ['zgeoff/no-jsdoc', 'zgeoff/max-consecutive-line-comments'];
+
+const configPattern = /^\.oxlintrc(?:\.[\w-]+)?\.jsonc?$/u;
+
+// a rule key, as opposed to the same text inside a comment or a string value
+const keyPatterns = lockedRules.map((rule) => ({
+  rule,
+  pattern: new RegExp(`"${rule}"\\s*:`, 'u'),
+}));
+
+// the one file per repo that carries the report, so a repo with an override
+// sees it once per run rather than on every file, and an editor's language
+// server keeps it on that file across edits
+const anchorFiles = new Map();
+
+function buildCommentFreeText(text) {
+  return text.replaceAll(
+    /(?<string>"(?:\\.|[^"\\])*")|\/\/[^\n]*|\/\*[\s\S]*?\*\//gu,
+    (...match) => match.at(-1).string ?? '',
+  );
+}
+
+function loadOverrides(root) {
+  const configs = readdirSync(root).filter((name) => configPattern.test(name));
+
+  return configs.flatMap((name) => {
+    const text = buildCommentFreeText(readFileSync(join(root, name), 'utf8'));
+
+    return keyPatterns
+      .filter((entry) => entry.pattern.test(text))
+      .map((entry) => ({ config: name, rule: entry.rule }));
+  });
+}
+
+const noCommentRuleOverride = {
+  meta: {
+    type: 'problem',
+    messages: {
+      override:
+        '{{config}} sets {{rule}}. Delete the setting: every repo runs the comment rules as @zgeoff/oxlint-config ships them.',
+    },
+    schema: [],
+  },
+  create(context) {
+    const root = findRepoRoot(context.filename);
+
+    if (root === null) {
+      return {};
+    }
+
+    if (!anchorFiles.has(root)) {
+      anchorFiles.set(root, context.filename);
+    }
+
+    if (anchorFiles.get(root) !== context.filename) {
+      return {};
+    }
+
+    return {
+      Program(node) {
+        for (const override of loadOverrides(root)) {
+          context.report({ node, messageId: 'override', data: override });
+        }
+      },
+    };
+  },
+};
+
+export default noCommentRuleOverride;

package/oxlintrc.json

@@ -27,6 +27,7 @@
     "zgeoff/no-await-in-logical": "error",
     "zgeoff/no-jsdoc": "error",
     "zgeoff/max-consecutive-line-comments": ["error", { "max": 3 }],
+    "zgeoff/no-comment-rule-override": "error",
     "zgeoff/function-verb": "error",
     "zgeoff/test-beside-module": "error",
 
@@ -122,6 +123,27 @@
     // this config targets node/bun tooling — node builtins are the platform
     "import/no-nodejs-modules": "off",
 
+    // a file past 500 non-blank lines holds more than one concept, and a fifth
+    // parameter wants an options object
+    "max-lines": ["error", { "max": 500, "skipBlankLines": true }],
+    "max-params": ["error", { "max": 4 }],
+
+    // counts that fire on code already in its clearest form
+    "max-statements": "off",
+    "max-lines-per-function": "off",
+    "import/max-dependencies": "off",
+
+    // the fix reads worse than the code: tsc checks assignment before use, a
+    // guard `continue` is an early return, awaits in a loop keep order, and
+    // an event or timer needs a bare `new Promise`
+    "init-declarations": "off",
+    "no-continue": "off",
+    "no-await-in-loop": "off",
+    "promise/avoid-new": "off",
+
+    // a library or platform handle has no readonly form
+    "typescript/prefer-readonly-parameter-types": "off",
+
     // preload-style modules (matcher registration, type augmentation) are
     // side-effect imports by design
     "import/no-unassigned-import": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/oxlint-config",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Shareable oxlint config: strict categories, house-style rules, and a custom JS plugin",
   "license": "MIT",
   "repository": {
@@ -14,6 +14,7 @@
     "function-verb.js",
     "max-consecutive-line-comments.js",
     "no-jsdoc.js",
+    "no-comment-rule-override.js",
     "test-beside-module.js",
     "import-zones.js",
     "import-zones-schema.js",

package/plugin.js

@@ -1,6 +1,7 @@
 import functionVerb from './function-verb.js';
 import importZones from './import-zones.js';
 import maxConsecutiveLineComments from './max-consecutive-line-comments.js';
+import noCommentRuleOverride from './no-comment-rule-override.js';
 import noJSDoc from './no-jsdoc.js';
 import testBesideModule from './test-beside-module.js';
 
@@ -96,6 +97,7 @@ const plugin = {
     ),
     'no-jsdoc': noJSDoc,
     'max-consecutive-line-comments': maxConsecutiveLineComments,
+    'no-comment-rule-override': noCommentRuleOverride,
     'function-verb': functionVerb,
     'test-beside-module': testBesideModule,
     'import-zones': importZones,