@shivaedev/quality 0.68.0 → 0.69.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +20 -4
- package/dist/adapters/biome/withExceptionConfig.d.ts.map +1 -1
- package/dist/adapters/biome/withExceptionConfig.js +9 -3
- package/dist/adapters/biome/withExceptionConfig.js.map +1 -1
- package/dist/adapters/browserLibraryType.d.ts +3 -0
- package/dist/adapters/browserLibraryType.d.ts.map +1 -0
- package/dist/adapters/browserLibraryType.js +9 -0
- package/dist/adapters/browserLibraryType.js.map +1 -0
- package/dist/adapters/knip/configuration.d.ts.map +1 -1
- package/dist/adapters/knip/configuration.js +3 -1
- package/dist/adapters/knip/configuration.js.map +1 -1
- package/dist/adapters/knip/mockEntries.d.ts +3 -0
- package/dist/adapters/knip/mockEntries.d.ts.map +1 -0
- package/dist/adapters/knip/mockEntries.js +28 -0
- package/dist/adapters/knip/mockEntries.js.map +1 -0
- package/dist/adapters/outsideImportFindings.js +1 -1
- package/dist/adapters/outsideImportFindings.js.map +1 -1
- package/dist/adapters/reachableBuildEntries.d.ts.map +1 -1
- package/dist/adapters/reachableBuildEntries.js +2 -1
- package/dist/adapters/reachableBuildEntries.js.map +1 -1
- package/dist/adapters/spawnedEntries.d.ts +3 -0
- package/dist/adapters/spawnedEntries.d.ts.map +1 -0
- package/dist/adapters/spawnedEntries.js +36 -0
- package/dist/adapters/spawnedEntries.js.map +1 -0
- package/dist/inventory/programmaticEntries.d.ts.map +1 -1
- package/dist/inventory/programmaticEntries.js +3 -1
- package/dist/inventory/programmaticEntries.js.map +1 -1
- package/dist/rules/biome.d.ts.map +1 -1
- package/dist/rules/biome.js +3 -0
- package/dist/rules/biome.js.map +1 -1
- package/dist/rules/effect/failureFindings.d.ts.map +1 -1
- package/dist/rules/effect/failureFindings.js +5 -2
- package/dist/rules/effect/failureFindings.js.map +1 -1
- package/dist/rules/effect/failureHonesty.js +1 -1
- package/dist/rules/effect/failureHonesty.js.map +1 -1
- package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
- package/dist/rules/effect/serviceTypes.js +2 -0
- package/dist/rules/effect/serviceTypes.js.map +1 -1
- package/dist/rules/exportImportFindings.d.ts +3 -0
- package/dist/rules/exportImportFindings.d.ts.map +1 -0
- package/dist/rules/exportImportFindings.js +40 -0
- package/dist/rules/exportImportFindings.js.map +1 -0
- package/dist/rules/files/folderNames.d.ts.map +1 -1
- package/dist/rules/files/folderNames.js +14 -6
- package/dist/rules/files/folderNames.js.map +1 -1
- package/dist/rules/manifestsExportsShape.d.ts.map +1 -1
- package/dist/rules/manifestsExportsShape.js +12 -26
- package/dist/rules/manifestsExportsShape.js.map +1 -1
- package/package.json +3 -3
- package/src/adapters/biome/withExceptionConfig.ts +9 -3
- package/src/adapters/browserLibraryType.ts +14 -0
- package/src/adapters/knip/configuration.ts +3 -1
- package/src/adapters/knip/mockEntries.ts +31 -0
- package/src/adapters/outsideImportFindings.ts +1 -1
- package/src/adapters/reachableBuildEntries.ts +2 -1
- package/src/adapters/spawnedEntries.ts +39 -0
- package/src/inventory/programmaticEntries.ts +3 -1
- package/src/rules/biome.ts +3 -0
- package/src/rules/effect/failureFindings.ts +6 -2
- package/src/rules/effect/failureHonesty.ts +1 -1
- package/src/rules/effect/serviceTypes.ts +2 -0
- package/src/rules/exportImportFindings.ts +44 -0
- package/src/rules/files/folderNames.ts +14 -6
- package/src/rules/manifestsExportsShape.ts +12 -28
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exportImportFindings.d.ts","sourceRoot":"","sources":["../../src/rules/exportImportFindings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAkBxC,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM,EAAE,SAAS,UAAQ,GAAG,SAAS,OAAO,EAAE,CAyBzI"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
function sourceImport(value) {
|
|
2
|
+
if (value === "./src/*.ts") {
|
|
3
|
+
return true;
|
|
4
|
+
}
|
|
5
|
+
if (typeof value !== "object" || value === null || Array.isArray(value)) {
|
|
6
|
+
return false;
|
|
7
|
+
}
|
|
8
|
+
const source = "@shivaedev/source" in value ? "@shivaedev/source" : "source";
|
|
9
|
+
const conditions = { default: "./dist/*.js", [source]: "./src/*.ts", types: "./dist/*.d.ts" };
|
|
10
|
+
return Object.keys(value).length === 3 && Object.entries(conditions).every(([key, target]) => Reflect.get(value, key) === target);
|
|
11
|
+
}
|
|
12
|
+
function localTestTree(value) {
|
|
13
|
+
return typeof value === "string" && /^\.\/(?:test|tests|test-support)\/(?:[^*\\]+\/)?\*$/u.test(value) && !value.split("/").includes("..");
|
|
14
|
+
}
|
|
15
|
+
export function exportImportFindings(file, imports = {}, isPrivate = false) {
|
|
16
|
+
return Object.entries(imports).flatMap(([key, value]) => {
|
|
17
|
+
if (key === "#*.ts" && !sourceImport(value)) {
|
|
18
|
+
return [
|
|
19
|
+
{
|
|
20
|
+
file,
|
|
21
|
+
message: 'Import "#*.ts" must preserve the path from the source root. Map it to "./src/*.ts", or to source "./src/*.ts", types "./dist/*.d.ts" and default "./dist/*.js". Include subfolders in import specifiers, for example "#server/module.ts".',
|
|
22
|
+
subject: key,
|
|
23
|
+
},
|
|
24
|
+
];
|
|
25
|
+
}
|
|
26
|
+
if (key === "#test/*" && value !== "./src/test-support/*" && !(isPrivate && localTestTree(value))) {
|
|
27
|
+
return [
|
|
28
|
+
{
|
|
29
|
+
file,
|
|
30
|
+
message: isPrivate
|
|
31
|
+
? 'Import "#test/*" must map to "./src/test-support/*" or the package’s own test/, tests/ or test-support/ tree.'
|
|
32
|
+
: 'Import "#test/*" must map to "./src/test-support/*". Keep test helpers under the source root’s test-support folder.',
|
|
33
|
+
subject: key,
|
|
34
|
+
},
|
|
35
|
+
];
|
|
36
|
+
}
|
|
37
|
+
return [];
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=exportImportFindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exportImportFindings.js","sourceRoot":"","sources":["../../src/rules/exportImportFindings.ts"],"names":[],"mappings":"AAEA,SAAS,YAAY,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzE,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAG,mBAAmB,IAAI,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC7E,MAAM,UAAU,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;IAC9F,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,CAAC;AACnI,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,sDAAsD,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC5I,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,OAAO,GAAsC,EAAE,EAAE,SAAS,GAAG,KAAK;IACpH,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACvD,IAAI,GAAG,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACN;oBACC,IAAI;oBACJ,OAAO,EACN,2OAA2O;oBAC5O,OAAO,EAAE,GAAG;iBACZ;aACD,CAAC;QACH,CAAC;QACD,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,KAAK,sBAAsB,IAAI,CAAC,CAAC,SAAS,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACnG,OAAO;gBACN;oBACC,IAAI;oBACJ,OAAO,EAAE,SAAS;wBACjB,CAAC,CAAC,+GAA+G;wBACjH,CAAC,CAAC,qHAAqH;oBACxH,OAAO,EAAE,GAAG;iBACZ;aACD,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folderNames.d.ts","sourceRoot":"","sources":["../../../src/rules/files/folderNames.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"folderNames.d.ts","sourceRoot":"","sources":["../../../src/rules/files/folderNames.ts"],"names":[],"mappings":"AAyFA,eAAO,MAAM,WAAW;;;;;;;;;mCAsBtB,CAAC"}
|
|
@@ -5,7 +5,7 @@ import { GlobDeclarations, globPatterns, validateGlobs } from "#config/globs.ts"
|
|
|
5
5
|
import { routeFiles } from "#inventory/routeFiles.ts";
|
|
6
6
|
import { nativeNames } from "#naming/nativeNames.ts";
|
|
7
7
|
import { packageLayout } from "#naming/packageLayout.ts";
|
|
8
|
-
import { KEBAB, PASCAL } from "#naming/words.ts";
|
|
8
|
+
import { KEBAB, PASCAL, sameWord } from "#naming/words.ts";
|
|
9
9
|
import { defineRule } from "#rule.ts";
|
|
10
10
|
const SNAKE = /^[a-z0-9]+(?:_[a-z0-9]+)*$/u;
|
|
11
11
|
const CODE = /\.[cm]?[jt]sx?$/u;
|
|
@@ -31,10 +31,15 @@ function isModule(folder, stems) {
|
|
|
31
31
|
}
|
|
32
32
|
function packageMessage(folder, packageName) {
|
|
33
33
|
const expected = packageName.replace(/^@[^/]+\//u, "");
|
|
34
|
-
const
|
|
35
|
-
|
|
34
|
+
const segments = folder.split("/");
|
|
35
|
+
const matches = segments.some((_, start) => {
|
|
36
|
+
const tail = segments.slice(start).join("-").split("-");
|
|
37
|
+
const name = expected.split("-");
|
|
38
|
+
return tail.length === name.length && tail.every((word, index) => sameWord(word, name[index] ?? ""));
|
|
39
|
+
});
|
|
40
|
+
return matches
|
|
36
41
|
? undefined
|
|
37
|
-
: `The folder of the package ${packageName} must
|
|
42
|
+
: `The folder of the package ${packageName} must match a trailing run of its folder path joined with "-" as "${expected}", with each segment singular or plural.`;
|
|
38
43
|
}
|
|
39
44
|
function groupMessage(name) {
|
|
40
45
|
if (PASCAL.test(name)) {
|
|
@@ -49,13 +54,16 @@ function messageFor(folder, context) {
|
|
|
49
54
|
if (name === "internal") {
|
|
50
55
|
return 'A folder named "internal" implies privacy that export maps do not enforce. Move its files into the parent folder or a folder named after their job.';
|
|
51
56
|
}
|
|
52
|
-
if (context.owned.has(folder) || context.toolOwned.ignores(`${folder}/`)
|
|
57
|
+
if (context.owned.has(folder) || context.toolOwned.ignores(`${folder}/`)) {
|
|
53
58
|
return undefined;
|
|
54
59
|
}
|
|
55
60
|
const packageName = context.names.get(folder);
|
|
56
61
|
if (packageName !== undefined) {
|
|
57
62
|
return packageMessage(folder, packageName);
|
|
58
63
|
}
|
|
64
|
+
if (isModule(folder, context.stems)) {
|
|
65
|
+
return undefined;
|
|
66
|
+
}
|
|
59
67
|
if (context.content.ignores(`${folder}/`)) {
|
|
60
68
|
return SNAKE.test(name) ? undefined : `"${name}" holds content, so it is named in snake_case, such as forest_path/.`;
|
|
61
69
|
}
|
|
@@ -77,7 +85,7 @@ export const folderNames = defineRule({
|
|
|
77
85
|
return message === undefined ? [] : [{ file: folder, message }];
|
|
78
86
|
});
|
|
79
87
|
}),
|
|
80
|
-
description: "Folders cannot be named internal. A
|
|
88
|
+
description: "Folders cannot be named internal. A trailing run of a package's folder path joined with hyphens matches its unscoped name, with each segment singular or plural. A module folder is named after its main file, a content folder in snake_case and every other folder in kebab-case. TanStack Router configuration owns route folder names.",
|
|
81
89
|
id: "files/folder-names",
|
|
82
90
|
options: Schema.toStandardSchemaV1(FolderNamesOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
|
|
83
91
|
validate: validateGlobs,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folderNames.js","sourceRoot":"","sources":["../../../src/rules/files/folderNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAsB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"folderNames.js","sourceRoot":"","sources":["../../../src/rules/files/folderNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAsB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAgB,MAAM,UAAU,CAAC;AAEpD,MAAM,KAAK,GAAG,6BAA6B,CAAC;AAE5C,MAAM,IAAI,GAAG,kBAAkB,CAAC;AAEhC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,gBAAgB;IACzB,SAAS,EAAE,gBAAgB;CAC3B,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,KAAwB;IAC1C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,KAAK,IAAI,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACF,CAAC;IACD,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,OAAO,CAAC,KAAwB;IACxC,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3I,CAAC;AAED,SAAS,QAAQ,CAAC,MAAc,EAAE,KAA0B;IAC3D,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC;AAED,SAAS,cAAc,CAAC,MAAc,EAAE,WAAmB;IAC1D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;IACH,OAAO,OAAO;QACb,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,6BAA6B,WAAW,qEAAqE,QAAQ,0CAA0C,CAAC;AACpK,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IACjC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,IAAI,IAAI,gCAAgC,IAAI,UAAU,IAAI,mHAAmH,CAAC;IACtL,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,IAAI,8JAA8J,CAAC;AAC3K,CAAC;AAUD,SAAS,UAAU,CAAC,MAAc,EAAE,OAAgB;IACnD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACzB,OAAO,qJAAqJ,CAAC;IAC9J,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1E,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,sEAAsE,CAAC;IACtH,CAAC;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACrC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,CAC7C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACnB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,OAAO,GAAY;YACxB,OAAO,EAAE,cAAc,CAAC,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3D,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAClE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC;YACrB,SAAS,EAAE,cAAc,CAAC,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;SAC/D,CAAC;QACF,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAsB,EAAE;YAC9D,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC5C,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;IACH,WAAW,EACV,4UAA4U;IAC7U,EAAE,EAAE,oBAAoB;IACxB,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE,CAAC;IACtH,QAAQ,EAAE,aAAa;CACvB,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifestsExportsShape.d.ts","sourceRoot":"","sources":["../../src/rules/manifestsExportsShape.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"manifestsExportsShape.d.ts","sourceRoot":"","sources":["../../src/rules/manifestsExportsShape.ts"],"names":[],"mappings":"AAmFA,eAAO,MAAM,qBAAqB,sEA0BhC,CAAC"}
|
|
@@ -3,12 +3,16 @@ import { Effect } from "effect";
|
|
|
3
3
|
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
4
4
|
import { workspacePackages } from "#imports/workspace.ts";
|
|
5
5
|
import { defineRule } from "#rule.ts";
|
|
6
|
+
import { exportImportFindings } from "#rules/exportImportFindings.ts";
|
|
6
7
|
const PATTERN = "./*.ts";
|
|
7
8
|
const CODE_EXTENSIONS = new Set([".ts", ".tsx", ".mts", ".cts", ".js", ".jsx", ".mjs", ".cjs"]);
|
|
8
9
|
function isMap(value) {
|
|
9
10
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
10
11
|
}
|
|
11
12
|
function standardPattern(key, value, sourceOnly = false) {
|
|
13
|
+
if (sourceOnly && key === "./*" && value === "./src/*") {
|
|
14
|
+
return true;
|
|
15
|
+
}
|
|
12
16
|
if (!(key.startsWith("./") && key.endsWith(".ts")) || key.split("*").length !== 2) {
|
|
13
17
|
return false;
|
|
14
18
|
}
|
|
@@ -30,7 +34,9 @@ function exactAsset(key, value) {
|
|
|
30
34
|
return key.startsWith("./") && !key.includes("*") && value === key && extension !== "" && !CODE_EXTENSIONS.has(extension);
|
|
31
35
|
}
|
|
32
36
|
function finding(file, subject, reason, isPrivate) {
|
|
33
|
-
const sourceOnly = isPrivate
|
|
37
|
+
const sourceOnly = isPrivate
|
|
38
|
+
? ' For a private package, mapping "./*.ts" directly to "./src/*.ts", or "./*" to "./src/*" to preserve both .ts and .tsx extensions, is also accepted.'
|
|
39
|
+
: "";
|
|
34
40
|
return {
|
|
35
41
|
file,
|
|
36
42
|
message: `${reason} Import the module at its file path through the single "${PATTERN}" wildcard (for example, "./server/better-auth/mount.ts" for "./src/server/better-auth/mount.ts"). Map it to source "./src/*.ts", types "./dist/*.d.ts" and default "./dist/*.js"; remove aliases and per-file module exports. Non-code assets must use their exact file paths.${sourceOnly}`,
|
|
@@ -64,29 +70,6 @@ function findingsIn(file, exports, isPrivate) {
|
|
|
64
70
|
}),
|
|
65
71
|
];
|
|
66
72
|
}
|
|
67
|
-
function importFindings(file, imports = {}) {
|
|
68
|
-
return Object.entries(imports).flatMap(([key, value]) => {
|
|
69
|
-
if (key === "#*.ts" && value !== "./src/*.ts" && !standardPattern(PATTERN, value)) {
|
|
70
|
-
return [
|
|
71
|
-
{
|
|
72
|
-
file,
|
|
73
|
-
message: 'Import "#*.ts" must preserve the path from the source root. Map it to "./src/*.ts", or to source "./src/*.ts", types "./dist/*.d.ts" and default "./dist/*.js". Include subfolders in import specifiers, for example "#server/module.ts".',
|
|
74
|
-
subject: key,
|
|
75
|
-
},
|
|
76
|
-
];
|
|
77
|
-
}
|
|
78
|
-
if (key === "#test/*" && value !== "./src/test-support/*") {
|
|
79
|
-
return [
|
|
80
|
-
{
|
|
81
|
-
file,
|
|
82
|
-
message: 'Import "#test/*" must map to "./src/test-support/*". Keep test helpers under the source root’s test-support folder.',
|
|
83
|
-
subject: key,
|
|
84
|
-
},
|
|
85
|
-
];
|
|
86
|
-
}
|
|
87
|
-
return [];
|
|
88
|
-
});
|
|
89
|
-
}
|
|
90
73
|
export const manifestsExportsShape = defineRule({
|
|
91
74
|
check: (inputs) => Effect.gen(function* () {
|
|
92
75
|
const packages = yield* Effect.promise(() => workspacePackages(inputs));
|
|
@@ -96,11 +79,14 @@ export const manifestsExportsShape = defineRule({
|
|
|
96
79
|
if (file === "package.json" && manifest === undefined) {
|
|
97
80
|
return [];
|
|
98
81
|
}
|
|
99
|
-
return [
|
|
82
|
+
return [
|
|
83
|
+
...findingsIn(file, manifest?.exports, manifest?.private === true),
|
|
84
|
+
...exportImportFindings(file, manifest?.imports, manifest?.private === true),
|
|
85
|
+
];
|
|
100
86
|
}), { concurrency: "unbounded" });
|
|
101
87
|
return findings.flat();
|
|
102
88
|
}),
|
|
103
|
-
description: "Packages export modules through one file-preserving wildcard without null blocks; declared #*.ts and #test/* imports preserve the source and test-support roots.",
|
|
89
|
+
description: "Packages export modules through one file-preserving wildcard without null blocks; declared #*.ts and #test/* imports preserve the source and test-support roots. Private packages may export ./src/* through ./* and map #test/* into their own test tree.",
|
|
104
90
|
id: "manifests/exports-shape",
|
|
105
91
|
registrable: false,
|
|
106
92
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifestsExportsShape.js","sourceRoot":"","sources":["../../src/rules/manifestsExportsShape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAgB,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"manifestsExportsShape.js","sourceRoot":"","sources":["../../src/rules/manifestsExportsShape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAgB,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAEtE,MAAM,OAAO,GAAG,QAAQ,CAAC;AAEzB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEhG,SAAS,KAAK,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,eAAe,CAAC,GAAW,EAAE,KAAc,EAAE,UAAU,GAAG,KAAK;IACvE,IAAI,UAAU,IAAI,GAAG,KAAK,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxD,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnF,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,UAAU,IAAI,KAAK,KAAK,SAAS,OAAO,EAAE,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,mBAAmB,IAAI,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC7E,MAAM,UAAU,GAAG,EAAE,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,UAAU,IAAI,OAAO,EAAE,CAAC;IAChH,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM;WACzD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC,CACzF,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,GAAW,EAAE,KAAc;IAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,GAAG,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC3H,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,OAAe,EAAE,MAAc,EAAE,SAAkB;IACjF,MAAM,UAAU,GAAG,SAAS;QAC3B,CAAC,CAAC,sJAAsJ;QACxJ,CAAC,CAAC,EAAE,CAAC;IACN,OAAO;QACN,IAAI;QACJ,OAAO,EAAE,GAAG,MAAM,2DAA2D,OAAO,kRAAkR,UAAU,EAAE;QAClX,OAAO;KACP,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,OAAgB,EAAE,SAAkB;IACrE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,0CAA0C,EAAE,SAAS,CAAC,CAAC,CAAC;IAC1F,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC;IACvF,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IACjG,MAAM,KAAK,GACV,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC;QAClE,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,gEAAgE,QAAQ,CAAC,MAAM,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9H,OAAO;QACN,GAAG,KAAK;QACR,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACnC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO;oBACN,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,GAAG,6FAA6F,EAAE,SAAS,CAAC;iBAC1I,CAAC;YACH,CAAC;YACD,OAAO,GAAG,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC;gBACrF,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,GAAG,6CAA6C,EAAE,SAAS,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;KACF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;IAC/C,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CACjB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACnB,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,CAAC,cAAc,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QACxG,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CACrC,KAAK,EACL,CAAC,IAAI,EAAE,EAAE,CACR,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;YACzF,IAAI,IAAI,KAAK,cAAc,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBACvD,OAAO,EAAE,CAAC;YACX,CAAC;YACD,OAAO;gBACN,GAAG,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;gBAClE,GAAG,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;aAC5E,CAAC;QACH,CAAC,CAAC,EACH,EAAE,WAAW,EAAE,WAAW,EAAE,CAC5B,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC,CAAC;IACH,WAAW,EACV,4PAA4P;IAC7P,EAAE,EAAE,yBAAyB;IAC7B,WAAW,EAAE,KAAK;CAClB,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/quality",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.69.1",
|
|
4
4
|
"description": "Repository quality gate with typed rules, a baseline of existing debt and a registry of reasoned exceptions",
|
|
5
5
|
"homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/quality#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"@effect/platform-node": "4.1.0",
|
|
69
69
|
"@effect/platform-node-shared": "4.1.0",
|
|
70
70
|
"@effect/vitest": "4.1.0",
|
|
71
|
-
"@shivaedev/test-story": "0.44.
|
|
71
|
+
"@shivaedev/test-story": "0.44.2",
|
|
72
72
|
"@types/node": "24.19.2",
|
|
73
73
|
"@typescript/native": "npm:typescript@7.0.2",
|
|
74
74
|
"effect": "4.1.0",
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
"peerDependencies": {
|
|
78
78
|
"@effect/platform-node": "4.1.0",
|
|
79
79
|
"@effect/platform-node-shared": "4.1.0",
|
|
80
|
-
"@shivaedev/test-story": "0.44.
|
|
80
|
+
"@shivaedev/test-story": "0.44.2",
|
|
81
81
|
"effect": "4.1.0",
|
|
82
82
|
"vitest": "5.0.5"
|
|
83
83
|
},
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { join } from "node:path";
|
|
1
|
+
import { join, relative } from "node:path";
|
|
2
2
|
import { Effect, Schema } from "effect";
|
|
3
3
|
import { exceptionConfig } from "#biome/exceptionConfig.ts";
|
|
4
4
|
import type { ExceptionDeclaration } from "#exceptions/declaration.ts";
|
|
5
5
|
import { readOptionalText } from "#inventory/filesystem.ts";
|
|
6
|
+
import { ignoredPaths } from "#inventory/trackedPaths.ts";
|
|
6
7
|
import { browserOverrides } from "./browserTargets.ts";
|
|
7
8
|
import { parseConfig, relocateConfig } from "./relocateConfig.ts";
|
|
8
9
|
|
|
@@ -14,7 +15,9 @@ export const withExceptionConfig = Effect.fn("Biome.withExceptionConfig")(functi
|
|
|
14
15
|
) {
|
|
15
16
|
const { includes, overrides } = exceptionConfig(declarations);
|
|
16
17
|
const targets = yield* browserOverrides(root);
|
|
17
|
-
|
|
18
|
+
const gitIgnored = (yield* ignoredPaths(root)) ?? [];
|
|
19
|
+
const gitIgnores = gitIgnored.map((file) => `!${relative(root, file).replaceAll("\\", "/")}`);
|
|
20
|
+
if (includes.length === 0 && overrides.length === 0 && nonEffectFolders.length === 0 && targets.length === 0 && gitIgnores.length === 0) {
|
|
18
21
|
return yield* run([]);
|
|
19
22
|
}
|
|
20
23
|
const { config, text } = yield* Effect.gen(function* () {
|
|
@@ -40,7 +43,10 @@ export const withExceptionConfig = Effect.fn("Biome.withExceptionConfig")(functi
|
|
|
40
43
|
// Biome also matches a wildcard-led glob such as `!**/.worktrees` against the folders above the root, which ignores a whole linked worktree.
|
|
41
44
|
const generated = {
|
|
42
45
|
...own,
|
|
43
|
-
files: {
|
|
46
|
+
files: {
|
|
47
|
+
...files,
|
|
48
|
+
includes: [...previousIncludes, ...includes.filter((pattern) => pattern !== "**"), ...gitIgnores, "!.worktrees", "!.quality-biome-*"],
|
|
49
|
+
},
|
|
44
50
|
overrides: [...previousOverrides, ...overrides, ...targets],
|
|
45
51
|
};
|
|
46
52
|
const path = yield* relocateConfig(root, join(root, config), generated, nonEffectFolders);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type ts from "typescript";
|
|
2
|
+
|
|
3
|
+
export function browserLibraryType(type: ts.Type): boolean {
|
|
4
|
+
return [type.getSymbol(), type.aliasSymbol].some((symbol) =>
|
|
5
|
+
(symbol?.declarations ?? []).some((declaration) => {
|
|
6
|
+
const source = declaration.getSourceFile();
|
|
7
|
+
const path = source.fileName.replaceAll("\\", "/");
|
|
8
|
+
return (
|
|
9
|
+
(source.hasNoDefaultLib && /(?:^|\/)lib\.(?:dom|webworker)(?:\.[\w-]+)?\.d\.ts$/u.test(path))
|
|
10
|
+
|| /\/node_modules\/(?:@types\/)?react(?:-dom)?\//u.test(path)
|
|
11
|
+
);
|
|
12
|
+
}),
|
|
13
|
+
);
|
|
14
|
+
}
|
|
@@ -5,6 +5,7 @@ import { exportedModule, exportTargets } from "#imports/packageExports.ts";
|
|
|
5
5
|
import { packageOf, workspacePackages } from "#imports/workspace.ts";
|
|
6
6
|
import type { RuleInputs } from "#rule.ts";
|
|
7
7
|
import { KNIP_ISSUES } from "./findings.ts";
|
|
8
|
+
import { mockEntries } from "./mockEntries.ts";
|
|
8
9
|
|
|
9
10
|
const ENTRIES = ["**/*.{test,spec,stories,story}.{ts,tsx,mts,cts,js,jsx,mjs,cjs}", "src/test-support/**", "*.config.{ts,mts,cts,js,mjs,cjs}"];
|
|
10
11
|
|
|
@@ -34,12 +35,13 @@ export async function knipConfiguration(inputs: RuleInputs, toolOwned: readonly
|
|
|
34
35
|
}),
|
|
35
36
|
);
|
|
36
37
|
const scripted = new Set(manifests.flatMap(({ directory, manifest }) => scriptPaths(directory, manifest.scripts ?? {})));
|
|
38
|
+
const mocked = new Set(mockEntries(inputs));
|
|
37
39
|
const workspaces = manifests.map(({ directory, manifest }) => {
|
|
38
40
|
const sources = inputs.sources
|
|
39
41
|
.filter(({ path }) => (packageOf(packages, path)?.directory ?? ".") === directory)
|
|
40
42
|
.map(({ path }) => posix.relative(directory, path));
|
|
41
43
|
const scriptEntries = sources.filter((path) => scripted.has(posix.join(directory, path)));
|
|
42
|
-
const bundled = sources.filter((path) => programmatic.has(posix.join(directory, path)));
|
|
44
|
+
const bundled = sources.filter((path) => programmatic.has(posix.join(directory, path)) || mocked.has(posix.join(directory, path)));
|
|
43
45
|
const bins = exportTargets(manifest.bin).map((target) => target.replace(/^\.\//u, ""));
|
|
44
46
|
const binaries = sources.filter(
|
|
45
47
|
(path) => bins.includes(path) || bins.includes(path.replace(/^src\//u, "dist/").replace(/\.(?<mode>[cm]?)tsx?$/u, ".$<mode>js")),
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { type FakeModule, fakeTargets } from "#adapters/imports/fakeTargets.ts";
|
|
3
|
+
import type { RuleInputs } from "#rule.ts";
|
|
4
|
+
import { parse } from "#rules/parse.ts";
|
|
5
|
+
|
|
6
|
+
export function mockEntries(inputs: RuleInputs): readonly string[] {
|
|
7
|
+
const modules: FakeModule[] = [];
|
|
8
|
+
for (const file of inputs.sources) {
|
|
9
|
+
const source = /\bvi\s*\.\s*(?:mock|doMock)\b/u.test(file.text) ? parse(file) : undefined;
|
|
10
|
+
if (source === undefined) {
|
|
11
|
+
continue;
|
|
12
|
+
}
|
|
13
|
+
const syntax = source;
|
|
14
|
+
function visit(node: ts.Node): void {
|
|
15
|
+
if (
|
|
16
|
+
ts.isCallExpression(node)
|
|
17
|
+
&& ts.isPropertyAccessExpression(node.expression)
|
|
18
|
+
&& node.expression.expression.getText(syntax) === "vi"
|
|
19
|
+
&& ["mock", "doMock"].includes(node.expression.name.text)
|
|
20
|
+
) {
|
|
21
|
+
const argument = node.arguments[0];
|
|
22
|
+
if (argument !== undefined && ts.isStringLiteralLike(argument)) {
|
|
23
|
+
modules.push({ file: file.path, line: syntax.getLineAndCharacterOfPosition(node.getStart(syntax)).line + 1, specifier: argument.text });
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
ts.forEachChild(node, visit);
|
|
27
|
+
}
|
|
28
|
+
visit(source);
|
|
29
|
+
}
|
|
30
|
+
return fakeTargets(inputs, modules).map(({ target }) => target);
|
|
31
|
+
}
|
|
@@ -72,7 +72,7 @@ export const outsideImportFindings = Effect.fn("Imports.outsideImportFindings")(
|
|
|
72
72
|
{
|
|
73
73
|
file: site.from,
|
|
74
74
|
line: site.line,
|
|
75
|
-
message: `Imports outside library "${site.specifier}" as a value. Move the integration into an adapters/
|
|
75
|
+
message: `Imports outside library "${site.specifier}" as a value. Move the integration into an adapters/ module with explicit imports that exposes Effect values; use import type for types. Read environment variables with Config instead of process.env, including in adapters/.`,
|
|
76
76
|
},
|
|
77
77
|
];
|
|
78
78
|
});
|
|
@@ -2,6 +2,7 @@ import type { ImportGraph } from "#imports/graph.ts";
|
|
|
2
2
|
import type { PackageLayout } from "#naming/packageLayout.ts";
|
|
3
3
|
import type { RuleInputs } from "#rule.ts";
|
|
4
4
|
import { bundlerEntries } from "./bundlerEntries.ts";
|
|
5
|
+
import { spawnedEntries } from "./spawnedEntries.ts";
|
|
5
6
|
|
|
6
7
|
function scriptsByPackage(layout: PackageLayout): ReadonlyMap<string, readonly string[]> {
|
|
7
8
|
const scripts = new Map<string, string[]>();
|
|
@@ -47,7 +48,7 @@ export function reachableBuildEntries(inputs: RuleInputs, graph: ImportGraph, la
|
|
|
47
48
|
if (source === undefined) {
|
|
48
49
|
continue;
|
|
49
50
|
}
|
|
50
|
-
for (const entry of bundlerEntries(source, inputs.root, directory)) {
|
|
51
|
+
for (const entry of [...bundlerEntries(source, inputs.root, directory), ...spawnedEntries(source, inputs.root, directory)]) {
|
|
51
52
|
if (sources.has(entry)) {
|
|
52
53
|
entries.add(entry);
|
|
53
54
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { posix } from "node:path";
|
|
2
|
+
import ts from "typescript";
|
|
3
|
+
import type { SourceFile } from "#rule.ts";
|
|
4
|
+
import { parse } from "#rules/parse.ts";
|
|
5
|
+
import { buildEntryPaths } from "./buildEntryPaths.ts";
|
|
6
|
+
import { buildEntryValue, buildOption } from "./buildEntryValue.ts";
|
|
7
|
+
import { importedCall } from "./importedCall.ts";
|
|
8
|
+
|
|
9
|
+
const COMMANDS = new Set(["spawn", "spawnSync", "execFile", "execFileSync", "fork"]);
|
|
10
|
+
|
|
11
|
+
function entriesOf(call: ts.CallExpression, cwd: string, file: string): readonly string[] {
|
|
12
|
+
const imported = importedCall(call);
|
|
13
|
+
if (imported === undefined || !/^(?:node:)?child_process$/u.test(imported.module) || !COMMANDS.has(imported.name)) {
|
|
14
|
+
return [];
|
|
15
|
+
}
|
|
16
|
+
const options = call.arguments[2] === undefined ? undefined : buildEntryValue(call.arguments[2]);
|
|
17
|
+
const working = options !== undefined && ts.isObjectLiteralExpression(options) ? buildOption(options, "cwd") : undefined;
|
|
18
|
+
const directories = working === undefined ? [cwd] : buildEntryPaths(working, cwd, file);
|
|
19
|
+
const targets = call.arguments.slice(0, 2).flatMap((argument) => buildEntryPaths(argument, cwd, file));
|
|
20
|
+
return targets.flatMap((target) => directories.map((folder) => posix.resolve(cwd, folder, target)));
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export function spawnedEntries(file: SourceFile, root: string, directory: string): readonly string[] {
|
|
24
|
+
const source = file.text.includes("child_process") ? parse(file) : undefined;
|
|
25
|
+
if (source === undefined) {
|
|
26
|
+
return [];
|
|
27
|
+
}
|
|
28
|
+
const entries: string[] = [];
|
|
29
|
+
const cwd = posix.join(root, directory);
|
|
30
|
+
const path = posix.join(root, file.path);
|
|
31
|
+
function visit(node: ts.Node): void {
|
|
32
|
+
if (ts.isCallExpression(node)) {
|
|
33
|
+
entries.push(...entriesOf(node, cwd, path).map((target) => posix.relative(root, target)));
|
|
34
|
+
}
|
|
35
|
+
ts.forEachChild(node, visit);
|
|
36
|
+
}
|
|
37
|
+
visit(source);
|
|
38
|
+
return entries;
|
|
39
|
+
}
|
|
@@ -2,9 +2,11 @@ import { Effect } from "effect";
|
|
|
2
2
|
import { reachableBuildEntries } from "#adapters/reachableBuildEntries.ts";
|
|
3
3
|
import { importGraph } from "#imports/graph.ts";
|
|
4
4
|
import { packageLayout } from "#naming/packageLayout.ts";
|
|
5
|
+
import { isTestCode } from "#naming/testName.ts";
|
|
5
6
|
import type { RuleInputs } from "#rule.ts";
|
|
6
7
|
|
|
7
8
|
export const programmaticEntries = Effect.fn("Inventory.programmaticEntries")(function* (inputs: RuleInputs) {
|
|
8
9
|
const layout = yield* packageLayout(inputs);
|
|
9
|
-
|
|
10
|
+
const scripts = new Set([...layout.scripts, ...inputs.sources.filter((file) => isTestCode(file.path)).map((file) => file.path)]);
|
|
11
|
+
return scripts.size === 0 ? new Set<string>() : reachableBuildEntries(inputs, yield* importGraph(inputs), { ...layout, scripts });
|
|
10
12
|
});
|
package/src/rules/biome.ts
CHANGED
|
@@ -5,6 +5,9 @@ import { withoutEntryPointImports } from "#biome/withoutEntryPointImports.ts";
|
|
|
5
5
|
import { defineRule, type Finding, type Rule, type RuleInputs } from "#rule.ts";
|
|
6
6
|
|
|
7
7
|
function messageOf(diagnostic: Diagnostic): string {
|
|
8
|
+
if (diagnostic.category === "lint/correctness/noProcessGlobal") {
|
|
9
|
+
return "Uses the process global. In Effect code, use an adapters/ module with explicit imports that exposes Effect values: import process from node:process there. Read environment variables with Config instead of process.env, including in adapters/.";
|
|
10
|
+
}
|
|
8
11
|
return diagnostic.category === "format" && diagnostic.message.startsWith("Formatter would have printed")
|
|
9
12
|
? "Is not formatted. Run `quality fix`."
|
|
10
13
|
: diagnostic.message;
|
|
@@ -24,7 +24,7 @@ function operationFailure(checker: ts.TypeChecker, operation: FailureOperation,
|
|
|
24
24
|
const names = before.map((part) => part.name);
|
|
25
25
|
const forever = names.indexOf("forever");
|
|
26
26
|
if (forever !== -1 && names.indexOf("orDie", forever + 1) !== -1) {
|
|
27
|
-
return "Forked forever loop dies on failure. Catch a named reason within each iteration with a Schedule
|
|
27
|
+
return "Forked forever loop dies on failure. Catch a named reason within each iteration with a Schedule that paces retries, or expose an explicit unavailable state and supervise termination.";
|
|
28
28
|
}
|
|
29
29
|
}
|
|
30
30
|
return undefined;
|
|
@@ -34,7 +34,11 @@ export function failureFindings(checker: ts.TypeChecker, node: ts.CallExpression
|
|
|
34
34
|
const findings: FailureFinding[] = [];
|
|
35
35
|
const name = effectName(checker, node.expression);
|
|
36
36
|
if (name === "retry" && unboundedRetry(node)) {
|
|
37
|
-
findings.push({
|
|
37
|
+
findings.push({
|
|
38
|
+
message:
|
|
39
|
+
"Retry has while without times or schedule. Use a Schedule that paces retries. Use Schedule.spaced(...) without a count for a reconnect loop that must not stop; preserve the typed failure when retries end.",
|
|
40
|
+
node,
|
|
41
|
+
});
|
|
38
42
|
}
|
|
39
43
|
const handler = node.arguments.at(-1);
|
|
40
44
|
if (["catch", "catchAll", "catchCause", "catchAllCause"].includes(name ?? "") && handler !== undefined && successRecovery(checker, handler)) {
|
|
@@ -53,7 +53,7 @@ export const failureHonesty = defineRule({
|
|
|
53
53
|
return [...groups.values()].flatMap((sources) => checkFailures({ ...inputs, sources }));
|
|
54
54
|
},
|
|
55
55
|
description:
|
|
56
|
-
"Keep failures typed and observable: no forked forever/orDie loops, retry({ while }) without a
|
|
56
|
+
"Keep failures typed and observable: no forked forever/orDie loops, retry({ while }) without times or a pacing Schedule, blanket catch-to-success, or FileSystem option/orElseSucceed. Catch a named reason, use a Schedule that paces retries or model an explicit unavailable state. No config exceptions or inline suppressions; baseline existing debt.",
|
|
57
57
|
id: "effect/failure-honesty",
|
|
58
58
|
registrable: false,
|
|
59
59
|
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import ts from "typescript";
|
|
2
|
+
import { browserLibraryType } from "#adapters/browserLibraryType.ts";
|
|
2
3
|
import { callerContextData } from "#adapters/callerContextData.ts";
|
|
3
4
|
|
|
4
5
|
const SERVICE = "~effect/Context/Service";
|
|
@@ -83,6 +84,7 @@ export function serviceTypes(checker: ts.TypeChecker, initializerState = false)
|
|
|
83
84
|
if (
|
|
84
85
|
seen.has(type)
|
|
85
86
|
|| contextData.has(type)
|
|
87
|
+
|| browserLibraryType(type)
|
|
86
88
|
|| type.flags
|
|
87
89
|
& (ts.TypeFlags.Any
|
|
88
90
|
| ts.TypeFlags.Unknown
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { Finding } from "#rule.ts";
|
|
2
|
+
|
|
3
|
+
function sourceImport(value: unknown): boolean {
|
|
4
|
+
if (value === "./src/*.ts") {
|
|
5
|
+
return true;
|
|
6
|
+
}
|
|
7
|
+
if (typeof value !== "object" || value === null || Array.isArray(value)) {
|
|
8
|
+
return false;
|
|
9
|
+
}
|
|
10
|
+
const source = "@shivaedev/source" in value ? "@shivaedev/source" : "source";
|
|
11
|
+
const conditions = { default: "./dist/*.js", [source]: "./src/*.ts", types: "./dist/*.d.ts" };
|
|
12
|
+
return Object.keys(value).length === 3 && Object.entries(conditions).every(([key, target]) => Reflect.get(value, key) === target);
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
function localTestTree(value: unknown): boolean {
|
|
16
|
+
return typeof value === "string" && /^\.\/(?:test|tests|test-support)\/(?:[^*\\]+\/)?\*$/u.test(value) && !value.split("/").includes("..");
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export function exportImportFindings(file: string, imports: Readonly<Record<string, unknown>> = {}, isPrivate = false): readonly Finding[] {
|
|
20
|
+
return Object.entries(imports).flatMap(([key, value]) => {
|
|
21
|
+
if (key === "#*.ts" && !sourceImport(value)) {
|
|
22
|
+
return [
|
|
23
|
+
{
|
|
24
|
+
file,
|
|
25
|
+
message:
|
|
26
|
+
'Import "#*.ts" must preserve the path from the source root. Map it to "./src/*.ts", or to source "./src/*.ts", types "./dist/*.d.ts" and default "./dist/*.js". Include subfolders in import specifiers, for example "#server/module.ts".',
|
|
27
|
+
subject: key,
|
|
28
|
+
},
|
|
29
|
+
];
|
|
30
|
+
}
|
|
31
|
+
if (key === "#test/*" && value !== "./src/test-support/*" && !(isPrivate && localTestTree(value))) {
|
|
32
|
+
return [
|
|
33
|
+
{
|
|
34
|
+
file,
|
|
35
|
+
message: isPrivate
|
|
36
|
+
? 'Import "#test/*" must map to "./src/test-support/*" or the package’s own test/, tests/ or test-support/ tree.'
|
|
37
|
+
: 'Import "#test/*" must map to "./src/test-support/*". Keep test helpers under the source root’s test-support folder.',
|
|
38
|
+
subject: key,
|
|
39
|
+
},
|
|
40
|
+
];
|
|
41
|
+
}
|
|
42
|
+
return [];
|
|
43
|
+
});
|
|
44
|
+
}
|
|
@@ -5,7 +5,7 @@ import { GlobDeclarations, globPatterns, validateGlobs } from "#config/globs.ts"
|
|
|
5
5
|
import { routeFiles } from "#inventory/routeFiles.ts";
|
|
6
6
|
import { nativeNames } from "#naming/nativeNames.ts";
|
|
7
7
|
import { packageLayout } from "#naming/packageLayout.ts";
|
|
8
|
-
import { KEBAB, PASCAL } from "#naming/words.ts";
|
|
8
|
+
import { KEBAB, PASCAL, sameWord } from "#naming/words.ts";
|
|
9
9
|
import { defineRule, type Finding } from "#rule.ts";
|
|
10
10
|
|
|
11
11
|
const SNAKE = /^[a-z0-9]+(?:_[a-z0-9]+)*$/u;
|
|
@@ -38,10 +38,15 @@ function isModule(folder: string, stems: ReadonlySet<string>): boolean {
|
|
|
38
38
|
|
|
39
39
|
function packageMessage(folder: string, packageName: string): string | undefined {
|
|
40
40
|
const expected = packageName.replace(/^@[^/]+\//u, "");
|
|
41
|
-
const
|
|
42
|
-
|
|
41
|
+
const segments = folder.split("/");
|
|
42
|
+
const matches = segments.some((_, start) => {
|
|
43
|
+
const tail = segments.slice(start).join("-").split("-");
|
|
44
|
+
const name = expected.split("-");
|
|
45
|
+
return tail.length === name.length && tail.every((word, index) => sameWord(word, name[index] ?? ""));
|
|
46
|
+
});
|
|
47
|
+
return matches
|
|
43
48
|
? undefined
|
|
44
|
-
: `The folder of the package ${packageName} must
|
|
49
|
+
: `The folder of the package ${packageName} must match a trailing run of its folder path joined with "-" as "${expected}", with each segment singular or plural.`;
|
|
45
50
|
}
|
|
46
51
|
|
|
47
52
|
function groupMessage(name: string): string | undefined {
|
|
@@ -66,13 +71,16 @@ function messageFor(folder: string, context: Context): string | undefined {
|
|
|
66
71
|
if (name === "internal") {
|
|
67
72
|
return 'A folder named "internal" implies privacy that export maps do not enforce. Move its files into the parent folder or a folder named after their job.';
|
|
68
73
|
}
|
|
69
|
-
if (context.owned.has(folder) || context.toolOwned.ignores(`${folder}/`)
|
|
74
|
+
if (context.owned.has(folder) || context.toolOwned.ignores(`${folder}/`)) {
|
|
70
75
|
return undefined;
|
|
71
76
|
}
|
|
72
77
|
const packageName = context.names.get(folder);
|
|
73
78
|
if (packageName !== undefined) {
|
|
74
79
|
return packageMessage(folder, packageName);
|
|
75
80
|
}
|
|
81
|
+
if (isModule(folder, context.stems)) {
|
|
82
|
+
return undefined;
|
|
83
|
+
}
|
|
76
84
|
if (context.content.ignores(`${folder}/`)) {
|
|
77
85
|
return SNAKE.test(name) ? undefined : `"${name}" holds content, so it is named in snake_case, such as forest_path/.`;
|
|
78
86
|
}
|
|
@@ -97,7 +105,7 @@ export const folderNames = defineRule({
|
|
|
97
105
|
});
|
|
98
106
|
}),
|
|
99
107
|
description:
|
|
100
|
-
"Folders cannot be named internal. A
|
|
108
|
+
"Folders cannot be named internal. A trailing run of a package's folder path joined with hyphens matches its unscoped name, with each segment singular or plural. A module folder is named after its main file, a content folder in snake_case and every other folder in kebab-case. TanStack Router configuration owns route folder names.",
|
|
101
109
|
id: "files/folder-names",
|
|
102
110
|
options: Schema.toStandardSchemaV1(FolderNamesOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
|
|
103
111
|
validate: validateGlobs,
|