@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
|
@@ -0,0 +1,56 @@
|
|
|
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 { KNIP_ISSUES } from "./findings.js";
|
|
6
|
+
const Manifest = Schema.Struct({
|
|
7
|
+
bin: Schema.optional(Schema.Unknown),
|
|
8
|
+
exports: Schema.optional(Schema.Unknown),
|
|
9
|
+
imports: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
|
|
10
|
+
scripts: Schema.optional(Schema.Record(Schema.String, Schema.String)),
|
|
11
|
+
});
|
|
12
|
+
const ENTRIES = ["**/*.{test,spec,stories,story}.{ts,tsx,mts,cts,js,jsx,mjs,cjs}", "src/test-support/**", "*.config.{ts,mts,cts,js,mjs,cjs}"];
|
|
13
|
+
function importPaths(imports) {
|
|
14
|
+
return Object.fromEntries(Object.entries(imports).flatMap(([name, target]) => {
|
|
15
|
+
const selected = typeof target === "object" && target !== null && "source" in target ? target.source : target;
|
|
16
|
+
const paths = exportTargets(selected).filter((path) => path.startsWith("./"));
|
|
17
|
+
return paths.length === 0 ? [] : [[name, paths]];
|
|
18
|
+
}));
|
|
19
|
+
}
|
|
20
|
+
export async function knipConfiguration(inputs) {
|
|
21
|
+
const packages = await workspacePackages(inputs);
|
|
22
|
+
const workspaces = await Promise.all([".", ...packages.map(({ directory }) => directory)].map(async (directory) => {
|
|
23
|
+
const text = await inputs.readText(posix.join(directory, "package.json"));
|
|
24
|
+
const manifest = Schema.decodeUnknownSync(Schema.fromJsonString(Manifest))(text ?? "{}");
|
|
25
|
+
const sources = inputs.sources
|
|
26
|
+
.filter(({ path }) => (packageOf(packages, path)?.directory ?? ".") === directory)
|
|
27
|
+
.map(({ path }) => posix.relative(directory, path));
|
|
28
|
+
const scriptWords = new Set(Object.values(manifest.scripts ?? {}).flatMap((script) => script.split(/[\s'"`;|&()]+/u)));
|
|
29
|
+
const scripted = sources.filter((path) => scriptWords.has(path) || scriptWords.has(`./${path}`));
|
|
30
|
+
const bins = exportTargets(manifest.bin).map((target) => target.replace(/^\.\//u, ""));
|
|
31
|
+
const binaries = sources.filter((path) => bins.includes(path) || bins.includes(path.replace(/^src\//u, "dist/").replace(/\.(?<mode>[cm]?)tsx?$/u, ".$<mode>js")));
|
|
32
|
+
const publicFiles = sources.filter((path) => exportedModule(manifest.exports, path));
|
|
33
|
+
return [
|
|
34
|
+
directory,
|
|
35
|
+
{ entry: [...ENTRIES, ...publicFiles, ...bins, ...binaries, ...scripted], paths: importPaths(manifest.imports ?? {}), project: sources },
|
|
36
|
+
];
|
|
37
|
+
}));
|
|
38
|
+
return {
|
|
39
|
+
exclude: [],
|
|
40
|
+
ignore: [],
|
|
41
|
+
ignoreBinaries: [],
|
|
42
|
+
ignoreDependencies: [],
|
|
43
|
+
ignoreExportsUsedInFile: false,
|
|
44
|
+
ignoreFiles: [],
|
|
45
|
+
ignoreIssues: {},
|
|
46
|
+
ignoreMembers: [],
|
|
47
|
+
ignoreUnresolved: [],
|
|
48
|
+
ignoreWorkspaces: [],
|
|
49
|
+
include: KNIP_ISSUES,
|
|
50
|
+
includeEntryExports: false,
|
|
51
|
+
rules: Object.fromEntries(KNIP_ISSUES.map((kind) => [kind, "error"])),
|
|
52
|
+
tags: [],
|
|
53
|
+
workspaces: Object.fromEntries(workspaces),
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=configuration.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../src/adapters/knip/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAErE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACtE,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;CACrE,CAAC,CAAC;AAEH,MAAM,OAAO,GAAG,CAAC,gEAAgE,EAAE,qBAAqB,EAAE,kCAAkC,CAAC,CAAC;AAE9I,SAAS,WAAW,CAAC,OAA0C;IAC9D,OAAO,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QAClD,MAAM,QAAQ,GAAG,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAC9G,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CACF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,MAAkB;IACzD,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CACnC,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QAC5E,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QACzF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO;aAC5B,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,SAAS,IAAI,GAAG,CAAC,KAAK,SAAS,CAAC;aACjF,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACvH,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QACjG,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QACvF,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAC9B,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC,CAChI,CAAC;QACF,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;QACrF,OAAO;YACN,SAAS;YACT,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;SAC/H,CAAC;IACZ,CAAC,CAAC,CACF,CAAC;IACF,OAAO;QACN,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,EAAE;QACV,cAAc,EAAE,EAAE;QAClB,kBAAkB,EAAE,EAAE;QACtB,uBAAuB,EAAE,KAAK;QAC9B,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,EAAE;QAChB,aAAa,EAAE,EAAE;QACjB,gBAAgB,EAAE,EAAE;QACpB,gBAAgB,EAAE,EAAE;QACpB,OAAO,EAAE,WAAW;QACpB,mBAAmB,EAAE,KAAK;QAC1B,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACrE,IAAI,EAAE,EAAE;QACR,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;KAC1C,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entryPointFindings.d.ts","sourceRoot":"","sources":["../../../src/adapters/knip/entryPointFindings.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAErD,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CA6ClG"}
|
|
@@ -0,0 +1,49 @@
|
|
|
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
|
+
export async function entryPointFindings(inputs, findings) {
|
|
8
|
+
const graph = await importGraph(inputs);
|
|
9
|
+
const unusedFiles = new Set(findings.filter((finding) => finding.subject?.startsWith("files:")).map((finding) => finding.file));
|
|
10
|
+
const workspace = new Map(graph.packages.map(({ name, directory }) => [name, directory]));
|
|
11
|
+
const directories = [".", ...graph.packages.map(({ directory }) => directory)];
|
|
12
|
+
const policies = new Map(await Promise.all(directories.map(async (directory) => {
|
|
13
|
+
const manifest = JSON.parse((await inputs.readText(posix.join(directory, "package.json"))) ?? "{}");
|
|
14
|
+
return [directory, isApplication(manifest) ? await entryPointsOf(inputs, directory, manifest, workspace) : []];
|
|
15
|
+
})));
|
|
16
|
+
function owner(path) {
|
|
17
|
+
return packageOf(graph.packages, path)?.directory ?? ".";
|
|
18
|
+
}
|
|
19
|
+
function development(directory, path) {
|
|
20
|
+
return isTestCode(path) || isTooling(directory, path);
|
|
21
|
+
}
|
|
22
|
+
return findings.filter((finding) => {
|
|
23
|
+
const [kind, name] = finding.subject?.split(":") ?? [];
|
|
24
|
+
if (name === undefined) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
const directory = owner(finding.file);
|
|
28
|
+
const entries = policies.get(directory) ?? [];
|
|
29
|
+
if (kind === "unlisted") {
|
|
30
|
+
return provider(entries, name, development(directory, finding.file), true) === undefined;
|
|
31
|
+
}
|
|
32
|
+
if (kind !== "dependencies" && kind !== "devDependencies") {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
return ![...graph.edges, ...graph.unresolved].some((edge) => {
|
|
36
|
+
if (owner(edge.from) !== directory || unusedFiles.has(edge.from)) {
|
|
37
|
+
return false;
|
|
38
|
+
}
|
|
39
|
+
const target = /^[.#/]/u.test(edge.specifier)
|
|
40
|
+
? undefined
|
|
41
|
+
: edge.specifier
|
|
42
|
+
.split("/")
|
|
43
|
+
.slice(0, edge.specifier.startsWith("@") ? 2 : 1)
|
|
44
|
+
.join("/");
|
|
45
|
+
return target !== undefined && provider(entries, target, development(directory, edge.from), true)?.name === name;
|
|
46
|
+
});
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=entryPointFindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entryPointFindings.js","sourceRoot":"","sources":["../../../src/adapters/knip/entryPointFindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGjD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,MAAkB,EAAE,QAAkB;IAC9E,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAChI,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1F,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,IAAI,GAAG,CACvB,MAAM,OAAO,CAAC,GAAG,CAChB,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACnC,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC;QAC7G,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,aAAa,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAU,CAAC;IACzH,CAAC,CAAC,CACF,CACD,CAAC;IACF,SAAS,KAAK,CAAC,IAAY;QAC1B,OAAO,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,SAAS,IAAI,GAAG,CAAC;IAC1D,CAAC;IACD,SAAS,WAAW,CAAC,SAAiB,EAAE,IAAY;QACnD,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACb,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,SAAS,CAAC;QAC1F,CAAC;QACD,IAAI,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC;QACb,CAAC;QACD,OAAO,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClE,OAAO,KAAK,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC5C,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAI,CAAC,SAAS;qBACb,KAAK,CAAC,GAAG,CAAC;qBACV,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;qBAChD,IAAI,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;QAClH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { Finding } from "#rule.ts";
|
|
2
|
+
export declare const KNIP_ISSUES: ("dependencies" | "devDependencies" | "exports" | "files" | "nsExports" | "nsTypes" | "optionalPeerDependencies" | "types" | "unlisted")[];
|
|
3
|
+
export declare function knipFindings(stdout: string): readonly Finding[];
|
|
4
|
+
//# sourceMappingURL=findings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"findings.d.ts","sourceRoot":"","sources":["../../../src/adapters/knip/findings.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AA6BxC,eAAO,MAAM,WAAW,4IAAgC,CAAC;AAEzD,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,OAAO,EAAE,CAa/D"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
const ReportSymbol = Schema.Struct({ line: Schema.optional(Schema.Number), name: Schema.String });
|
|
3
|
+
const Issue = Schema.Struct({
|
|
4
|
+
dependencies: Schema.optional(Schema.Array(ReportSymbol)),
|
|
5
|
+
devDependencies: Schema.optional(Schema.Array(ReportSymbol)),
|
|
6
|
+
exports: Schema.optional(Schema.Array(ReportSymbol)),
|
|
7
|
+
file: Schema.String,
|
|
8
|
+
files: Schema.optional(Schema.Array(ReportSymbol)),
|
|
9
|
+
nsExports: Schema.optional(Schema.Array(ReportSymbol)),
|
|
10
|
+
nsTypes: Schema.optional(Schema.Array(ReportSymbol)),
|
|
11
|
+
optionalPeerDependencies: Schema.optional(Schema.Array(ReportSymbol)),
|
|
12
|
+
types: Schema.optional(Schema.Array(ReportSymbol)),
|
|
13
|
+
unlisted: Schema.optional(Schema.Array(ReportSymbol)),
|
|
14
|
+
});
|
|
15
|
+
const Report = Schema.Struct({ issues: Schema.Array(Issue) });
|
|
16
|
+
const REPAIRS = [
|
|
17
|
+
["dependencies", "Unused dependency. Remove it from the package manifest if it is no longer needed"],
|
|
18
|
+
["devDependencies", "Unused development dependency. Remove it from the package manifest if it is no longer needed"],
|
|
19
|
+
["exports", "Unused export. Remove the export or use it from an entry point"],
|
|
20
|
+
["files", "Unused file. Remove it or reach it from a declared entry point"],
|
|
21
|
+
["nsExports", "Unused namespace export. Remove the export or use it from an entry point"],
|
|
22
|
+
["nsTypes", "Unused namespace type. Remove the export or use it from an entry point"],
|
|
23
|
+
["optionalPeerDependencies", "Unused optional peer dependency. Remove it from the package manifest if it is no longer needed"],
|
|
24
|
+
["types", "Unused exported type. Remove the export or use it from an entry point"],
|
|
25
|
+
["unlisted", "Missing package dependency. Declare it in the importing package's manifest"],
|
|
26
|
+
];
|
|
27
|
+
export const KNIP_ISSUES = REPAIRS.map(([kind]) => kind);
|
|
28
|
+
export function knipFindings(stdout) {
|
|
29
|
+
const report = Schema.decodeUnknownSync(Schema.fromJsonString(Report))(stdout);
|
|
30
|
+
return report.issues.flatMap((issue) => REPAIRS.flatMap(([kind, repair]) => {
|
|
31
|
+
const symbols = issue[kind];
|
|
32
|
+
return (symbols ?? []).map((symbol) => ({
|
|
33
|
+
file: issue.file,
|
|
34
|
+
line: symbol.line,
|
|
35
|
+
message: `${repair}: ${symbol.name}.`,
|
|
36
|
+
subject: `${kind}:${symbol.name}`,
|
|
37
|
+
}));
|
|
38
|
+
}));
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=findings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"findings.js","sourceRoot":"","sources":["../../../src/adapters/knip/findings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAClG,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC5D,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAClD,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACtD,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACpD,wBAAwB,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACrE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAClD,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;CACrD,CAAC,CAAC;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAE9D,MAAM,OAAO,GAAG;IACf,CAAC,cAAc,EAAE,kFAAkF,CAAC;IACpG,CAAC,iBAAiB,EAAE,8FAA8F,CAAC;IACnH,CAAC,SAAS,EAAE,gEAAgE,CAAC;IAC7E,CAAC,OAAO,EAAE,gEAAgE,CAAC;IAC3E,CAAC,WAAW,EAAE,0EAA0E,CAAC;IACzF,CAAC,SAAS,EAAE,wEAAwE,CAAC;IACrF,CAAC,0BAA0B,EAAE,gGAAgG,CAAC;IAC9H,CAAC,OAAO,EAAE,uEAAuE,CAAC;IAClF,CAAC,UAAU,EAAE,4EAA4E,CAAC;CACjF,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAEzD,MAAM,UAAU,YAAY,CAAC,MAAc;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACvC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,GAAG,MAAM,KAAK,MAAM,CAAC,IAAI,GAAG;YACrC,OAAO,EAAE,GAAG,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE;SACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CACF,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/adapters/knip/run.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAO3C,wBAAsB,OAAO,CAAC,MAAM,EAAE,UAAU,wCA8C/C"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { createRequire } from "node:module";
|
|
2
|
+
import { basename, dirname, join, posix } from "node:path";
|
|
3
|
+
import process from "node:process";
|
|
4
|
+
import { NodeServices } from "@effect/platform-node";
|
|
5
|
+
import { Effect, FileSystem, Stream } from "effect";
|
|
6
|
+
import { ChildProcess, ChildProcessSpawner } from "effect/process";
|
|
7
|
+
import { knipConfiguration } from "./configuration.js";
|
|
8
|
+
import { entryPointFindings } from "./entryPointFindings.js";
|
|
9
|
+
import { KNIP_ISSUES, knipFindings } from "./findings.js";
|
|
10
|
+
import { sourceConfig } from "./sourceConfig.js";
|
|
11
|
+
const BIN = join(dirname(createRequire(import.meta.url).resolve("knip")), "..", "bin", "knip.js");
|
|
12
|
+
export async function runKnip(inputs) {
|
|
13
|
+
if ((await inputs.readText("package.json")) === undefined) {
|
|
14
|
+
return [];
|
|
15
|
+
}
|
|
16
|
+
const configuration = await knipConfiguration(inputs);
|
|
17
|
+
const checked = new Set([...inputs.files, ...Object.keys(configuration.workspaces).map((directory) => posix.join(directory, "package.json"))]);
|
|
18
|
+
const findings = await Effect.runPromise(Effect.scoped(Effect.gen(function* () {
|
|
19
|
+
const fs = yield* FileSystem.FileSystem;
|
|
20
|
+
const temporary = yield* fs.makeTempDirectoryScoped({ prefix: "quality-knip-" });
|
|
21
|
+
const config = join(temporary, "knip.json");
|
|
22
|
+
yield* fs.writeFileString(config, JSON.stringify(configuration));
|
|
23
|
+
const tsconfig = yield* sourceConfig(inputs, Object.keys(configuration.workspaces), basename(temporary));
|
|
24
|
+
const spawner = yield* ChildProcessSpawner.ChildProcessSpawner;
|
|
25
|
+
const child = yield* spawner.spawn(ChildProcess.make(process.execPath, [
|
|
26
|
+
"--conditions=source",
|
|
27
|
+
BIN,
|
|
28
|
+
"--config",
|
|
29
|
+
config,
|
|
30
|
+
"--tsConfig",
|
|
31
|
+
tsconfig,
|
|
32
|
+
"--reporter",
|
|
33
|
+
"json",
|
|
34
|
+
"--include",
|
|
35
|
+
KNIP_ISSUES.join(","),
|
|
36
|
+
"--no-progress",
|
|
37
|
+
], { cwd: inputs.root, env: { "JITI_TRY_NATIVE": "true" }, extendEnv: true, stdin: "ignore" }));
|
|
38
|
+
const [stdout, stderr, code] = yield* Effect.all([Stream.mkString(Stream.decodeText(child.stdout)), Stream.mkString(Stream.decodeText(child.stderr)), child.exitCode], { concurrency: "unbounded" });
|
|
39
|
+
if (Number(code) > 1) {
|
|
40
|
+
return yield* Effect.fail(new Error(`knip failed: ${stderr || `exit code ${code}`}`));
|
|
41
|
+
}
|
|
42
|
+
return knipFindings(stdout).filter((finding) => checked.has(finding.file));
|
|
43
|
+
})).pipe(Effect.provide(NodeServices.layer)));
|
|
44
|
+
return entryPointFindings(inputs, findings);
|
|
45
|
+
}
|
|
46
|
+
//# sourceMappingURL=run.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"run.js","sourceRoot":"","sources":["../../../src/adapters/knip/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;AAClG,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,MAAkB;IAC/C,IAAI,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;QAC3D,OAAO,EAAE,CAAC;IACX,CAAC;IACD,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/I,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,UAAU,CACvC,MAAM,CAAC,MAAM,CACZ,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACnB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;QACxC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,uBAAuB,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;QACjF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC5C,KAAK,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACzG,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,mBAAmB,CAAC,mBAAmB,CAAC;QAC/D,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CACjC,YAAY,CAAC,IAAI,CAChB,OAAO,CAAC,QAAQ,EAChB;YACC,qBAAqB;YACrB,GAAG;YACH,UAAU;YACV,MAAM;YACN,YAAY;YACZ,QAAQ;YACR,YAAY;YACZ,MAAM;YACN,WAAW;YACX,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;YACrB,eAAe;SACf,EACD,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAC1F,CACD,CAAC;QACF,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAC/C,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,EACpH,EAAE,WAAW,EAAE,WAAW,EAAE,CAC5B,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,gBAAgB,MAAM,IAAI,aAAa,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CACF,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAC1C,CAAC;IACF,OAAO,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC7C,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Effect, FileSystem } from "effect";
|
|
2
|
+
import type { RuleInputs } from "#rule.ts";
|
|
3
|
+
export declare const sourceConfig: (inputs: RuleInputs, directories: readonly string[], id: string) => Effect.Effect<string, import("effect/PlatformError").PlatformError, FileSystem.FileSystem | import("effect/Scope").Scope>;
|
|
4
|
+
//# sourceMappingURL=sourceConfig.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sourceConfig.d.ts","sourceRoot":"","sources":["../../../src/adapters/knip/sourceConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,eAAO,MAAM,YAAY,+LAevB,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { join, posix, resolve } from "node:path";
|
|
2
|
+
import { Effect, FileSystem } from "effect";
|
|
3
|
+
export const sourceConfig = Effect.fn("Knip.sourceConfig")(function* (inputs, directories, id) {
|
|
4
|
+
const fs = yield* FileSystem.FileSystem;
|
|
5
|
+
const relative = posix.join("node_modules", ".cache", "quality", id, "tsconfig.json");
|
|
6
|
+
for (const directory of directories) {
|
|
7
|
+
const folder = join(inputs.root, directory, "node_modules", ".cache", "quality", id);
|
|
8
|
+
yield* fs.makeDirectory(folder, { recursive: true });
|
|
9
|
+
yield* Effect.addFinalizer(() => fs.remove(folder, { recursive: true }).pipe(Effect.orDie));
|
|
10
|
+
const parents = yield* Effect.forEach(["tsconfig.json", "tsconfig.build.json"], (file) => Effect.promise(() => inputs.readText(posix.join(directory, file))).pipe(Effect.map((text) => (text === undefined ? [] : [resolve(inputs.root, directory, file)]))));
|
|
11
|
+
yield* fs.writeFileString(join(folder, "tsconfig.json"), JSON.stringify({ extends: parents.flat(), files: [] }));
|
|
12
|
+
}
|
|
13
|
+
return relative;
|
|
14
|
+
});
|
|
15
|
+
//# sourceMappingURL=sourceConfig.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sourceConfig.js","sourceRoot":"","sources":["../../../src/adapters/knip/sourceConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAG5C,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAkB,EAAE,WAA8B,EAAE,EAAU;IACnI,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,eAAe,CAAC,CAAC;IACtF,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QACrF,KAAK,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACrD,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5F,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CACxF,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CACtE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CACzF,CACD,CAAC;QACF,KAAK,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAClH,CAAC;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { resolve } from "node:path";
|
|
|
2
2
|
import ts from "typescript";
|
|
3
3
|
import { nativeEffectCall } from "./nativeEffectCall.js";
|
|
4
4
|
import { nodeAt, offsetOf, syntaxOf } from "./syntax.js";
|
|
5
|
-
const RECOGNIZED = new Set(["lint/
|
|
5
|
+
const RECOGNIZED = new Set(["lint/correctness/noComponentHookFactories", "lint/style/noDoneCallback"]);
|
|
6
6
|
function generatorParameter(node) {
|
|
7
7
|
const parameter = node.parent;
|
|
8
8
|
const callback = parameter.parent;
|
|
@@ -36,7 +36,7 @@ function misclassified(diagnostic, syntax) {
|
|
|
36
36
|
switch (diagnostic.category) {
|
|
37
37
|
case "lint/style/noDoneCallback":
|
|
38
38
|
return generatorParameter(node);
|
|
39
|
-
case "lint/
|
|
39
|
+
case "lint/correctness/noComponentHookFactories":
|
|
40
40
|
return tagHandler(node, syntax);
|
|
41
41
|
default:
|
|
42
42
|
return false;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"recognizeDiagnostics.js","sourceRoot":"","sources":["../../src/biome/recognizeDiagnostics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAe,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtE,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"recognizeDiagnostics.js","sourceRoot":"","sources":["../../src/biome/recognizeDiagnostics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAe,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEtE,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC,CAAC,2CAA2C,EAAE,2BAA2B,CAAC,CAAC,CAAC;AAE5H,SAAS,kBAAkB,CAAC,IAAa;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;IAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC;IAClC,OAAO,CACN,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC;WACtB,SAAS,CAAC,IAAI,KAAK,IAAI;WACvB,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC;WACjC,QAAQ,CAAC,aAAa,KAAK,SAAS;WACpC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC;WACpC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAC/C,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAa,EAAE,MAAc;IAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACpH,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC;IACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC7B,OAAO,CACN,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC;WACxC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;WACjC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC;WACxC,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAC9D,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,UAAsB,EAAE,MAAc;IAC5D,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC;IAC3C,MAAM,IAAI,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxE,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,IAAI,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IAClG,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,QAAQ,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC7B,KAAK,2BAA2B;YAC/B,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACjC,KAAK,2CAA2C;YAC/C,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjC;YACC,OAAO,KAAK,CAAC;IACf,CAAC;AACF,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,WAAkC;IACpF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;QACxC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC;QACb,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1B,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface DocumentedImport {
|
|
2
|
+
readonly line: number;
|
|
3
|
+
readonly name?: string;
|
|
4
|
+
readonly specifier: string;
|
|
5
|
+
readonly typeOnly?: boolean;
|
|
6
|
+
}
|
|
7
|
+
export interface DocumentedScope {
|
|
8
|
+
readonly owner?: string | undefined;
|
|
9
|
+
readonly packages: (name: string) => boolean;
|
|
10
|
+
}
|
|
11
|
+
export declare function documentedImports(markdown: string, scope: DocumentedScope): readonly DocumentedImport[];
|
|
12
|
+
//# sourceMappingURL=documentedImports.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentedImports.d.ts","sourceRoot":"","sources":["../../src/docs/documentedImports.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,gBAAgB;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;CAC7C;AAsFD,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,SAAS,gBAAgB,EAAE,CAGvG"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { packageNameOf } from "#imports/packageName.ts";
|
|
3
|
+
import { codeSpans, markdownLines } from "./markdownLines.js";
|
|
4
|
+
const CODE_LANGUAGES = new Set(["js", "jsx", "mjs", "mts", "ts", "tsx", "typescript"]);
|
|
5
|
+
const MODULE = /^(?:@[\w.-]+\/)?[\w.-]+\/[\w./-]+\.[cm]?[jt]sx?$/u;
|
|
6
|
+
const OWN_MODULE = /^[\w-]+(?:\/[\w.-]+)*\.ts$/u;
|
|
7
|
+
const NAMED = /`(?<name>\w+)` from `(?<specifier>[^`]+)`/gu;
|
|
8
|
+
const HEADING = /^(?<level>#{1,6})\s+(?<title>.+)$/u;
|
|
9
|
+
function declarationImports(statement, line) {
|
|
10
|
+
if (!(ts.isImportDeclaration(statement) && ts.isStringLiteral(statement.moduleSpecifier))) {
|
|
11
|
+
return [];
|
|
12
|
+
}
|
|
13
|
+
const specifier = statement.moduleSpecifier.text;
|
|
14
|
+
const clause = statement.importClause;
|
|
15
|
+
const named = clause?.namedBindings !== undefined && ts.isNamedImports(clause.namedBindings) ? clause.namedBindings.elements : [];
|
|
16
|
+
return [
|
|
17
|
+
{ line, specifier },
|
|
18
|
+
...(clause?.name === undefined ? [] : [{ line, name: "default", specifier, typeOnly: clause.isTypeOnly }]),
|
|
19
|
+
...named.map((entry) => ({
|
|
20
|
+
line,
|
|
21
|
+
name: (entry.propertyName ?? entry.name).text,
|
|
22
|
+
specifier,
|
|
23
|
+
typeOnly: clause?.isTypeOnly === true || entry.isTypeOnly,
|
|
24
|
+
})),
|
|
25
|
+
];
|
|
26
|
+
}
|
|
27
|
+
function codeBlocks(lines) {
|
|
28
|
+
const blocks = [];
|
|
29
|
+
for (const [index, line] of lines.entries()) {
|
|
30
|
+
if (line.kind === "code" && CODE_LANGUAGES.has(line.language)) {
|
|
31
|
+
const last = blocks.at(-1);
|
|
32
|
+
if (last !== undefined && lines[index - 1]?.kind === "code") {
|
|
33
|
+
last.text.push(line.text);
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
blocks.push({ first: line.number, text: [line.text] });
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return blocks.map((block) => ({ first: block.first, text: block.text.join("\n") }));
|
|
41
|
+
}
|
|
42
|
+
function codeImports(lines) {
|
|
43
|
+
return codeBlocks(lines).flatMap((block) => {
|
|
44
|
+
const file = ts.createSourceFile("block.tsx", block.text, ts.ScriptTarget.Latest, true, ts.ScriptKind.TSX);
|
|
45
|
+
return file.statements.flatMap((statement) => declarationImports(statement, block.first + file.getLineAndCharacterOfPosition(statement.getStart(file)).line));
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
function apiLevel(text, current) {
|
|
49
|
+
const heading = HEADING.exec(text);
|
|
50
|
+
if (heading === null) {
|
|
51
|
+
return current;
|
|
52
|
+
}
|
|
53
|
+
const level = heading.groups?.level?.length ?? 0;
|
|
54
|
+
if (/^API\b/u.test(heading.groups?.title ?? "")) {
|
|
55
|
+
return level;
|
|
56
|
+
}
|
|
57
|
+
return current !== undefined && level <= current ? undefined : current;
|
|
58
|
+
}
|
|
59
|
+
function firstCell(text) {
|
|
60
|
+
return text.startsWith("|") ? (text.split("|")[1] ?? "") : "";
|
|
61
|
+
}
|
|
62
|
+
function proseImports(lines, owner) {
|
|
63
|
+
const found = [];
|
|
64
|
+
let api;
|
|
65
|
+
for (const { number: line, text } of lines.filter((entry) => entry.kind === "prose")) {
|
|
66
|
+
api = apiLevel(text, api);
|
|
67
|
+
found.push(...codeSpans(text).flatMap((span) => (MODULE.test(span) ? [{ line, specifier: span }] : [])));
|
|
68
|
+
found.push(...[...text.matchAll(NAMED)].map((match) => ({ line, name: match.groups?.name ?? "", specifier: match.groups?.specifier ?? "" })));
|
|
69
|
+
if (owner !== undefined) {
|
|
70
|
+
const listed = api === undefined ? firstCell(text) : text;
|
|
71
|
+
found.push(...codeSpans(listed).flatMap((span) => (OWN_MODULE.test(span) ? [{ line, specifier: `${owner}/${span}` }] : [])));
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
return found;
|
|
75
|
+
}
|
|
76
|
+
export function documentedImports(markdown, scope) {
|
|
77
|
+
const lines = markdownLines(markdown);
|
|
78
|
+
return [...codeImports(lines), ...proseImports(lines, scope.owner)].filter((entry) => scope.packages(packageNameOf(entry.specifier)));
|
|
79
|
+
}
|
|
80
|
+
//# sourceMappingURL=documentedImports.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentedImports.js","sourceRoot":"","sources":["../../src/docs/documentedImports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAqB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAcjF,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;AAE5G,MAAM,MAAM,GAAG,mDAAmD,CAAC;AAEnE,MAAM,UAAU,GAAG,6BAA6B,CAAC;AAEjD,MAAM,KAAK,GAAG,6CAA6C,CAAC;AAE5D,MAAM,OAAO,GAAG,oCAAoC,CAAC;AAErD,SAAS,kBAAkB,CAAC,SAAuB,EAAE,IAAY;IAChE,IAAI,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC;QAC3F,OAAO,EAAE,CAAC;IACX,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC;IACjD,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC;IACtC,MAAM,KAAK,GAAG,MAAM,EAAE,aAAa,KAAK,SAAS,IAAI,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAClI,OAAO;QACN,EAAE,IAAI,EAAE,SAAS,EAAE;QACnB,GAAG,CAAC,MAAM,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1G,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACxB,IAAI;YACJ,IAAI,EAAE,CAAC,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI;YAC7C,SAAS;YACT,QAAQ,EAAE,MAAM,EAAE,UAAU,KAAK,IAAI,IAAI,KAAK,CAAC,UAAU;SACzD,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAA8B;IACjD,MAAM,MAAM,GAA6C,EAAE,CAAC;IAC5D,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC7D,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,SAAS,WAAW,CAAC,KAA8B;IAClD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,EAAE,CAAC,gBAAgB,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC3G,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAC5C,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAC9G,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,OAA2B;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;IACjD,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,OAAO,KAAK,SAAS,IAAI,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AACxE,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,YAAY,CAAC,KAA8B,EAAE,KAAyB;IAC9E,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,IAAI,GAAuB,CAAC;IAC5B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;QACtF,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9I,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,MAAM,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1D,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9H,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAgB,EAAE,KAAsB;IACzE,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACvI,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { WorkspacePackage } from "#imports/workspace.ts";
|
|
2
|
+
export type DocumentedModule = {
|
|
3
|
+
readonly kind: "missing";
|
|
4
|
+
} | {
|
|
5
|
+
readonly kind: "private";
|
|
6
|
+
} | {
|
|
7
|
+
readonly kind: "source";
|
|
8
|
+
readonly path: string;
|
|
9
|
+
};
|
|
10
|
+
export declare function documentedModule(root: string, owner: WorkspacePackage, exports: unknown, specifier: string): DocumentedModule;
|
|
11
|
+
//# sourceMappingURL=documentedModule.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentedModule.d.ts","sourceRoot":"","sources":["../../src/docs/documentedModule.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D,MAAM,MAAM,gBAAgB,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAkBhJ,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,gBAAgB,CAoB7H"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { join, posix } from "node:path";
|
|
2
|
+
import ts from "typescript";
|
|
3
|
+
import { exportEntry, exportTargets } from "#imports/packageExports.ts";
|
|
4
|
+
const BUILT = /^\.\/dist\/(?<path>.+?)(?:\.d)?\.[cm]?[jt]s$/u;
|
|
5
|
+
const SOURCE_EXTENSIONS = [".ts", ".tsx", ".mts", ".cts"];
|
|
6
|
+
const MISSING = { kind: "missing" };
|
|
7
|
+
function sourcesFor(target) {
|
|
8
|
+
const built = BUILT.exec(target)?.groups?.path;
|
|
9
|
+
return built === undefined ? [target] : [target, ...SOURCE_EXTENSIONS.map((extension) => `./src/${built}${extension}`)];
|
|
10
|
+
}
|
|
11
|
+
function found(root, directory, candidates) {
|
|
12
|
+
const path = candidates.map((candidate) => posix.join(directory, candidate)).find((candidate) => ts.sys.fileExists(join(root, candidate)));
|
|
13
|
+
return path === undefined ? MISSING : { kind: "source", path };
|
|
14
|
+
}
|
|
15
|
+
export function documentedModule(root, owner, exports, specifier) {
|
|
16
|
+
const rest = specifier.slice(owner.name.length);
|
|
17
|
+
const subpath = rest === "" ? "." : `.${rest}`;
|
|
18
|
+
if (exports === undefined || exports === null) {
|
|
19
|
+
return found(root, owner.directory, [subpath]);
|
|
20
|
+
}
|
|
21
|
+
const entry = exportEntry(typeof exports === "string" || Array.isArray(exports) ? { ".": exports } : exports, subpath);
|
|
22
|
+
if (entry === undefined) {
|
|
23
|
+
return MISSING;
|
|
24
|
+
}
|
|
25
|
+
if (entry[1] === null) {
|
|
26
|
+
return { kind: "private" };
|
|
27
|
+
}
|
|
28
|
+
const [prefix = "", suffix = ""] = entry[0].split("*");
|
|
29
|
+
const star = subpath.slice(prefix.length, subpath.length - suffix.length);
|
|
30
|
+
return found(root, owner.directory, exportTargets(entry[1]).flatMap((target) => sourcesFor(target.replace("*", star))));
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=documentedModule.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentedModule.js","sourceRoot":"","sources":["../../src/docs/documentedModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAKxE,MAAM,KAAK,GAAG,+CAA+C,CAAC;AAE9D,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAE1D,MAAM,OAAO,GAAqB,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAEtD,SAAS,UAAU,CAAC,MAAc;IACjC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC;IAC/C,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;AACzH,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,SAAiB,EAAE,UAA6B;IAC5E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3I,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAuB,EAAE,OAAgB,EAAE,SAAiB;IAC1G,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAC/C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC5B,CAAC;IACD,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1E,OAAO,KAAK,CACX,IAAI,EACJ,KAAK,CAAC,SAAS,EACf,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAClF,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exportsName.d.ts","sourceRoot":"","sources":["../../src/docs/exportsName.ts"],"names":[],"mappings":"AAiBA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CASzF"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { ownExports } from "#naming/ownExports.ts";
|
|
3
|
+
import { parse } from "#rules/parse.ts";
|
|
4
|
+
function isDefault(statement) {
|
|
5
|
+
if (ts.isExportAssignment(statement)) {
|
|
6
|
+
return !statement.isExportEquals;
|
|
7
|
+
}
|
|
8
|
+
const modifiers = ts.canHaveModifiers(statement) ? (ts.getModifiers(statement) ?? []) : [];
|
|
9
|
+
return modifiers.some((modifier) => modifier.kind === ts.SyntaxKind.DefaultKeyword);
|
|
10
|
+
}
|
|
11
|
+
function reexports(statement) {
|
|
12
|
+
return ts.isExportDeclaration(statement) && statement.moduleSpecifier !== undefined;
|
|
13
|
+
}
|
|
14
|
+
// A module that re-exports another may export any name that module does, so only a module without re-exports gets a definite answer.
|
|
15
|
+
export function exportsName(path, text, name) {
|
|
16
|
+
const source = parse({ lines: [], path, text });
|
|
17
|
+
if (source === undefined || source.statements.some(reexports)) {
|
|
18
|
+
return undefined;
|
|
19
|
+
}
|
|
20
|
+
if (name === "default") {
|
|
21
|
+
return source.statements.some(isDefault);
|
|
22
|
+
}
|
|
23
|
+
return ownExports(source).some((entry) => entry.name === name);
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=exportsName.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exportsName.js","sourceRoot":"","sources":["../../src/docs/exportsName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,SAAS,SAAS,CAAC,SAAuB;IACzC,IAAI,EAAE,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC;IAClC,CAAC;IACD,MAAM,SAAS,GAAG,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3F,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACrF,CAAC;AAED,SAAS,SAAS,CAAC,SAAuB;IACzC,OAAO,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,eAAe,KAAK,SAAS,CAAC;AACrF,CAAC;AAED,qIAAqI;AACrI,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAY,EAAE,IAAY;IACnE,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/D,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAChE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"headingAnchors.d.ts","sourceRoot":"","sources":["../../src/docs/headingAnchors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAcvD,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjD;AAiBD,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAkBlF"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
const ATX = /^ {0,3}#{1,6}\s+(?<title>.*?)(?:\s+#+)?\s*$/u;
|
|
2
|
+
const SETEXT = /^ {0,3}(?:=+|-+)\s*$/u;
|
|
3
|
+
const HTML_ANCHOR = /<a\s[^>]*\b(?:id|name)="(?<anchor>[^"]+)"/gu;
|
|
4
|
+
const LINK = /!?\[(?<text>[^\]]*)\]\([^)]*\)/gu;
|
|
5
|
+
const TAG = /<[^>]+>/gu;
|
|
6
|
+
const NOT_SLUG = /[^\p{L}\p{M}\p{N}\p{Pc} -]/gu;
|
|
7
|
+
export function headingSlug(title) {
|
|
8
|
+
return title.replace(LINK, "$<text>").replace(TAG, "").replaceAll("`", "").trim().toLowerCase().replace(NOT_SLUG, "").replaceAll(" ", "-");
|
|
9
|
+
}
|
|
10
|
+
function titleAt(lines, index) {
|
|
11
|
+
const line = lines[index];
|
|
12
|
+
if (line?.kind !== "prose") {
|
|
13
|
+
return undefined;
|
|
14
|
+
}
|
|
15
|
+
const atx = ATX.exec(line.text)?.groups?.title;
|
|
16
|
+
if (atx !== undefined) {
|
|
17
|
+
return atx;
|
|
18
|
+
}
|
|
19
|
+
const next = lines[index + 1];
|
|
20
|
+
const underlined = next?.kind === "prose" && SETEXT.test(next.text) && line.text.trim() !== "" && !SETEXT.test(line.text);
|
|
21
|
+
return underlined ? line.text.trim() : undefined;
|
|
22
|
+
}
|
|
23
|
+
// GitHub numbers a repeated heading's anchor -1, -2 and so on, in document order.
|
|
24
|
+
export function headingAnchors(lines) {
|
|
25
|
+
const anchors = new Set();
|
|
26
|
+
const seen = new Map();
|
|
27
|
+
for (const [index, line] of lines.entries()) {
|
|
28
|
+
const title = titleAt(lines, index);
|
|
29
|
+
if (title !== undefined) {
|
|
30
|
+
const slug = headingSlug(title);
|
|
31
|
+
const count = seen.get(slug) ?? 0;
|
|
32
|
+
seen.set(slug, count + 1);
|
|
33
|
+
anchors.add(count === 0 ? slug : `${slug}-${count}`);
|
|
34
|
+
}
|
|
35
|
+
if (line.kind === "prose") {
|
|
36
|
+
for (const match of line.text.matchAll(HTML_ANCHOR)) {
|
|
37
|
+
anchors.add((match.groups?.anchor ?? "").toLowerCase());
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
return anchors;
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=headingAnchors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"headingAnchors.js","sourceRoot":"","sources":["../../src/docs/headingAnchors.ts"],"names":[],"mappings":"AAEA,MAAM,GAAG,GAAG,8CAA8C,CAAC;AAE3D,MAAM,MAAM,GAAG,uBAAuB,CAAC;AAEvC,MAAM,WAAW,GAAG,6CAA6C,CAAC;AAElE,MAAM,IAAI,GAAG,kCAAkC,CAAC;AAEhD,MAAM,GAAG,GAAG,WAAW,CAAC;AAExB,MAAM,QAAQ,GAAG,8BAA8B,CAAC;AAEhD,MAAM,UAAU,WAAW,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAC5I,CAAC;AAED,SAAS,OAAO,CAAC,KAA8B,EAAE,KAAa;IAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,IAAI,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC;IAC/C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC9B,MAAM,UAAU,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1H,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,cAAc,CAAC,KAA8B;IAC5D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBACrD,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YACzD,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type { WorkspacePackage } from "#imports/workspace.ts";
|
|
3
|
+
import type { Finding } from "#rule.ts";
|
|
4
|
+
export interface ImportContext {
|
|
5
|
+
readonly exports: ReadonlyMap<string, unknown>;
|
|
6
|
+
readonly owner: string | undefined;
|
|
7
|
+
readonly packages: ReadonlyMap<string, WorkspacePackage>;
|
|
8
|
+
readonly readText: (path: string) => Effect.Effect<string | undefined>;
|
|
9
|
+
readonly root: string;
|
|
10
|
+
}
|
|
11
|
+
export declare function importFindings(context: ImportContext, file: string, markdown: string): Effect.Effect<readonly Finding[]>;
|
|
12
|
+
//# sourceMappingURL=importFindings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"importFindings.d.ts","sourceRoot":"","sources":["../../src/docs/importFindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAKxC,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACzD,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACvE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AA+BD,wBAAgB,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,OAAO,EAAE,CAAC,CAgBxH"}
|