@zgeoff/oxlint-config 0.1.0 → 0.2.0

package/README.md

@@ -6,7 +6,8 @@ restriction-rule cherry-picks, comment-style enforcement via `@stylistic`, and a
 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.
+function-naming taxonomy from the shared agent guidelines, and `zgeoff/test-beside-module` keeps
+each test file beside the module it tests.
 
 ## Usage
 
@@ -71,6 +72,22 @@ whitespace change.
 }
 ```
 
+## `zgeoff/test-beside-module`
+
+A `<name>.test.ts` or `<name>.test.tsx` file needs a non-test file `<name>.<ext>` in the same
+directory — `.ts`, `.tsx`, `.sh`, `.json`, or any other single extension, so `install.test.ts` may
+test `install.sh`. Files under an `e2e/` or `evals/` directory at the repo root (the nearest
+ancestor holding `.git`, else oxlint's working directory) are exempt; no other directory is. Exempt
+any other test with a file-level disable comment that states the reason. The rule reports at the
+first statement, so put the comment above it:
+
+```ts
+// oxlint-disable zgeoff/test-beside-module -- tests base.json and react.json together
+```
+
+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`.
+
 ## Notes
 
 - The config enables the `typescript`, `unicorn`, `oxc`, `import`, and `promise` plugins and loads

package/oxlintrc.json

@@ -28,6 +28,7 @@
     "zgeoff/no-jsdoc": "error",
     "zgeoff/max-consecutive-line-comments": ["error", { "max": 3 }],
     "zgeoff/function-verb": "error",
+    "zgeoff/test-beside-module": "error",
 
     // enforced comment style — line comments unless JSDoc or exclamation
     "@stylistic/multiline-comment-style": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/oxlint-config",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "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",
+    "test-beside-module.js",
     "index.js"
   ],
   "type": "module",

package/plugin.js

@@ -1,6 +1,7 @@
 import functionVerb from './function-verb.js';
 import maxConsecutiveLineComments from './max-consecutive-line-comments.js';
 import noJSDoc from './no-jsdoc.js';
+import testBesideModule from './test-beside-module.js';
 
 // custom rules loaded through oxlint's jsPlugins (ESLint v9 rule API): each
 // bans a shape no native oxlint rule can express, as an esquery selector or a
@@ -95,6 +96,7 @@ const plugin = {
     'no-jsdoc': noJSDoc,
     'max-consecutive-line-comments': maxConsecutiveLineComments,
     'function-verb': functionVerb,
+    'test-beside-module': testBesideModule,
   },
 };
 

package/test-beside-module.js

@@ -0,0 +1,93 @@
+import { existsSync, readdirSync, statSync } from 'node:fs';
+import { basename, dirname, join, relative, sep } from 'node:path';
+
+const testFilePattern = /^(?<base>.+)\.test\.tsx?$/u;
+
+// suites that run the whole program have no single module to sit beside
+const exemptRootDirs = new Set(['e2e', 'evals']);
+
+function isUnderExemptRoot(cwd, filename) {
+  const [first] = relative(findRepoRoot(filename) ?? cwd, filename).split(sep);
+
+  return exemptRootDirs.has(first);
+}
+
+// the repo root, not oxlint's working directory, so a per-package lint
+// script neither exempts a package's own e2e/ nor flags the root one
+function findRepoRoot(filename) {
+  let dir = dirname(filename);
+
+  while (!existsSync(join(dir, '.git'))) {
+    const parent = dirname(dir);
+
+    if (parent === dir) {
+      return null;
+    }
+
+    dir = parent;
+  }
+
+  return dir;
+}
+
+// a module is `<name>.<ext>` with a single-segment extension, so a
+// declaration file never stands in for one, and neither does another test
+// (`foo.test.ts` beside `foo.test.test.ts`)
+function hasModuleSibling(dir, name) {
+  return readdirSync(dir).some((entry) => {
+    const dot = entry.lastIndexOf('.');
+
+    return (
+      dot > 0 &&
+      entry.slice(0, dot) === name &&
+      !testFilePattern.test(entry) &&
+      isFile(join(dir, entry))
+    );
+  });
+}
+
+// follows a symlink, so a linked module counts as the file it points at
+function isFile(path) {
+  return statSync(path, { throwIfNoEntry: false })?.isFile() ?? false;
+}
+
+const testBesideModule = {
+  meta: {
+    type: 'problem',
+    messages: {
+      missing:
+        'Move this test beside the module it tests: no `{{name}}.<ext>` sits in this directory. Whole-program suites belong in a root `e2e/` or `evals/` directory.',
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      Program() {
+        const filename = context.physicalFilename;
+        const match = testFilePattern.exec(basename(filename));
+
+        if (match === null || isUnderExemptRoot(context.cwd, filename)) {
+          return;
+        }
+
+        const name = match.groups.base;
+
+        if (hasModuleSibling(dirname(filename), name)) {
+          return;
+        }
+
+        // anchor on the first statement, not offset 0, so a disable comment
+        // at the top of the file sits before the report and covers it
+        const start = context.sourceCode.ast.body[0]?.loc.start ?? { line: 1, column: 0 };
+
+        context.report({
+          loc: { start, end: start },
+          messageId: 'missing',
+          data: { name },
+        });
+      },
+    };
+  },
+};
+
+export default testBesideModule;