@zgeoff/oxlint-config 0.2.13 → 0.3.0

package/README.md

@@ -11,8 +11,8 @@ the shared agent guidelines, `zgeoff/test-beside-module` keeps each test file be
 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,
 `zgeoff/no-abbreviated-names` reports each abbreviated value name it lists with its full word,
-`zgeoff/no-file-snapshot` bans file snapshots, and `zgeoff/setup-test-only` keeps a test file's
-module level to `setupTest()` and its tests.
+`zgeoff/no-file-snapshot` bans file snapshots, `zgeoff/setup-test-only` keeps a test file's module
+level to `setupTest()` and its tests, and `zgeoff/no-class` bans every class but a custom error.
 
 ## Usage
 
@@ -157,6 +157,15 @@ linted file that has a `__snapshots__/<file name>.snap` beside it, at the first
 file-level disable comment covers it. oxlint never visits a `.snap` file, so a snapshot file whose
 test file is gone is not reported.
 
+## `zgeoff/no-class`
+
+Objects come from factory functions, as the code-style skill requires, so the rule reports every
+class declaration and class expression, in test files too. A custom error stays a class, because
+`instanceof` checks and stack traces need one. The rule counts a class as a custom error when its
+`extends` clause holds `Error` or another name that ends in `Error`, bare or as a member such as
+`errors.BrewError`. It does not check the name of the class itself, and it reports a superclass
+reached through a computed member, such as `errors['BrewError']`.
+
 ## `zgeoff/import-zones`
 
 Off unless a repo configures it. The options name zones (path globs, relative to the repo root) and

package/no-class.js

@@ -0,0 +1,40 @@
+// a custom error stays a class, since `instanceof` checks and stack traces
+// need one: its superclass is `Error` or another name that ends in `Error`,
+// bare or as a member such as `errors.BrewError`
+const noClass = {
+  meta: {
+    type: 'problem',
+    messages: {
+      banned:
+        'Build this with a factory function (`create<X>` or `make<X>`), not a class. Only a custom error may be a class: `class XError extends Error`.',
+    },
+    schema: [],
+  },
+  create(context) {
+    const checkClass = (node) => {
+      if (!isCustomError(node)) {
+        context.report({ node, messageId: 'banned' });
+      }
+    };
+
+    return { ClassDeclaration: checkClass, ClassExpression: checkClass };
+  },
+};
+
+function isCustomError(node) {
+  return findSuperclassName(node.superClass)?.endsWith('Error') ?? false;
+}
+
+function findSuperclassName(superClass) {
+  if (superClass?.type === 'Identifier') {
+    return superClass.name;
+  }
+
+  if (superClass?.type === 'MemberExpression' && !superClass.computed) {
+    return superClass.property.name;
+  }
+
+  return null;
+}
+
+export default noClass;

package/oxlintrc.json

@@ -26,6 +26,7 @@
     "zgeoff/no-await-in-condition": "error",
     "zgeoff/no-await-in-logical": "error",
     "zgeoff/no-switch": "error",
+    "zgeoff/no-class": "error",
     "zgeoff/no-jsdoc": "error",
     "zgeoff/max-consecutive-line-comments": ["error", { "max": 3 }],
     "zgeoff/no-comment-rule-override": "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/oxlint-config",
-  "version": "0.2.13",
+  "version": "0.3.0",
   "description": "Shareable oxlint config: strict categories, house-style rules, and a custom JS plugin",
   "license": "MIT",
   "repository": {
@@ -15,6 +15,7 @@
     "no-restricted-words.js",
     "no-abbreviated-names.js",
     "max-consecutive-line-comments.js",
+    "no-class.js",
     "no-jsdoc.js",
     "no-comment-rule-override.js",
     "test-beside-module.js",

package/plugin.js

@@ -2,6 +2,7 @@ import functionVerb from './function-verb.js';
 import importZones from './import-zones.js';
 import maxConsecutiveLineComments from './max-consecutive-line-comments.js';
 import noAbbreviatedNames from './no-abbreviated-names.js';
+import noClass from './no-class.js';
 import noCommentRuleOverride from './no-comment-rule-override.js';
 import noFileSnapshot from './no-file-snapshot.js';
 import noJSDoc from './no-jsdoc.js';
@@ -104,6 +105,7 @@ const plugin = {
       'Branch with match(...).exhaustive() from ts-pattern, never switch.',
       ['SwitchStatement'],
     ),
+    'no-class': noClass,
     'no-jsdoc': noJSDoc,
     'max-consecutive-line-comments': maxConsecutiveLineComments,
     'no-comment-rule-override': noCommentRuleOverride,