@shivaedev/quality 0.43.0 → 0.44.0
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 +18 -0
- package/README.md +55 -39
- package/biome/declarations.json +1 -1
- package/biome/preset.json +60 -60
- package/dist/adapters/knip/configuration.d.ts +29 -0
- package/dist/adapters/knip/configuration.d.ts.map +1 -0
- package/dist/adapters/knip/configuration.js +56 -0
- package/dist/adapters/knip/configuration.js.map +1 -0
- package/dist/adapters/knip/entryPointFindings.d.ts +3 -0
- package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -0
- package/dist/adapters/knip/entryPointFindings.js +49 -0
- package/dist/adapters/knip/entryPointFindings.js.map +1 -0
- package/dist/adapters/knip/findings.d.ts +4 -0
- package/dist/adapters/knip/findings.d.ts.map +1 -0
- package/dist/adapters/knip/findings.js +40 -0
- package/dist/adapters/knip/findings.js.map +1 -0
- package/dist/adapters/knip/run.d.ts +3 -0
- package/dist/adapters/knip/run.d.ts.map +1 -0
- package/dist/adapters/knip/run.js +46 -0
- package/dist/adapters/knip/run.js.map +1 -0
- package/dist/adapters/knip/sourceConfig.d.ts +4 -0
- package/dist/adapters/knip/sourceConfig.d.ts.map +1 -0
- package/dist/adapters/knip/sourceConfig.js +15 -0
- package/dist/adapters/knip/sourceConfig.js.map +1 -0
- package/dist/biome/recognizeDiagnostics.js +2 -2
- package/dist/biome/recognizeDiagnostics.js.map +1 -1
- package/dist/docs/documentedImports.d.ts +12 -0
- package/dist/docs/documentedImports.d.ts.map +1 -0
- package/dist/docs/documentedImports.js +80 -0
- package/dist/docs/documentedImports.js.map +1 -0
- package/dist/docs/documentedModule.d.ts +11 -0
- package/dist/docs/documentedModule.d.ts.map +1 -0
- package/dist/docs/documentedModule.js +32 -0
- package/dist/docs/documentedModule.js.map +1 -0
- package/dist/docs/exportsName.d.ts +2 -0
- package/dist/docs/exportsName.d.ts.map +1 -0
- package/dist/docs/exportsName.js +25 -0
- package/dist/docs/exportsName.js.map +1 -0
- package/dist/docs/headingAnchors.d.ts +4 -0
- package/dist/docs/headingAnchors.d.ts.map +1 -0
- package/dist/docs/headingAnchors.js +43 -0
- package/dist/docs/headingAnchors.js.map +1 -0
- package/dist/docs/importFindings.d.ts +12 -0
- package/dist/docs/importFindings.d.ts.map +1 -0
- package/dist/docs/importFindings.js +36 -0
- package/dist/docs/importFindings.js.map +1 -0
- package/dist/docs/isDocument.d.ts +2 -0
- package/dist/docs/isDocument.d.ts.map +1 -0
- package/dist/docs/isDocument.js +6 -0
- package/dist/docs/isDocument.js.map +1 -0
- package/dist/docs/linkFindings.d.ts +12 -0
- package/dist/docs/linkFindings.d.ts.map +1 -0
- package/dist/docs/linkFindings.js +59 -0
- package/dist/docs/linkFindings.js.map +1 -0
- package/dist/docs/markdownLines.d.ts +11 -0
- package/dist/docs/markdownLines.d.ts.map +1 -0
- package/dist/docs/markdownLines.js +38 -0
- package/dist/docs/markdownLines.js.map +1 -0
- package/dist/docs/markdownLinks.d.ts +7 -0
- package/dist/docs/markdownLinks.d.ts.map +1 -0
- package/dist/docs/markdownLinks.js +23 -0
- package/dist/docs/markdownLinks.js.map +1 -0
- package/dist/docs/repositoryLink.d.ts +11 -0
- package/dist/docs/repositoryLink.d.ts.map +1 -0
- package/dist/docs/repositoryLink.js +28 -0
- package/dist/docs/repositoryLink.js.map +1 -0
- package/dist/imports/fences/compilePolicy.d.ts.map +1 -1
- package/dist/imports/fences/compilePolicy.js +1 -1
- package/dist/imports/fences/compilePolicy.js.map +1 -1
- package/dist/imports/fences/match.d.ts +1 -1
- package/dist/imports/fences/match.d.ts.map +1 -1
- package/dist/imports/fences/match.js +1 -1
- package/dist/imports/fences/match.js.map +1 -1
- package/dist/imports/packageExports.d.ts +1 -0
- package/dist/imports/packageExports.d.ts.map +1 -1
- package/dist/imports/packageExports.js +7 -5
- package/dist/imports/packageExports.js.map +1 -1
- package/dist/imports/packageName.d.ts +4 -0
- package/dist/imports/packageName.d.ts.map +1 -0
- package/dist/imports/packageName.js +25 -0
- package/dist/imports/packageName.js.map +1 -0
- package/dist/imports/resolve.d.ts +0 -2
- package/dist/imports/resolve.d.ts.map +1 -1
- package/dist/imports/resolve.js +1 -24
- package/dist/imports/resolve.js.map +1 -1
- package/dist/inventory/collect.d.ts +0 -1
- package/dist/inventory/collect.d.ts.map +1 -1
- package/dist/inventory/collect.js +1 -4
- package/dist/inventory/collect.js.map +1 -1
- package/dist/inventory/linesOf.d.ts +2 -0
- package/dist/inventory/linesOf.d.ts.map +1 -0
- package/dist/inventory/linesOf.js +5 -0
- package/dist/inventory/linesOf.js.map +1 -0
- package/dist/rules/builtIn.d.ts +2 -2
- package/dist/rules/builtIn.d.ts.map +1 -1
- package/dist/rules/builtIn.js +6 -0
- package/dist/rules/builtIn.js.map +1 -1
- package/dist/rules/docs/references.d.ts +2 -0
- package/dist/rules/docs/references.d.ts.map +1 -0
- package/dist/rules/docs/references.js +66 -0
- package/dist/rules/docs/references.js.map +1 -0
- package/dist/rules/docs/unversionedInstalls.d.ts +2 -0
- package/dist/rules/docs/unversionedInstalls.d.ts.map +1 -0
- package/dist/rules/docs/unversionedInstalls.js +36 -0
- package/dist/rules/docs/unversionedInstalls.js.map +1 -0
- package/dist/rules/files/folderNames.js +2 -2
- package/dist/rules/files/folderNames.js.map +1 -1
- package/dist/rules/imports/manifest.js +1 -1
- package/dist/rules/imports/manifest.js.map +1 -1
- package/dist/rules/imports/runtime.js +1 -1
- package/dist/rules/imports/runtime.js.map +1 -1
- package/dist/rules/stories/unitTests.js +1 -1
- package/dist/rules/stories/unitTests.js.map +1 -1
- package/dist/rules/unusedCode.d.ts +2 -0
- package/dist/rules/unusedCode.d.ts.map +1 -0
- package/dist/rules/unusedCode.js +9 -0
- package/dist/rules/unusedCode.js.map +1 -0
- package/docs/debt-and-hooks.md +0 -1
- package/docs/north-star.md +1 -1
- package/package.json +3 -2
- package/src/adapters/knip/configuration.ts +66 -0
- package/src/adapters/knip/entryPointFindings.ts +54 -0
- package/src/adapters/knip/findings.ts +46 -0
- package/src/adapters/knip/run.ts +60 -0
- package/src/adapters/knip/sourceConfig.ts +20 -0
- package/src/biome/recognizeDiagnostics.ts +2 -2
- package/src/docs/documentedImports.ts +104 -0
- package/src/docs/documentedModule.ts +44 -0
- package/src/docs/exportsName.ts +27 -0
- package/src/docs/headingAnchors.ts +52 -0
- package/src/docs/importFindings.ts +62 -0
- package/src/docs/isDocument.ts +6 -0
- package/src/docs/linkFindings.ts +90 -0
- package/src/docs/markdownLines.ts +56 -0
- package/src/docs/markdownLinks.ts +33 -0
- package/src/docs/repositoryLink.ts +44 -0
- package/src/imports/fences/compilePolicy.ts +2 -1
- package/src/imports/fences/match.ts +2 -1
- package/src/imports/packageExports.ts +8 -5
- package/src/imports/packageName.ts +31 -0
- package/src/imports/resolve.ts +1 -31
- package/src/inventory/collect.ts +1 -5
- package/src/inventory/linesOf.ts +4 -0
- package/src/rules/builtIn.ts +6 -0
- package/src/rules/docs/references.ts +83 -0
- package/src/rules/docs/unversionedInstalls.ts +53 -0
- package/src/rules/files/folderNames.ts +2 -2
- package/src/rules/imports/manifest.ts +1 -1
- package/src/rules/imports/runtime.ts +1 -1
- package/src/rules/stories/unitTests.ts +1 -1
- package/src/rules/unusedCode.ts +10 -0
|
@@ -3,13 +3,10 @@ import { Effect, FileSystem } from "effect";
|
|
|
3
3
|
import ignore from "ignore";
|
|
4
4
|
import { FilesystemFailure, orWhenAbsent, readRequiredText } from "./filesystem.js";
|
|
5
5
|
import { posix } from "./ignoreScope.js";
|
|
6
|
+
import { linesOf } from "./linesOf.js";
|
|
6
7
|
import { shadcnFolders } from "./shadcnFolders.js";
|
|
7
8
|
import { scopeAbove, walk } from "./walk.js";
|
|
8
9
|
const READ_CONCURRENCY = 16;
|
|
9
|
-
export function linesOf(text) {
|
|
10
|
-
const lines = text.split("\n");
|
|
11
|
-
return lines.at(-1) === "" ? lines.slice(0, -1) : lines;
|
|
12
|
-
}
|
|
13
10
|
const zoneFiles = Effect.fn("Inventory.zoneFiles")(function* (root, zone) {
|
|
14
11
|
const fs = yield* FileSystem.FileSystem;
|
|
15
12
|
const path = join(root, zone);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collect.js","sourceRoot":"","sources":["../../src/inventory/collect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAa7C,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B,MAAM,
|
|
1
|
+
{"version":3,"file":"collect.js","sourceRoot":"","sources":["../../src/inventory/collect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAa7C,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B,MAAM,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,EAC3D,IAAY,EACZ,IAAY;IAEZ,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAClD,OAAO,KAAK,CAAC,CAAC,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,WAAW,IAAI,oCAAoC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACnH,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,YAAY,CAAmC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IACnG,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,CAAC,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,WAAW,IAAI,uBAAuB,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACtG,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC9F,CAAC,CAAC,CAAC;AAEH,SAAS,UAAU,CAAC,IAAY,EAAE,IAAY;IAC7C,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACzG,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE,CAAC,4BAA4B,CAAC,CAAC,QAAQ,CAAC,EAChF,IAAY,EACZ,KAAqB;IAErB,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACvH,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACtF,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;SACvC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;SAC5E,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACrB,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACpB,OAAO,CAAC,CAAC;QACV,CAAC;QACD,OAAO,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IACJ,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3G,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACxH,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"linesOf.d.ts","sourceRoot":"","sources":["../../src/inventory/linesOf.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAGvD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"linesOf.js","sourceRoot":"","sources":["../../src/inventory/linesOf.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,OAAO,CAAC,IAAY;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACzD,CAAC"}
|
package/dist/rules/builtIn.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const builtInRules: readonly [import("../rule.ts").Rule<"effect/boundary", undefined>, import("../rule.ts").Rule<"effect/service-parameters", undefined>, import("../rule.ts").Rule<"react/jsx-conditionals", undefined>, import("../rule.ts").Rule<"structure/max-lines", {
|
|
1
|
+
export declare const builtInRules: readonly [import("../rule.ts").Rule<"code/unused", undefined>, import("../rule.ts").Rule<"effect/boundary", undefined>, import("../rule.ts").Rule<"effect/service-parameters", undefined>, import("../rule.ts").Rule<"react/jsx-conditionals", undefined>, import("../rule.ts").Rule<"structure/max-lines", {
|
|
2
2
|
readonly source?: number;
|
|
3
3
|
readonly test?: number;
|
|
4
4
|
}>, import("../rule.ts").Rule<"nesting/max-depth", undefined>, import("../rule.ts").Rule<"structure/no-barrel", undefined>, import("../rule.ts").Rule<"comments/no-jsdoc", {
|
|
@@ -6,7 +6,7 @@ export declare const builtInRules: readonly [import("../rule.ts").Rule<"effect/b
|
|
|
6
6
|
}>, import("../rule.ts").Rule<"comments/no-line-reference", undefined>, import("../rule.ts").Rule<"comments/no-pr-reference", undefined>, import("../rule.ts").Rule<"comments/no-banner", undefined>, import("../rule.ts").Rule<"comments/no-todo", undefined>, import("../rule.ts").Rule<"comments/no-environment-pragma", undefined>, import("../rule.ts").Rule<"comments/max-per-file", {
|
|
7
7
|
readonly allow?: readonly string[];
|
|
8
8
|
readonly max?: number;
|
|
9
|
-
}>, import("../rule.ts").Rule<"suppressions/no-inline", undefined>, import("../rule.ts").Rule<"suppressions/no-double-cast", undefined>, import("../rule.ts").Rule<"suppressions/no-ignore-deprecations", undefined>, import("../rule.ts").Rule<"suppressions/biome-overrides", {
|
|
9
|
+
}>, import("../rule.ts").Rule<"docs/references", undefined>, import("../rule.ts").Rule<"docs/unversioned-installs", undefined>, import("../rule.ts").Rule<"suppressions/no-inline", undefined>, import("../rule.ts").Rule<"suppressions/no-double-cast", undefined>, import("../rule.ts").Rule<"suppressions/no-ignore-deprecations", undefined>, import("../rule.ts").Rule<"suppressions/biome-overrides", {
|
|
10
10
|
readonly declared?: readonly {
|
|
11
11
|
readonly includes: readonly [string, ...string[]];
|
|
12
12
|
readonly reason: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"builtIn.d.ts","sourceRoot":"","sources":["../../src/rules/builtIn.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"builtIn.d.ts","sourceRoot":"","sources":["../../src/rules/builtIn.ts"],"names":[],"mappings":"AAkDA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+HAkDf,CAAC"}
|
package/dist/rules/builtIn.js
CHANGED
|
@@ -5,6 +5,8 @@ import { noJsdoc } from "#rules/comments/noJsdoc.ts";
|
|
|
5
5
|
import { noLineReference } from "#rules/comments/noLineReference.ts";
|
|
6
6
|
import { noPrReference } from "#rules/comments/noPrReference.ts";
|
|
7
7
|
import { noTodo } from "#rules/comments/noTodo.ts";
|
|
8
|
+
import { docsReferences } from "#rules/docs/references.ts";
|
|
9
|
+
import { docsUnversionedInstalls } from "#rules/docs/unversionedInstalls.ts";
|
|
8
10
|
import { effectBoundary } from "#rules/effect/boundary.ts";
|
|
9
11
|
import { serviceParameters } from "#rules/effect/serviceParameters.ts";
|
|
10
12
|
import { distinctCase } from "#rules/files/distinctCase.ts";
|
|
@@ -44,7 +46,9 @@ import { manifestsSourceFirst } from "./manifestsSourceFirst.js";
|
|
|
44
46
|
import { maxDepth } from "./maxDepth.js";
|
|
45
47
|
import { maxLines } from "./maxLines.js";
|
|
46
48
|
import { noBarrel } from "./noBarrel.js";
|
|
49
|
+
import { unusedCode } from "./unusedCode.js";
|
|
47
50
|
export const builtInRules = [
|
|
51
|
+
unusedCode,
|
|
48
52
|
effectBoundary,
|
|
49
53
|
serviceParameters,
|
|
50
54
|
jsxConditionals,
|
|
@@ -58,6 +62,8 @@ export const builtInRules = [
|
|
|
58
62
|
noTodo,
|
|
59
63
|
noEnvironmentPragma,
|
|
60
64
|
maxPerFile,
|
|
65
|
+
docsReferences,
|
|
66
|
+
docsUnversionedInstalls,
|
|
61
67
|
noInline,
|
|
62
68
|
noDoubleCast,
|
|
63
69
|
noIgnoreDeprecations,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"builtIn.js","sourceRoot":"","sources":["../../src/rules/builtIn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"builtIn.js","sourceRoot":"","sources":["../../src/rules/builtIn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,UAAU;IACV,cAAc;IACd,iBAAiB;IACjB,eAAe;IACf,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,eAAe;IACf,aAAa;IACb,QAAQ;IACR,MAAM;IACN,mBAAmB;IACnB,UAAU;IACV,cAAc;IACd,uBAAuB;IACvB,QAAQ;IACR,YAAY;IACZ,oBAAoB;IACpB,cAAc;IACd,gBAAgB;IAChB,KAAK;IACL,YAAY;IACZ,YAAY;IACZ,cAAc;IACd,iBAAiB;IACjB,eAAe;IACf,cAAc;IACd,UAAU;IACV,eAAe;IACf,oBAAoB;IACpB,qBAAqB;IACrB,oBAAoB;IACpB,gBAAgB;IAChB,WAAW;IACX,YAAY;IACZ,UAAU;IACV,WAAW;IACX,cAAc;IACd,UAAU;IACV,UAAU;IACV,WAAW;IACX,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,WAAW;IACX,UAAU;IACV,WAAW;IACX,cAAc;CACL,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../../src/rules/docs/references.ts"],"names":[],"mappings":"AA6EA,eAAO,MAAM,cAAc,uDAKzB,CAAC"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { join, posix } from "node:path";
|
|
2
|
+
import { Effect, Option, Schema } from "effect";
|
|
3
|
+
import ts from "typescript";
|
|
4
|
+
import { headingAnchors } from "#docs/headingAnchors.ts";
|
|
5
|
+
import { importFindings } from "#docs/importFindings.ts";
|
|
6
|
+
import { isDocument } from "#docs/isDocument.ts";
|
|
7
|
+
import { linkFindings } from "#docs/linkFindings.ts";
|
|
8
|
+
import { markdownLines } from "#docs/markdownLines.ts";
|
|
9
|
+
import { repositoryOf } from "#docs/repositoryLink.ts";
|
|
10
|
+
import { workspacePackages } from "#imports/workspace.ts";
|
|
11
|
+
import { defineRule } from "#rule.ts";
|
|
12
|
+
const decodeJson = Schema.decodeUnknownOption(Schema.fromJsonString(Schema.Unknown));
|
|
13
|
+
function field(value, key) {
|
|
14
|
+
return typeof value === "object" && value !== null && key in value ? Reflect.get(value, key) : undefined;
|
|
15
|
+
}
|
|
16
|
+
// A linked document, such as CLAUDE.md beside AGENTS.md, is checked once through its target.
|
|
17
|
+
function isLink(root, file) {
|
|
18
|
+
const real = ts.sys.realpath ?? ((path) => path);
|
|
19
|
+
return real(join(root, file)) !== join(real(root), file);
|
|
20
|
+
}
|
|
21
|
+
function reader(inputs) {
|
|
22
|
+
return (path) => Effect.promise(() => inputs.readText(path));
|
|
23
|
+
}
|
|
24
|
+
function jsonAt(read, path) {
|
|
25
|
+
return Effect.map(read(path), (text) => (text === undefined ? undefined : Option.getOrUndefined(decodeJson(text))));
|
|
26
|
+
}
|
|
27
|
+
function anchorsReader(read) {
|
|
28
|
+
const known = new Map();
|
|
29
|
+
return (path) => known.has(path)
|
|
30
|
+
? Effect.succeed(known.get(path))
|
|
31
|
+
: Effect.map(read(path), (text) => {
|
|
32
|
+
const anchors = text === undefined ? undefined : headingAnchors(markdownLines(text));
|
|
33
|
+
known.set(path, anchors);
|
|
34
|
+
return anchors;
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
const references = Effect.fn("Docs.references")(function* (inputs) {
|
|
38
|
+
const read = reader(inputs);
|
|
39
|
+
const packages = yield* Effect.promise(() => workspacePackages(inputs));
|
|
40
|
+
const manifests = new Map(yield* Effect.forEach(packages, (owner) => Effect.map(jsonAt(read, posix.join(owner.directory, "package.json")), (manifest) => [owner.name, manifest])));
|
|
41
|
+
const shared = {
|
|
42
|
+
anchors: anchorsReader(read),
|
|
43
|
+
exports: new Map([...manifests].map(([name, manifest]) => [name, field(manifest, "exports")])),
|
|
44
|
+
packages: new Map(packages.map((owner) => [owner.name, owner])),
|
|
45
|
+
readText: read,
|
|
46
|
+
repository: repositoryOf(yield* jsonAt(read, "package.json")),
|
|
47
|
+
root: inputs.root,
|
|
48
|
+
};
|
|
49
|
+
const documents = inputs.files.filter((file) => isDocument(file) && !isLink(inputs.root, file));
|
|
50
|
+
const findings = yield* Effect.forEach(documents, (file) => Effect.flatMap(read(file), (text) => {
|
|
51
|
+
if (text === undefined) {
|
|
52
|
+
return Effect.succeed([]);
|
|
53
|
+
}
|
|
54
|
+
const readme = packages.find((owner) => file === posix.join(owner.directory, "README.md"));
|
|
55
|
+
const published = readme !== undefined && field(manifests.get(readme.name), "private") !== true ? readme.directory : undefined;
|
|
56
|
+
const context = { ...shared, owner: readme?.name, published };
|
|
57
|
+
return Effect.map(Effect.all([linkFindings(context, file, markdownLines(text)), importFindings(context, file, text)]), (found) => found.flat().toSorted((left, right) => (left.line ?? 0) - (right.line ?? 0)));
|
|
58
|
+
}));
|
|
59
|
+
return findings.flat();
|
|
60
|
+
});
|
|
61
|
+
export const docsReferences = defineRule({
|
|
62
|
+
check: (inputs) => Effect.runPromise(references(inputs)),
|
|
63
|
+
description: "Links, heading anchors and documented modules and exports in Markdown resolve, so documentation cannot point at a file, a heading or an API that no longer exists.",
|
|
64
|
+
id: "docs/references",
|
|
65
|
+
});
|
|
66
|
+
//# sourceMappingURL=references.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.js","sourceRoot":"","sources":["../../../src/rules/docs/references.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAyB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAiC,MAAM,UAAU,CAAC;AAErE,MAAM,UAAU,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;AAErF,SAAS,KAAK,CAAC,KAAc,EAAE,GAAW;IACzC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1G,CAAC;AAED,6FAA6F;AAC7F,SAAS,MAAM,CAAC,IAAY,EAAE,IAAY;IACzC,MAAM,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACzD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,MAAM,CAAC,MAAkB;IACjC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,MAAM,CAAC,IAA+B,EAAE,IAAY;IAC5D,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrH,CAAC;AAED,SAAS,aAAa,CAAC,IAA+B;IACrD,MAAM,KAAK,GAAG,IAAI,GAAG,EAA2C,CAAC;IACjE,OAAO,CAAC,IAAI,EAAE,EAAE,CACf,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;QACd,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YACrF,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACzB,OAAO,OAAO,CAAC;QAChB,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAkB;IAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,QAAQ,GAAgC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACrG,MAAM,SAAS,GAAG,IAAI,GAAG,CACxB,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAU,CAAC,CACpH,CACD,CAAC;IACF,MAAM,MAAM,GAAG;QACd,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC;QAC5B,OAAO,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9F,QAAQ,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/D,QAAQ,EAAE,IAAI;QACd,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC7D,IAAI,EAAE,MAAM,CAAC,IAAI;KACjB,CAAC;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAChG,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAC1D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAqC,EAAE;QACtE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;QAC3F,MAAM,SAAS,GAAG,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/H,MAAM,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC9D,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAChI,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAC5E,CAAC;IACH,CAAC,CAAC,CACF,CAAC;IACF,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;IACxC,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACxD,WAAW,EACV,oKAAoK;IACrK,EAAE,EAAE,iBAAiB;CACrB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unversionedInstalls.d.ts","sourceRoot":"","sources":["../../../src/rules/docs/unversionedInstalls.ts"],"names":[],"mappings":"AA+CA,eAAO,MAAM,uBAAuB,iEAKlC,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { isDocument } from "#docs/isDocument.ts";
|
|
3
|
+
import { codeSpans, markdownLines } from "#docs/markdownLines.ts";
|
|
4
|
+
import { defineRule } from "#rule.ts";
|
|
5
|
+
const SHELL_LANGUAGES = new Set(["", "bash", "console", "sh", "shell", "zsh"]);
|
|
6
|
+
const INSTALL = /\b(?:(?:pnpm|npm|yarn|bun)\s+(?:add|install|i|dlx|exec|create|x)|npx|bunx)\s+(?<rest>[^;&|]+)/gu;
|
|
7
|
+
const VERSIONED = /^(?<name>@?[^@\s]+)@(?<version>[\d*<=>^~].*)$/u;
|
|
8
|
+
function commandsIn(line) {
|
|
9
|
+
if (line.kind === "code") {
|
|
10
|
+
return SHELL_LANGUAGES.has(line.language) ? [line.text] : [];
|
|
11
|
+
}
|
|
12
|
+
return line.kind === "prose" ? codeSpans(line.text) : [];
|
|
13
|
+
}
|
|
14
|
+
function versioned(command) {
|
|
15
|
+
return [...command.matchAll(INSTALL)].flatMap((match) => (match.groups?.rest ?? "").split(/\s+/u).filter((token) => !token.startsWith("-") && VERSIONED.test(token)));
|
|
16
|
+
}
|
|
17
|
+
function findingsIn(file, text) {
|
|
18
|
+
return markdownLines(text).flatMap((line) => commandsIn(line)
|
|
19
|
+
.flatMap(versioned)
|
|
20
|
+
.map((token) => ({
|
|
21
|
+
file,
|
|
22
|
+
line: line.number,
|
|
23
|
+
message: `"${token}" pins a version in an install command. Name the package alone, ${VERSIONED.exec(token)?.groups?.name}: its manifest's version ranges decide what installs, and a version written in documentation goes stale with the next release.`,
|
|
24
|
+
subject: token,
|
|
25
|
+
})));
|
|
26
|
+
}
|
|
27
|
+
const unversionedInstalls = Effect.fn("Docs.unversionedInstalls")(function* (inputs) {
|
|
28
|
+
const findings = yield* Effect.forEach(inputs.files.filter(isDocument), (file) => Effect.map(Effect.promise(() => inputs.readText(file)), (text) => (text === undefined ? [] : findingsIn(file, text))));
|
|
29
|
+
return findings.flat();
|
|
30
|
+
});
|
|
31
|
+
export const docsUnversionedInstalls = defineRule({
|
|
32
|
+
check: (inputs) => Effect.runPromise(unversionedInstalls(inputs)),
|
|
33
|
+
description: "Install commands in Markdown name packages without versions, so documentation never tells a reader to install a release it has already left behind.",
|
|
34
|
+
id: "docs/unversioned-installs",
|
|
35
|
+
});
|
|
36
|
+
//# sourceMappingURL=unversionedInstalls.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unversionedInstalls.js","sourceRoot":"","sources":["../../../src/rules/docs/unversionedInstalls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAqB,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,EAAE,UAAU,EAAiC,MAAM,UAAU,CAAC;AAErE,MAAM,eAAe,GAAwB,IAAI,GAAG,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AAEpG,MAAM,OAAO,GAAG,iGAAiG,CAAC;AAElH,MAAM,SAAS,GAAG,gDAAgD,CAAC;AAEnE,SAAS,UAAU,CAAC,IAAkB;IACrC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1B,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,SAAS,CAAC,OAAe;IACjC,OAAO,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACvD,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAC3G,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,IAAY;IAC7C,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,UAAU,CAAC,IAAI,CAAC;SACd,OAAO,CAAC,SAAS,CAAC;SAClB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAChB,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,OAAO,EAAE,IAAI,KAAK,mEAAmE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,gIAAgI;QACxP,OAAO,EAAE,KAAK;KACd,CAAC,CAAC,CACJ,CAAC;AACH,CAAC;AAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,EAAE,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAkB;IAC9F,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAChF,MAAM,CAAC,GAAG,CACT,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAC3C,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAC5D,CACD,CAAC;IACF,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC;IACjD,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACjE,WAAW,EACV,qJAAqJ;IACtJ,EAAE,EAAE,2BAA2B;CAC/B,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
|
-
import { Effect, Schema } from "effect";
|
|
2
|
+
import { Effect, Order, Schema } from "effect";
|
|
3
3
|
import ignore, {} from "ignore";
|
|
4
4
|
import { nativeNames } from "#naming/nativeNames.ts";
|
|
5
5
|
import { packageLayout } from "#naming/packageLayout.ts";
|
|
@@ -18,7 +18,7 @@ function foldersIn(files) {
|
|
|
18
18
|
folders.add(folder);
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
|
-
return [...folders].sort();
|
|
21
|
+
return [...folders].sort(Order.String);
|
|
22
22
|
}
|
|
23
23
|
function stemsIn(files) {
|
|
24
24
|
return new Set(files.filter((file) => CODE.test(file)).map((file) => `${posix.dirname(file)}/${posix.basename(file).replace(CODE, "")}`));
|
|
@@ -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,MAAM,EAAE,MAAM,QAAQ,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,MAAM,EAAE,EAAe,MAAM,QAAQ,CAAC;AAC7C,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;AACjD,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,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5F,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;CAC9F,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,IAAY,EAAE,WAAmB;IACxD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACvD,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,6BAA6B,WAAW,cAAc,QAAQ,0CAA0C,CAAC;AACjJ,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,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9G,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,IAAI,EAAE,WAAW,CAAC,CAAC;IAC1C,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,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC7C,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxD,MAAM,OAAO,GAAY;YACxB,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,OAAO;YAClC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC;YACrB,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;SAC/C,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;IACD,WAAW,EACV,wJAAwJ;IACzJ,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;CACtH,CAAC,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
2
|
import { importGraph } from "#imports/graph.ts";
|
|
3
3
|
import { isTooling } from "#imports/isTooling.ts";
|
|
4
|
-
import { builtinName } from "#imports/
|
|
4
|
+
import { builtinName } from "#imports/packageName.ts";
|
|
5
5
|
import { packageOf } from "#imports/workspace.ts";
|
|
6
6
|
import { entryPointsOf, isApplication, provider, SHIPPED_FIELDS } from "#manifests/entryPoints.ts";
|
|
7
7
|
import { isTestCode } from "#naming/testName.ts";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../../src/rules/imports/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAoB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../../src/rules/imports/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAoB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAyB,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAmB,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACpH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAmB,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,KAAK,GAAG,QAAQ,CAAC;AAEvB,SAAS,WAAW,CAAC,SAAiB;IACrC,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1C,OAAO,CACN,WAAW,CAAC,IAAI,CAAC;WACd,IAAI;aACL,KAAK,CAAC,GAAG,CAAC;aACV,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACtC,IAAI,CAAC,GAAG,CAAC,CACX,CAAC;AACH,CAAC;AAYD,SAAS,KAAK,CAAC,QAAgB,EAAE,KAAa;IAC7C,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC;IACX,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,oBAAoB,CAClC,MAAkB,EAClB,KAAuB,EACvB,KAAkB,EAClB,SAAsC;IAEtC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACzD,IAAI,CAAC;QACJ,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACnD,CAAC;QACD,OAAO;YACN,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACzF,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC;YACpC,WAAW,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YACxD,WAAW,EAAE,MAAM,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;YAC9E,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,KAAK,IAAI;YAClD,OAAO,EAAE,IAAI,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;SAC3E,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACnI,CAAC;AACF,CAAC;AAED,SAAS,eAAe,CAAC,KAAuB,EAAE,IAAY;IAC7D,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAwC,EAAE,KAAuB,EAAE,IAAY,EAAE,OAA4B;IACvI,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,QAAQ,CAAC,MAA4B,EAAE,MAAc,EAAE,WAAoB;IACnF,OAAO,CACN,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;WACvB,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;WAC/C,CAAC,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,KAAK,SAAS,CAAC,CAChG,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAuB,EAAE,MAAwC,EAAE,MAAc,EAAE,WAAoB;IAC1H,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChH,MAAM,UAAU,GACf,OAAO,KAAK,SAAS;QACpB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,oCAAoC,OAAO,CAAC,IAAI,QAAQ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,cAAc,oBAAoB,CAAC;IACtI,MAAM,KAAK,GAAG,WAAW;QACxB,CAAC,CAAC,oFAAoF;QACtF,CAAC,CAAC,qIAAqI,CAAC;IACzI,OAAO,8BAA8B,MAAM,6BAA6B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,4FAA4F,UAAU,GAAG,KAAK,EAAE,CAAC;AACrO,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACzC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACvB,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,GAAiC,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC7I,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,IAAI,GAAG,CACvB,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAU,CAAC,CAAC,CAC7H,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACzF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC;QAC1G,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACnC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;YAC9D,MAAM,MAAM,GACX,CAAC,IAAI,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;mBACrG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBACrE,OAAO,EAAE,CAAC;YACX,CAAC;YACD,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnC,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;YACrF,IAAI,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBACxE,OAAO,EAAE,CAAC;YACX,CAAC;YACD,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACzI,CAAC,CAAC,CAAC;IACJ,CAAC;IACD,WAAW,EACV,yTAAyT;IAC1T,EAAE,EAAE,kBAAkB;CACtB,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { importGraph } from "#imports/graph.ts";
|
|
2
|
-
import { builtinName } from "#imports/
|
|
2
|
+
import { builtinName } from "#imports/packageName.ts";
|
|
3
3
|
import { runtimeDeclarationProblems, runtimeOf } from "#imports/runtime.ts";
|
|
4
4
|
import { isTestCode } from "#naming/testName.ts";
|
|
5
5
|
import { defineRule } from "#rule.ts";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../../src/rules/imports/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../../src/rules/imports/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAgB,0BAA0B,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,SAAS,eAAe,CAAC,IAAa,EAAE,EAAuB,EAAE,OAAgB;IAChF,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvB,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,QAAQ,IAAI,OAAO,CAAC;IACtD,CAAC;IACD,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;IACxC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACvB,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,OAAO,EAAE,CAAC;YACX,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACvE,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,UAAU,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC;YAC5F,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;gBACzC,OAAO,EAAE,CAAC;YACX,CAAC;YACD,OAAO;gBACN;oBACC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,iBAAiB,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,aAAa,IAAI,CAAC,SAAS,mHAAmH;oBAC1P,OAAO,EAAE,IAAI,CAAC,SAAS;iBACvB;aACD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,0BAA0B,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YACxG,IAAI,EAAE,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,eAAe;YACtE,IAAI,EAAE,CAAC;YACP,OAAO;YACP,OAAO,EAAE,iBAAiB;SAC1B,CAAC,CAAC,CAAC;QACJ,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC;QAC1G,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,YAAY,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,4BAA4B,CAAC,CAAC;QACtE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;IACzE,CAAC;IACD,WAAW,EACV,oNAAoN;IACrN,EAAE,EAAE,iBAAiB;CACrB,CAAC,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { labelOf, outgoing, walkFrom } from "#imports/fences/reach.ts";
|
|
2
|
-
import { packageNameOf } from "#imports/
|
|
2
|
+
import { packageNameOf } from "#imports/packageName.ts";
|
|
3
3
|
import { isTestSupport } from "#naming/testName.ts";
|
|
4
4
|
import { parse } from "#rules/parse.ts";
|
|
5
5
|
import { usesDom } from "#rules/test-names/usesDom.ts";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"unitTests.js","sourceRoot":"","sources":["../../../src/rules/stories/unitTests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAA4B,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEjG,OAAO,EAAE,aAAa,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"unitTests.js","sourceRoot":"","sources":["../../../src/rules/stories/unitTests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAA4B,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEjG,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAc,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,QAAQ,GAAG,SAAS,CAAC;AAE3B,MAAM,GAAG,GAAG,kGAAkG,CAAC;AAE/G,SAAS,YAAY,CAAC,KAAkB;IACvC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU;SAC/B,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;SACvF,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,UAAmB,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;IACjJ,OAAO,QAAQ,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,SAAS,MAAM,CAAC,IAAuB;IACtC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAChC,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,OAAO,yCAAyC,CAAC;IAClD,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,CAAC;QAC1B,CAAC,CAAC,6FAA6F,KAAK,GAAG;QACvG,CAAC,CAAC,SAAS,KAAK,qHAAqH,CAAC;AACxI,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,OAAwB;IAC3D,OAAO;QACN,IAAI;QACJ,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,8BAA8B,OAAO,CAAC,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,yEAAyE,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;KAC5N,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAY;IACjC,OAAO,KAAK,CAAC,GAAG,KAAK,OAAO;QAC3B,CAAC,CAAC,cAAc,KAAK,CAAC,IAAI,0FAA0F;QACpH,CAAC,CAAC,0BAA0B,KAAK,CAAC,IAAI,wGAAwG,CAAC;AACjJ,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,MAAc,EAAE,KAAY;IACxD,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,MAAM,8BAA8B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;AACrG,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,MAAc,EAAE,KAAY,EAAE,MAA8B;IACjG,MAAM,MAAM,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACX,CAAC;IACD,SAAS,IAAI,CAAC,GAAW;QACxB,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3C,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC/C,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACtB,OAAO,EAAE,qBAAqB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,GAAG,+CAA+C;KACrI,CAAC,CAAC,CAAC;IACJ,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,CAAC;YACA;gBACC,IAAI;gBACJ,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;gBACb,OAAO,EAAE,qBAAqB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,gDAAgD,GAAG,6CAA6C;aACxJ;SACD;QACF,CAAC,CAAC,EAAE,CAAC;IACN,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAkB,EAAE,OAA8B;IAC3E,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACvE,OAAO,CAAC,IAAI,EAAE,EAAE;QACf,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACnG,OAAO;YACN,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACpG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;SAChG,CAAC;IACH,CAAC,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unusedCode.d.ts","sourceRoot":"","sources":["../../src/rules/unusedCode.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,mDAMrB,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { runKnip } from "#adapters/knip/run.ts";
|
|
2
|
+
import { defineRule } from "#rule.ts";
|
|
3
|
+
export const unusedCode = defineRule({
|
|
4
|
+
check: runKnip,
|
|
5
|
+
description: "Reports unused files, exports and package dependencies, and missing dependencies, through knip. Reach code from declared entry points or remove it; record existing debt in the baseline.",
|
|
6
|
+
id: "code/unused",
|
|
7
|
+
registrable: false,
|
|
8
|
+
});
|
|
9
|
+
//# sourceMappingURL=unusedCode.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unusedCode.js","sourceRoot":"","sources":["../../src/rules/unusedCode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAC;IACpC,KAAK,EAAE,OAAO;IACd,WAAW,EACV,2LAA2L;IAC5L,EAAE,EAAE,aAAa;IACjB,WAAW,EAAE,KAAK;CAClB,CAAC,CAAC"}
|
package/docs/debt-and-hooks.md
CHANGED
|
@@ -12,7 +12,6 @@ The [README](../README.md) introduces the gate. This page explains how the basel
|
|
|
12
12
|
The baseline is sharded: `packages/<package>/quality-baseline.jsonl` holds paths inside that package, and the root `quality-baseline.jsonl` holds all other paths. Packages without entries have no file. Each shard is JSON Lines with one entry per line: the violations of one rule in one file. `count` is how many violations the file may have. For a rule that counts occurrences, such as `comments/no-jsdoc`, that is the number of occurrences. For a rule with a limit, it is the amount over the limit: the entry above lets `src/server/db.ts` have 412 lines under a limit of 150. A new baseline is sorted by path and then rule. Later edits preserve unrelated lines, including their formatting and order, so the diff shows the entries that changed.
|
|
13
13
|
|
|
14
14
|
`quality lint` fails when a baselined file has more violations than its `count`; the report then lists all of that file's violations for the rule. A file at or below its entry passes. An entry that allows more than is left, including a file with no violations left, is listed as a note and does not fail, so fixing debt never breaks the build; `tighten` and `prune` lower it. An entry for an unknown rule fails until it is pruned.
|
|
15
|
-
|
|
16
15
|
- `quality baseline write` records every error-level violation when there is no baseline yet. Once a baseline exists it refuses, unless `--rule <id>` names the rules to record: it then replaces the entries of those rules with what the files have now, and leaves every other entry as it is.
|
|
17
16
|
- `quality baseline tighten` lowers and removes the entries of files changed since `HEAD`, and with `--staged`, of the files staged for the next commit. It carries the entry of a file that git sees as moved to the new path. Every other line stays byte for byte.
|
|
18
17
|
- `quality baseline prune` does the same for every entry. It carries the entries of files moved since the merge base (see `--against` under [Command line](../README.md#command-line)), and prunes without following moves outside a git work tree.
|
package/docs/north-star.md
CHANGED
|
@@ -53,6 +53,6 @@ A rule can require a test's name or report a fixture-writing call. It cannot est
|
|
|
53
53
|
- A requirement for every repository to build its own rules or copy a complicated config before it can use Quality.
|
|
54
54
|
- Application services, persistence, transactions, request identity, client state and other runtime framework jobs. Their owning packages implement them.
|
|
55
55
|
- A replacement for TypeScript, Biome, Vitest or git.
|
|
56
|
-
- Automatic approval of baseline growth or
|
|
56
|
+
- Automatic approval of baseline growth or an exception reason. Review owns whether retained debt is justified.
|
|
57
57
|
- A promise that static imports reproduce every runtime loader or that syntax rules prove business behavior.
|
|
58
58
|
- Renaming public symbols or changing APIs to satisfy a rule whose maintainer decision remains open.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/quality",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.44.0",
|
|
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": {
|
|
@@ -57,9 +57,10 @@
|
|
|
57
57
|
"README.md"
|
|
58
58
|
],
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@biomejs/biome": "2.
|
|
60
|
+
"@biomejs/biome": "2.6.2",
|
|
61
61
|
"@shivaedev/types": "0.3.0",
|
|
62
62
|
"ignore": "7.0.13",
|
|
63
|
+
"knip": "6.42.1",
|
|
63
64
|
"sort-package-json": "4.1.0",
|
|
64
65
|
"typescript": "npm:@typescript/typescript6@6.0.2"
|
|
65
66
|
},
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { posix } from "node:path";
|
|
2
|
+
import { Schema } from "effect";
|
|
3
|
+
import { exportedModule, exportTargets } from "#imports/packageExports.ts";
|
|
4
|
+
import { packageOf, workspacePackages } from "#imports/workspace.ts";
|
|
5
|
+
import type { RuleInputs } from "#rule.ts";
|
|
6
|
+
import { KNIP_ISSUES } from "./findings.ts";
|
|
7
|
+
|
|
8
|
+
const Manifest = Schema.Struct({
|
|
9
|
+
bin: Schema.optional(Schema.Unknown),
|
|
10
|
+
exports: Schema.optional(Schema.Unknown),
|
|
11
|
+
imports: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
|
|
12
|
+
scripts: Schema.optional(Schema.Record(Schema.String, Schema.String)),
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
const ENTRIES = ["**/*.{test,spec,stories,story}.{ts,tsx,mts,cts,js,jsx,mjs,cjs}", "src/test-support/**", "*.config.{ts,mts,cts,js,mjs,cjs}"];
|
|
16
|
+
|
|
17
|
+
function importPaths(imports: Readonly<Record<string, unknown>>) {
|
|
18
|
+
return Object.fromEntries(
|
|
19
|
+
Object.entries(imports).flatMap(([name, target]) => {
|
|
20
|
+
const selected = typeof target === "object" && target !== null && "source" in target ? target.source : target;
|
|
21
|
+
const paths = exportTargets(selected).filter((path) => path.startsWith("./"));
|
|
22
|
+
return paths.length === 0 ? [] : [[name, paths]];
|
|
23
|
+
}),
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export async function knipConfiguration(inputs: RuleInputs) {
|
|
28
|
+
const packages = await workspacePackages(inputs);
|
|
29
|
+
const workspaces = await Promise.all(
|
|
30
|
+
[".", ...packages.map(({ directory }) => directory)].map(async (directory) => {
|
|
31
|
+
const text = await inputs.readText(posix.join(directory, "package.json"));
|
|
32
|
+
const manifest = Schema.decodeUnknownSync(Schema.fromJsonString(Manifest))(text ?? "{}");
|
|
33
|
+
const sources = inputs.sources
|
|
34
|
+
.filter(({ path }) => (packageOf(packages, path)?.directory ?? ".") === directory)
|
|
35
|
+
.map(({ path }) => posix.relative(directory, path));
|
|
36
|
+
const scriptWords = new Set(Object.values(manifest.scripts ?? {}).flatMap((script) => script.split(/[\s'"`;|&()]+/u)));
|
|
37
|
+
const scripted = sources.filter((path) => scriptWords.has(path) || scriptWords.has(`./${path}`));
|
|
38
|
+
const bins = exportTargets(manifest.bin).map((target) => target.replace(/^\.\//u, ""));
|
|
39
|
+
const binaries = sources.filter(
|
|
40
|
+
(path) => bins.includes(path) || bins.includes(path.replace(/^src\//u, "dist/").replace(/\.(?<mode>[cm]?)tsx?$/u, ".$<mode>js")),
|
|
41
|
+
);
|
|
42
|
+
const publicFiles = sources.filter((path) => exportedModule(manifest.exports, path));
|
|
43
|
+
return [
|
|
44
|
+
directory,
|
|
45
|
+
{ entry: [...ENTRIES, ...publicFiles, ...bins, ...binaries, ...scripted], paths: importPaths(manifest.imports ?? {}), project: sources },
|
|
46
|
+
] as const;
|
|
47
|
+
}),
|
|
48
|
+
);
|
|
49
|
+
return {
|
|
50
|
+
exclude: [],
|
|
51
|
+
ignore: [],
|
|
52
|
+
ignoreBinaries: [],
|
|
53
|
+
ignoreDependencies: [],
|
|
54
|
+
ignoreExportsUsedInFile: false,
|
|
55
|
+
ignoreFiles: [],
|
|
56
|
+
ignoreIssues: {},
|
|
57
|
+
ignoreMembers: [],
|
|
58
|
+
ignoreUnresolved: [],
|
|
59
|
+
ignoreWorkspaces: [],
|
|
60
|
+
include: KNIP_ISSUES,
|
|
61
|
+
includeEntryExports: false,
|
|
62
|
+
rules: Object.fromEntries(KNIP_ISSUES.map((kind) => [kind, "error"])),
|
|
63
|
+
tags: [],
|
|
64
|
+
workspaces: Object.fromEntries(workspaces),
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { posix } from "node:path";
|
|
2
|
+
import { importGraph } from "#imports/graph.ts";
|
|
3
|
+
import { isTooling } from "#imports/isTooling.ts";
|
|
4
|
+
import { packageOf } from "#imports/workspace.ts";
|
|
5
|
+
import { entryPointsOf, isApplication, provider } from "#manifests/entryPoints.ts";
|
|
6
|
+
import { isTestCode } from "#naming/testName.ts";
|
|
7
|
+
import type { Findings, RuleInputs } from "#rule.ts";
|
|
8
|
+
|
|
9
|
+
export async function entryPointFindings(inputs: RuleInputs, findings: Findings): Promise<Findings> {
|
|
10
|
+
const graph = await importGraph(inputs);
|
|
11
|
+
const unusedFiles = new Set(findings.filter((finding) => finding.subject?.startsWith("files:")).map((finding) => finding.file));
|
|
12
|
+
const workspace = new Map(graph.packages.map(({ name, directory }) => [name, directory]));
|
|
13
|
+
const directories = [".", ...graph.packages.map(({ directory }) => directory)];
|
|
14
|
+
const policies = new Map(
|
|
15
|
+
await Promise.all(
|
|
16
|
+
directories.map(async (directory) => {
|
|
17
|
+
const manifest: unknown = JSON.parse((await inputs.readText(posix.join(directory, "package.json"))) ?? "{}");
|
|
18
|
+
return [directory, isApplication(manifest) ? await entryPointsOf(inputs, directory, manifest, workspace) : []] as const;
|
|
19
|
+
}),
|
|
20
|
+
),
|
|
21
|
+
);
|
|
22
|
+
function owner(path: string) {
|
|
23
|
+
return packageOf(graph.packages, path)?.directory ?? ".";
|
|
24
|
+
}
|
|
25
|
+
function development(directory: string, path: string) {
|
|
26
|
+
return isTestCode(path) || isTooling(directory, path);
|
|
27
|
+
}
|
|
28
|
+
return findings.filter((finding) => {
|
|
29
|
+
const [kind, name] = finding.subject?.split(":") ?? [];
|
|
30
|
+
if (name === undefined) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
const directory = owner(finding.file);
|
|
34
|
+
const entries = policies.get(directory) ?? [];
|
|
35
|
+
if (kind === "unlisted") {
|
|
36
|
+
return provider(entries, name, development(directory, finding.file), true) === undefined;
|
|
37
|
+
}
|
|
38
|
+
if (kind !== "dependencies" && kind !== "devDependencies") {
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
return ![...graph.edges, ...graph.unresolved].some((edge) => {
|
|
42
|
+
if (owner(edge.from) !== directory || unusedFiles.has(edge.from)) {
|
|
43
|
+
return false;
|
|
44
|
+
}
|
|
45
|
+
const target = /^[.#/]/u.test(edge.specifier)
|
|
46
|
+
? undefined
|
|
47
|
+
: edge.specifier
|
|
48
|
+
.split("/")
|
|
49
|
+
.slice(0, edge.specifier.startsWith("@") ? 2 : 1)
|
|
50
|
+
.join("/");
|
|
51
|
+
return target !== undefined && provider(entries, target, development(directory, edge.from), true)?.name === name;
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
}
|