@shivaedev/quality 0.7.3 → 0.8.1

package/dist/rules/test-names/colocated.d.ts

@@ -0,0 +1,4 @@
+export declare const testsColocated: import("#rule.ts").Rule<"tests/colocated", {
+    readonly suites?: readonly string[];
+}>;
+//# sourceMappingURL=colocated.d.ts.map

package/dist/rules/test-names/colocated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colocated.d.ts","sourceRoot":"","sources":["../../../src/rules/test-names/colocated.ts"],"names":[],"mappings":"AAyBA,eAAO,MAAM,cAAc;;EAQzB,CAAC"}

package/dist/rules/test-names/colocated.js

@@ -0,0 +1,31 @@
+import { Effect, Schema } from "effect";
+import ignore from "ignore";
+import { testName } from "#naming/testName.ts";
+import { defineRule } from "#rule.ts";
+const MIRROR_FOLDERS = new Set(["__tests__", "spec", "test", "tests"]);
+const TestsColocatedOptions = Schema.Struct({
+    suites: Schema.Array(Schema.String).pipe(Schema.withDecodingDefaultKey(Effect.succeed([]))),
+});
+function findingOf(path) {
+    const name = testName(path);
+    const mirror = name?.folder.split("/").find((folder) => MIRROR_FOLDERS.has(folder));
+    if (name === undefined || mirror === undefined) {
+        return [];
+    }
+    return [
+        {
+            file: path,
+            message: `Sits in the test folder "${mirror}/". A test sits beside the file it covers, as ${name.stem}.test${name.extension} beside ${name.stem}.ts, or as a <behaviour>.spec${name.extension} in the folder it covers. A folder of tests that cover several packages is a suite in the "suites" option.`,
+        },
+    ];
+}
+export const testsColocated = defineRule({
+    check: ({ files, options }) => {
+        const suites = ignore().add([...options.suites]);
+        return files.filter((path) => !suites.ignores(path)).flatMap(findingOf);
+    },
+    description: "A test sits beside the code it covers, not in a test, tests, __tests__ or spec folder, unless that folder is a declared suite.",
+    id: "tests/colocated",
+    options: Schema.toStandardSchemaV1(TestsColocatedOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
+});
+//# sourceMappingURL=colocated.js.map

package/dist/rules/test-names/colocated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colocated.js","sourceRoot":"","sources":["../../../src/rules/test-names/colocated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAgB,MAAM,UAAU,CAAC;AAEpD,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE5F,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;CAC3F,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,IAAY;IAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACpF,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAChD,OAAO,EAAE,CAAC;IACX,CAAC;IACD,OAAO;QACN;YACC,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,4BAA4B,MAAM,iDAAiD,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,SAAS,WAAW,IAAI,CAAC,IAAI,gCAAgC,IAAI,CAAC,SAAS,4GAA4G;SACzS;KACD,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;IACxC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC;IACD,WAAW,EAAE,gIAAgI;IAC7I,EAAE,EAAE,iBAAiB;IACrB,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC;CACzH,CAAC,CAAC"}

package/dist/rules/test-names/follow.d.ts

@@ -0,0 +1,4 @@
+export declare const testsFollow: import("#rule.ts").Rule<"tests/follow", {
+    readonly suites?: readonly string[];
+}>;
+//# sourceMappingURL=follow.d.ts.map

package/dist/rules/test-names/follow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"follow.d.ts","sourceRoot":"","sources":["../../../src/rules/test-names/follow.ts"],"names":[],"mappings":"AAmEA,eAAO,MAAM,WAAW;;EAUtB,CAAC"}

package/dist/rules/test-names/follow.js

@@ -0,0 +1,66 @@
+import { posix } from "node:path";
+import { Effect, Schema } from "effect";
+import ignore from "ignore";
+import { ENVIRONMENTS, testName } from "#naming/testName.ts";
+import { CAMEL } from "#naming/words.ts";
+import { defineRule } from "#rule.ts";
+import { usesDom } from "#rules/test-names/usesDom.ts";
+const ENVIRONMENT_NAMES = new Set(ENVIRONMENTS);
+const FIXTURE_SUFFIXES = new Set(["integration", "postgres"]);
+const CODE = /\.[cm]?[jt]sx?$/u;
+const GRAMMAR = "A test file is <file>[.<environment>].test.ts beside its file or <behaviour>[.<environment>].spec.ts in the folder it covers, with at most one environment of dom, slow and typecheck.";
+const TestsFollowOptions = Schema.Struct({
+    suites: Schema.Array(Schema.String).pipe(Schema.withDecodingDefaultKey(Effect.succeed([]))),
+});
+function siblingsIn(files) {
+    return new Set(files.filter((file) => CODE.test(file) && testName(file) === undefined).map((file) => file.replace(CODE, "")));
+}
+function suffixMessage(file, name) {
+    const [first, ...rest] = name.modifiers;
+    if (first === undefined || (rest.length === 0 && ENVIRONMENT_NAMES.has(first))) {
+        return undefined;
+    }
+    const fixture = name.modifiers.find((modifier) => FIXTURE_SUFFIXES.has(modifier));
+    if (fixture !== undefined) {
+        return `".${fixture}" is not a test environment. A test that needs a database or a running app takes it from the app's test fixture and is named like any other test. ${GRAMMAR}`;
+    }
+    return `"${file}" has the suffixes ".${name.modifiers.join(".")}". ${GRAMMAR} An aspect of a module gets its own file in the module's folder, or a .spec.`;
+}
+function placeMessage(file, name, siblings) {
+    const covered = siblings.has(`${name.folder}/${name.stem}`);
+    if (name.kind === "test") {
+        return covered
+            ? undefined
+            : `"${file}" follows no file: ${name.stem}.test${name.extension} sits beside ${name.stem}.ts in the same folder. A test that covers the folder as a whole is a <behaviour>.spec${name.extension}, such as checkoutFlow.spec${name.extension}.`;
+    }
+    if (covered) {
+        return `"${file}" shares its name with ${name.stem}.ts. A .spec names a behaviour of its folder, such as checkoutFlow.spec${name.extension}; a test of ${name.stem}.ts is ${name.stem}.test${name.extension}.`;
+    }
+    return CAMEL.test(name.stem) ? undefined : `"${file}" names its behaviour in camelCase, such as checkoutFlow.spec${name.extension}.`;
+}
+function environmentMessage(file, name, source) {
+    if (name.modifiers.includes("dom") || name.modifiers.includes("typecheck") || !usesDom(source)) {
+        return undefined;
+    }
+    return `"${file}" uses the DOM, so it is ${name.stem}.dom.${name.kind}${name.extension} and runs in the dom project.`;
+}
+function findingsOf(source, siblings) {
+    const name = testName(source.path);
+    if (name === undefined) {
+        return [];
+    }
+    const file = posix.basename(source.path);
+    const messages = [suffixMessage(file, name), placeMessage(file, name, siblings), environmentMessage(file, name, source)];
+    return messages.flatMap((message) => (message === undefined ? [] : [{ file: source.path, message }]));
+}
+export const testsFollow = defineRule({
+    check: ({ files, options, sources }) => {
+        const suites = ignore().add([...options.suites]);
+        const siblings = siblingsIn(files);
+        return sources.filter((source) => !suites.ignores(source.path)).flatMap((source) => findingsOf(source, siblings));
+    },
+    description: "A .test file follows the file beside it, a .spec names a behaviour of its folder, the only suffix is one environment of dom, slow and typecheck, and a test that uses the DOM is a .dom test.",
+    id: "tests/follow",
+    options: Schema.toStandardSchemaV1(TestsFollowOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
+});
+//# sourceMappingURL=follow.js.map

package/dist/rules/test-names/follow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"follow.js","sourceRoot":"","sources":["../../../src/rules/test-names/follow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAiB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAiC,MAAM,UAAU,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAEvD,MAAM,iBAAiB,GAAwB,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;AAErE,MAAM,gBAAgB,GAAwB,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC;AAEnF,MAAM,IAAI,GAAG,kBAAkB,CAAC;AAEhC,MAAM,OAAO,GACZ,wLAAwL,CAAC;AAE1L,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;CAC3F,CAAC,CAAC;AAEH,SAAS,UAAU,CAAC,KAAwB;IAC3C,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAC/H,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,IAAc;IAClD,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;IACxC,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAChF,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,KAAK,OAAO,qJAAqJ,OAAO,EAAE,CAAC;IACnL,CAAC;IACD,OAAO,IAAI,IAAI,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,OAAO,8EAA8E,CAAC;AAC5J,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,IAAc,EAAE,QAA6B;IAChF,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5D,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1B,OAAO,OAAO;YACb,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,IAAI,IAAI,sBAAsB,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,SAAS,gBAAgB,IAAI,CAAC,IAAI,yFAAyF,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,GAAG,CAAC;IACjP,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,IAAI,0BAA0B,IAAI,CAAC,IAAI,0EAA0E,IAAI,CAAC,SAAS,eAAe,IAAI,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,SAAS,GAAG,CAAC;IAChN,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,gEAAgE,IAAI,CAAC,SAAS,GAAG,CAAC;AACtI,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY,EAAE,IAAc,EAAE,MAAkB;IAC3E,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChG,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,IAAI,IAAI,4BAA4B,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,+BAA+B,CAAC;AACvH,CAAC;AAED,SAAS,UAAU,CAAC,MAAkB,EAAE,QAA6B;IACpE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACX,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACzH,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACrC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE;QACtC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACnH,CAAC;IACD,WAAW,EACV,+LAA+L;IAChM,EAAE,EAAE,cAAc;IAClB,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC;CACtH,CAAC,CAAC"}

package/dist/rules/test-names/usesDom.d.ts

@@ -0,0 +1,3 @@
+import type { SourceFile } from "#rule.ts";
+export declare function usesDom(file: SourceFile): boolean;
+//# sourceMappingURL=usesDom.d.ts.map

package/dist/rules/test-names/usesDom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usesDom.d.ts","sourceRoot":"","sources":["../../../src/rules/test-names/usesDom.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAiB3C,wBAAgB,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAGjD"}

package/dist/rules/test-names/usesDom.js

@@ -0,0 +1,18 @@
+import ts from "typescript";
+import { parse } from "#rules/syntax.ts";
+const DOM_GLOBALS = new Set(["document", "window"]);
+const TESTING_LIBRARY = "@testing-library/";
+function touchesDom(node) {
+    if (ts.isImportDeclaration(node) && ts.isStringLiteral(node.moduleSpecifier)) {
+        return node.moduleSpecifier.text.startsWith(TESTING_LIBRARY);
+    }
+    if (ts.isPropertyAccessExpression(node) && ts.isIdentifier(node.expression) && DOM_GLOBALS.has(node.expression.text)) {
+        return true;
+    }
+    return ts.forEachChild(node, touchesDom) ?? false;
+}
+export function usesDom(file) {
+    const source = parse(file);
+    return source === undefined ? false : touchesDom(source);
+}
+//# sourceMappingURL=usesDom.js.map

package/dist/rules/test-names/usesDom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usesDom.js","sourceRoot":"","sources":["../../../src/rules/test-names/usesDom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEzE,MAAM,eAAe,GAAG,mBAAmB,CAAC;AAE5C,SAAS,UAAU,CAAC,IAAa;IAChC,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtH,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,KAAK,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAgB;IACvC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC"}

package/dist/vitest.d.ts

@@ -1,3 +1,5 @@
 import { type TestUserConfig } from "vitest/config";
-export declare function testProjects(): TestUserConfig;
+export declare function testProjects({ exclude }?: {
+    readonly exclude?: readonly string[];
+}): TestUserConfig;
 //# sourceMappingURL=vitest.d.ts.map

package/dist/vitest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vitest.d.ts","sourceRoot":"","sources":["../src/vitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAYpE,wBAAgB,YAAY,IAAI,cAAc,CAS7C"}
+{"version":3,"file":"vitest.d.ts","sourceRoot":"","sources":["../src/vitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAepE,wBAAgB,YAAY,CAAC,EAAE,OAAY,EAAE,GAAE;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAO,GAAG,cAAc,CAS5G"}

package/dist/vitest.js

@@ -1,19 +1,19 @@
 import { defaultExclude } from "vitest/config";
-const TEST = "**/*.test.?(c|m)[jt]s?(x)";
-const DOM = "**/*.dom.test.?(c|m)[jt]s?(x)";
-const SLOW = "**/*.slow.test.?(c|m)[jt]s?(x)";
-const TYPECHECK = "**/*.typecheck.test.?(c|m)[jt]s?(x)";
-const TYPECHECK_ALONE = "**/typecheck.test.?(c|m)[jt]s?(x)";
-function excluding(...patterns) {
-    return [...defaultExclude, TYPECHECK, TYPECHECK_ALONE, ...patterns];
+const EXTENSION = "?(c|m)[jt]s?(x)";
+const TYPECHECK_ALONE = `**/typecheck.test.${EXTENSION}`;
+function named(environment) {
+    return environment === undefined ? `**/*.@(test|spec).${EXTENSION}` : `**/*.${environment}.@(test|spec).${EXTENSION}`;
 }
-export function testProjects() {
+function excluding(exclude, ...patterns) {
+    return [...defaultExclude, named("typecheck"), TYPECHECK_ALONE, ...exclude, ...patterns];
+}
+export function testProjects({ exclude = [] } = {}) {
     return {
         project: ["unit", "dom"],
         projects: [
-            { extends: true, test: { environment: "node", exclude: excluding(DOM, SLOW), include: [TEST], name: "unit" } },
-            { extends: true, test: { environment: "happy-dom", exclude: excluding(SLOW), include: [DOM], name: "dom" } },
-            { extends: true, test: { environment: "node", exclude: excluding(), include: [SLOW], name: "slow" } },
+            { extends: true, test: { environment: "node", exclude: excluding(exclude, named("dom"), named("slow")), include: [named()], name: "unit" } },
+            { extends: true, test: { environment: "happy-dom", exclude: excluding(exclude, named("slow")), include: [named("dom")], name: "dom" } },
+            { extends: true, test: { environment: "node", exclude: excluding(exclude), include: [named("slow")], name: "slow" } },
         ],
     };
 }

package/dist/vitest.js.map

@@ -1 +1 @@
-{"version":3,"file":"vitest.js","sourceRoot":"","sources":["../src/vitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,MAAM,eAAe,CAAC;AAEpE,MAAM,IAAI,GAAG,2BAA2B,CAAC;AACzC,MAAM,GAAG,GAAG,+BAA+B,CAAC;AAC5C,MAAM,IAAI,GAAG,gCAAgC,CAAC;AAC9C,MAAM,SAAS,GAAG,qCAAqC,CAAC;AACxD,MAAM,eAAe,GAAG,mCAAmC,CAAC;AAE5D,SAAS,SAAS,CAAC,GAAG,QAA2B;IAChD,OAAO,CAAC,GAAG,cAAc,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,QAAQ,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,YAAY;IAC3B,OAAO;QACN,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;QACxB,QAAQ,EAAE;YACT,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;YAC9G,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YAC5G,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;SACrG;KACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"vitest.js","sourceRoot":"","sources":["../src/vitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,MAAM,eAAe,CAAC;AAGpE,MAAM,SAAS,GAAG,iBAAiB,CAAC;AAEpC,MAAM,eAAe,GAAG,qBAAqB,SAAS,EAAE,CAAC;AAEzD,SAAS,KAAK,CAAC,WAAyB;IACvC,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,SAAS,EAAE,CAAC,CAAC,CAAC,QAAQ,WAAW,iBAAiB,SAAS,EAAE,CAAC;AACvH,CAAC;AAED,SAAS,SAAS,CAAC,OAA0B,EAAE,GAAG,QAA2B;IAC5E,OAAO,CAAC,GAAG,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,EAAE,GAAG,QAAQ,CAAC,CAAC;AAC1F,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAE,OAAO,GAAG,EAAE,KAA+C,EAAE;IAC3F,OAAO;QACN,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;QACxB,QAAQ,EAAE;YACT,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;YAC5I,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACvI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;SACrH;KACD,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shivaedev/quality",
-  "version": "0.7.3",
+  "version": "0.8.1",
   "description": "Repository quality gate with typed rules, a baseline of existing debt and a registry of reasoned exceptions",
   "homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/quality#readme",
   "bugs": {

package/src/imports/graph.ts

@@ -4,8 +4,8 @@ import type { RuleInputs, SourceFile } from "#rule.ts";
 import { parse } from "#rules/syntax.ts";
 import { ambientModules } from "./ambient.ts";
 import { type ImportKind, type ImportRequest, importsOf } from "./extract.ts";
-import { projectsFor } from "./projects.ts";
-import { type Endpoint, isDeclarationFile, resolveImport } from "./resolve.ts";
+import { type Project, projectsFor } from "./projects.ts";
+import { type Endpoint, isDeclarationFile, presumedTarget, resolveImport } from "./resolve.ts";
 import { type WorkspacePackage, workspacePackages } from "./workspace.ts";
 
 export interface ImportEdge {
@@ -31,11 +31,15 @@ const QUERY = /\?.*$/u;
 const NO_MODULES =
 	"the import graph covers no modules: the sources hold no TypeScript or JavaScript module. Point `sources` at the code, or turn the imports rules off.";
 
-// A relative import of a missing file still names a path, so fences see it before its generator writes it.
-function missingTarget(from: string, request: ImportRequest): string | undefined {
+function relativeTarget(from: string, request: ImportRequest): string | undefined {
 	const relative = request.kind === "path-reference" || request.specifier.startsWith("./") || request.specifier.startsWith("../");
-	const target = posix.join(posix.dirname(from), request.specifier.replace(QUERY, ""));
-	return relative && !target.startsWith("../") ? target : undefined;
+	return relative ? posix.join(posix.dirname(from), request.specifier.replace(QUERY, "")) : undefined;
+}
+
+// A relative import or a package import of a missing file still names a path, so fences see it before its generator writes it.
+function missingTarget(root: string, from: string, request: ImportRequest, project: Project): string | undefined {
+	const target = presumedTarget(root, request, join(root, from), project) ?? relativeTarget(from, request);
+	return target === undefined || target.startsWith("../") ? undefined : target;
 }
 
 function walk(inputs: RuleInputs, root: string): Pick<ImportGraph, "edges" | "modules" | "unresolved"> {
@@ -52,7 +56,7 @@ function walk(inputs: RuleInputs, root: string): Pick<ImportGraph, "edges" | "mo
 		for (const request of importsOf(syntax, isDeclarationFile(file.path))) {
 			const to = resolveImport(root, ambient, request, path, project);
 			if (to === undefined) {
-				const missing = missingTarget(file.path, request);
+				const missing = missingTarget(root, file.path, request, project);
 				unresolved.push({ ...request, from: file.path, missing });
 				edges.push(...(missing === undefined ? [] : [{ ...request, from: file.path, to: { kind: "file" as const, path: missing } }]));
 			} else {

package/src/imports/resolve.ts

@@ -21,6 +21,16 @@ const DECLARATION = /\.d\.[cm]?ts$/u;
 
 const QUERY = /\?.*$/u;
 
+const PACKAGE_IMPORT = "#";
+
+const PACKAGE_JSON = "package.json";
+
+const presumingHost: ts.ModuleResolutionHost = {
+	...ts.sys,
+	directoryExists: () => true,
+	fileExists: (path) => !path.endsWith(`/${PACKAGE_JSON}`) || ts.sys.fileExists(path),
+};
+
 export function builtinName(specifier: string): string | undefined {
 	if (!isBuiltin(specifier)) {
 		return undefined;
@@ -90,6 +100,14 @@ function resolvedPath(request: ImportRequest, from: string, project: Project): s
 	return path === undefined ? undefined : fitting(path, request.type);
 }
 
+export function presumedTarget(root: string, request: ImportRequest, from: string, project: Project): string | undefined {
+	if (request.kind !== "import" || !request.specifier.startsWith(PACKAGE_IMPORT)) {
+		return undefined;
+	}
+	const path = ts.resolveModuleName(request.specifier.replace(QUERY, ""), from, project.options, presumingHost).resolvedModule?.resolvedFileName;
+	return path === undefined ? undefined : posix(relative(root, path));
+}
+
 function endpointAt(root: string, specifier: string, path: string): Endpoint {
 	const real = posix(realpathSync(path));
 	const installed = real.lastIndexOf(NODE_MODULES);

package/src/naming/exportFits.ts

@@ -0,0 +1,21 @@
+import { CAMEL, isUpper, PASCAL, sameWord, wordsOf } from "#naming/words.ts";
+
+function restIsFolders(rest: readonly string[], folders: readonly string[]): boolean {
+	const folderWords = folders.flatMap(wordsOf);
+	return rest.every((word) => folderWords.some((folder) => sameWord(word, folder)));
+}
+
+export function exportFits(name: string, stem: string, folders: readonly string[]): boolean {
+	if (!(CAMEL.test(stem) || PASCAL.test(stem)) || isUpper(stem) !== isUpper(name)) {
+		return false;
+	}
+	const named = wordsOf(name);
+	const filed = wordsOf(stem);
+	for (let start = 0; start + filed.length <= named.length; start += 1) {
+		const matches = filed.every((word, offset) => word === named[start + offset]);
+		if (matches && restIsFolders([...named.slice(0, start), ...named.slice(start + filed.length)], folders)) {
+			return true;
+		}
+	}
+	return false;
+}

package/src/naming/mainExport.ts

@@ -0,0 +1,11 @@
+import type { OwnExport } from "#naming/ownExports.ts";
+
+export function mainExport(exports: readonly OwnExport[]): OwnExport | undefined {
+	const values = exports.filter((entry) => entry.kind === "value");
+	const types = exports.filter((entry) => entry.kind === "type");
+	const [value] = values;
+	if (values.length === 1 && value !== undefined && types.every((type) => type.name.startsWith(value.name))) {
+		return value;
+	}
+	return values.length === 0 && types.length === 1 ? types[0] : undefined;
+}

package/src/naming/ownExports.ts

@@ -0,0 +1,95 @@
+import ts from "typescript";
+
+export interface OwnExport {
+	readonly constant: boolean;
+	readonly kind: "type" | "value";
+	readonly name: string;
+}
+
+const CONSTANT_CASE = /^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$/u;
+
+const PRIMITIVE_LITERALS: ReadonlySet<ts.SyntaxKind> = new Set([
+	ts.SyntaxKind.BigIntLiteral,
+	ts.SyntaxKind.FalseKeyword,
+	ts.SyntaxKind.NoSubstitutionTemplateLiteral,
+	ts.SyntaxKind.NumericLiteral,
+	ts.SyntaxKind.StringLiteral,
+	ts.SyntaxKind.TrueKeyword,
+]);
+
+function isPrimitiveLiteral(node: ts.Expression | undefined): boolean {
+	if (node === undefined) {
+		return false;
+	}
+	if (ts.isPrefixUnaryExpression(node)) {
+		return isPrimitiveLiteral(node.operand);
+	}
+	return PRIMITIVE_LITERALS.has(node.kind);
+}
+
+function isExported(statement: ts.Statement): boolean {
+	const modifiers = ts.canHaveModifiers(statement) ? ts.getModifiers(statement) : undefined;
+	const exported = modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword) ?? false;
+	const isDefault = modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.DefaultKeyword) ?? false;
+	return exported && !isDefault;
+}
+
+function variables(statement: ts.VariableStatement): readonly OwnExport[] {
+	const constant = (statement.declarationList.flags & ts.NodeFlags.Const) !== 0;
+	return statement.declarationList.declarations.flatMap((declaration) =>
+		ts.isIdentifier(declaration.name)
+			? [
+					{
+						constant: constant && (CONSTANT_CASE.test(declaration.name.text) || isPrimitiveLiteral(declaration.initializer)),
+						kind: "value" as const,
+						name: declaration.name.text,
+					},
+				]
+			: [],
+	);
+}
+
+function declared(statement: ts.Statement): readonly OwnExport[] {
+	if (ts.isVariableStatement(statement)) {
+		return variables(statement);
+	}
+	if (ts.isInterfaceDeclaration(statement) || ts.isTypeAliasDeclaration(statement)) {
+		return [{ constant: false, kind: "type", name: statement.name.text }];
+	}
+	const named =
+		ts.isFunctionDeclaration(statement) || ts.isClassDeclaration(statement) || ts.isEnumDeclaration(statement) || ts.isModuleDeclaration(statement)
+			? statement.name
+			: undefined;
+	return named !== undefined && ts.isIdentifier(named) ? [{ constant: false, kind: "value", name: named.text }] : [];
+}
+
+function locals(source: ts.SourceFile): ReadonlyMap<string, OwnExport> {
+	const all = source.statements.flatMap(declared);
+	return new Map(all.map((local) => [local.name, local]));
+}
+
+function listed(statement: ts.ExportDeclaration, known: ReadonlyMap<string, OwnExport>): readonly OwnExport[] {
+	const clause = statement.exportClause;
+	if (statement.moduleSpecifier !== undefined || clause === undefined || !ts.isNamedExports(clause)) {
+		return [];
+	}
+	return clause.elements.flatMap((element) => {
+		const name = element.name.text;
+		const local = known.get((element.propertyName ?? element.name).text);
+		if (name === "default" || local === undefined) {
+			return [];
+		}
+		const typeOnly = statement.isTypeOnly || element.isTypeOnly;
+		return [{ constant: local.constant, kind: typeOnly ? ("type" as const) : local.kind, name }];
+	});
+}
+
+export function ownExports(source: ts.SourceFile): readonly OwnExport[] {
+	const known = locals(source);
+	return source.statements.flatMap((statement) => {
+		if (ts.isExportDeclaration(statement)) {
+			return listed(statement, known);
+		}
+		return isExported(statement) ? declared(statement) : [];
+	});
+}

package/src/naming/packageLayout.ts

@@ -0,0 +1,75 @@
+import { posix } from "node:path";
+import type { RuleInputs } from "#rule.ts";
+
+export interface PackageLayout {
+	readonly foldersOf: (path: string) => readonly string[];
+	readonly names: ReadonlyMap<string, string>;
+	readonly scripts: ReadonlySet<string>;
+}
+
+const MANIFEST = "package.json";
+
+const SOURCE_FOLDER = "src";
+
+const RUNNABLE = /\.[cm]?[jt]sx?$/u;
+
+const BUILT = /^dist\/(?<entry>.+)\.[cm]?js$/u;
+
+function parsed(text: string | undefined): unknown {
+	if (text === undefined) {
+		return undefined;
+	}
+	try {
+		return JSON.parse(text);
+	} catch {
+		return undefined;
+	}
+}
+
+function field(value: unknown, key: string): unknown {
+	return typeof value === "object" && value !== null && key in value ? Reflect.get(value, key) : undefined;
+}
+
+function texts(value: unknown): readonly string[] {
+	if (typeof value === "string") {
+		return [value];
+	}
+	return typeof value === "object" && value !== null ? Object.values(value).filter((entry): entry is string => typeof entry === "string") : [];
+}
+
+function sourcesOf(target: string): readonly string[] {
+	const built = BUILT.exec(target)?.groups?.entry;
+	return built === undefined ? [target] : [target, `src/${built}.ts`, `src/${built}.tsx`];
+}
+
+function packageOf(path: string, roots: readonly string[]): string {
+	return roots.find((root) => root === "" || path.startsWith(`${root}/`)) ?? "";
+}
+
+function runBy(directory: string, manifest: unknown): readonly string[] {
+	const commands = texts(field(manifest, "scripts")).flatMap((command) => command.split(/\s+/u).filter((token) => RUNNABLE.test(token)));
+	const bins = texts(field(manifest, "bin")).flatMap(sourcesOf);
+	return [...commands, ...bins].map((target) => posix.join(directory, target));
+}
+
+export async function packageLayout({ files, readText }: Pick<RuleInputs, "files" | "readText">): Promise<PackageLayout> {
+	const directories = ["", ...files.filter((path) => posix.basename(path) === MANIFEST).map((path) => posix.dirname(path))];
+	const manifests = await Promise.all(
+		[...new Set(directories)].map(async (directory) => ({
+			directory: directory === "." ? "" : directory,
+			manifest: parsed(await readText(directory === "" ? MANIFEST : `${directory}/${MANIFEST}`)),
+		})),
+	);
+	const present = manifests.filter((entry) => entry.manifest !== undefined);
+	const roots = present.map((entry) => entry.directory).toSorted((left, right) => right.length - left.length);
+	const names = new Map(present.flatMap(({ directory, manifest }) => texts(field(manifest, "name")).map((name) => [directory, name] as const)));
+	return {
+		foldersOf: (path) => {
+			const root = packageOf(path, roots);
+			const folders = posix.dirname(root === "" ? path : path.slice(root.length + 1)).split("/");
+			return folders.filter((folder, index) => folder !== "." && !(index === 0 && folder === SOURCE_FOLDER));
+		},
+		names,
+		scripts: new Set(present.flatMap(({ directory, manifest }) => runBy(directory, manifest))),
+	};
+}

package/src/naming/testName.ts

@@ -0,0 +1,25 @@
+import { posix } from "node:path";
+
+export const ENVIRONMENTS = ["dom", "slow", "typecheck"] as const;
+
+export type Environment = (typeof ENVIRONMENTS)[number];
+
+export interface TestName {
+	readonly extension: string;
+	readonly folder: string;
+	readonly kind: "spec" | "test";
+	readonly modifiers: readonly string[];
+	readonly stem: string;
+}
+
+const TEST_FILE = /^(?<base>.+)\.(?<kind>test|spec)(?<extension>\.[cm]?[jt]sx?)$/u;
+
+export function testName(path: string): TestName | undefined {
+	const groups = TEST_FILE.exec(posix.basename(path))?.groups;
+	const kind = groups?.kind;
+	if (groups?.base === undefined || groups.extension === undefined || (kind !== "test" && kind !== "spec")) {
+		return undefined;
+	}
+	const [stem = "", ...modifiers] = groups.base.split(".");
+	return { extension: groups.extension, folder: posix.dirname(path), kind, modifiers, stem };
+}

package/src/naming/words.ts

@@ -0,0 +1,28 @@
+const WORD = /[A-Z]?[a-z0-9]+|[A-Z]+(?![a-z])/gu;
+
+export const KEBAB = /^[a-z0-9]+(?:-[a-z0-9]+)*$/u;
+
+export const CAMEL = /^[a-z][a-zA-Z0-9]*$/u;
+
+export const PASCAL = /^[A-Z][a-zA-Z0-9]*$/u;
+
+const UPPER_START = /^[A-Z]/u;
+
+export function wordsOf(name: string): readonly string[] {
+	return [...name.matchAll(WORD)].map((match) => match[0].toLowerCase());
+}
+
+export function singular(word: string): string {
+	if (word.endsWith("ies") && word.length > 3) {
+		return `${word.slice(0, -3)}y`;
+	}
+	return word.endsWith("s") && !word.endsWith("ss") && word.length > 1 ? word.slice(0, -1) : word;
+}
+
+export function sameWord(left: string, right: string): boolean {
+	return singular(left) === singular(right);
+}
+
+export function isUpper(text: string): boolean {
+	return UPPER_START.test(text);
+}

package/src/rules/built-in.ts

@@ -5,6 +5,9 @@ import { noJsdoc } from "#rules/comments/no-jsdoc.ts";
 import { noLineReference } from "#rules/comments/no-line-reference.ts";
 import { noPrReference } from "#rules/comments/no-pr-reference.ts";
 import { noTodo } from "#rules/comments/no-todo.ts";
+import { folderNames } from "#rules/files/folderNames.ts";
+import { namedAfterExport } from "#rules/files/namedAfterExport.ts";
+import { otherNames } from "#rules/files/otherNames.ts";
 import { importsAliased } from "#rules/imports/aliased.ts";
 import { importCycles } from "#rules/imports/cycles.ts";
 import { importFences } from "#rules/imports/fences.ts";
@@ -12,6 +15,8 @@ import { importsResolvable } from "#rules/imports/resolvable.ts";
 import { biomeOverrides } from "#rules/suppressions/biome-overrides.ts";
 import { noDoubleCast } from "#rules/suppressions/no-double-cast.ts";
 import { noInline } from "#rules/suppressions/no-inline.ts";
+import { testsColocated } from "#rules/test-names/colocated.ts";
+import { testsFollow } from "#rules/test-names/follow.ts";
 import { biome } from "./biome.ts";
 import { manifestsSorted } from "./manifests-sorted.ts";
 import { maxLines } from "./max-lines.ts";
@@ -34,4 +39,9 @@ export const builtInRules = [
 	importsResolvable,
 	importsAliased,
 	manifestsSorted,
+	namedAfterExport,
+	folderNames,
+	otherNames,
+	testsFollow,
+	testsColocated,
 ] as const;