@shivaedev/quality 0.42.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 +51 -0
- package/README.md +98 -38
- package/biome/declarations.json +6 -1
- package/biome/plugins/ambient-runtime.grit +3 -1
- package/biome/preset.json +62 -62
- 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 +12 -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/effect/boundary.d.ts +2 -0
- package/dist/rules/effect/boundary.d.ts.map +1 -0
- package/dist/rules/effect/boundary.js +66 -0
- package/dist/rules/effect/boundary.js.map +1 -0
- package/dist/rules/effect/layerConstructor.d.ts +3 -0
- package/dist/rules/effect/layerConstructor.d.ts.map +1 -0
- package/dist/rules/effect/layerConstructor.js +35 -0
- package/dist/rules/effect/layerConstructor.js.map +1 -0
- package/dist/rules/effect/ownsParameters.d.ts +3 -0
- package/dist/rules/effect/ownsParameters.d.ts.map +1 -0
- package/dist/rules/effect/ownsParameters.js +45 -0
- package/dist/rules/effect/ownsParameters.js.map +1 -0
- package/dist/rules/effect/program.d.ts +4 -0
- package/dist/rules/effect/program.d.ts.map +1 -0
- package/dist/rules/effect/program.js +24 -0
- package/dist/rules/effect/program.js.map +1 -0
- package/dist/rules/effect/publicFunctions.d.ts +3 -0
- package/dist/rules/effect/publicFunctions.d.ts.map +1 -0
- package/dist/rules/effect/publicFunctions.js +68 -0
- package/dist/rules/effect/publicFunctions.js.map +1 -0
- package/dist/rules/effect/serviceCatalog.d.ts +8 -0
- package/dist/rules/effect/serviceCatalog.d.ts.map +1 -0
- package/dist/rules/effect/serviceCatalog.js +56 -0
- package/dist/rules/effect/serviceCatalog.js.map +1 -0
- package/dist/rules/effect/serviceFindings.d.ts +5 -0
- package/dist/rules/effect/serviceFindings.d.ts.map +1 -0
- package/dist/rules/effect/serviceFindings.js +88 -0
- package/dist/rules/effect/serviceFindings.js.map +1 -0
- package/dist/rules/effect/serviceOrigin.d.ts +3 -0
- package/dist/rules/effect/serviceOrigin.d.ts.map +1 -0
- package/dist/rules/effect/serviceOrigin.js +85 -0
- package/dist/rules/effect/serviceOrigin.js.map +1 -0
- package/dist/rules/effect/serviceParameters.d.ts +2 -0
- package/dist/rules/effect/serviceParameters.d.ts.map +1 -0
- package/dist/rules/effect/serviceParameters.js +33 -0
- package/dist/rules/effect/serviceParameters.js.map +1 -0
- package/dist/rules/effect/serviceTypes.d.ts +8 -0
- package/dist/rules/effect/serviceTypes.d.ts.map +1 -0
- package/dist/rules/effect/serviceTypes.js +94 -0
- package/dist/rules/effect/serviceTypes.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/react/jsxConditionals.d.ts +2 -0
- package/dist/rules/react/jsxConditionals.d.ts.map +1 -0
- package/dist/rules/react/jsxConditionals.js +54 -0
- package/dist/rules/react/jsxConditionals.js.map +1 -0
- package/dist/rules/stories/engineOf.d.ts.map +1 -1
- package/dist/rules/stories/engineOf.js +2 -1
- package/dist/rules/stories/engineOf.js.map +1 -1
- package/dist/rules/stories/namedValues.js +4 -4
- package/dist/rules/stories/namedValues.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 +5 -4
- 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 +12 -0
- package/src/rules/docs/references.ts +83 -0
- package/src/rules/docs/unversionedInstalls.ts +53 -0
- package/src/rules/effect/boundary.ts +75 -0
- package/src/rules/effect/layerConstructor.ts +40 -0
- package/src/rules/effect/ownsParameters.ts +46 -0
- package/src/rules/effect/program.ts +26 -0
- package/src/rules/effect/publicFunctions.ts +70 -0
- package/src/rules/effect/serviceCatalog.ts +57 -0
- package/src/rules/effect/serviceFindings.ts +96 -0
- package/src/rules/effect/serviceOrigin.ts +94 -0
- package/src/rules/effect/serviceParameters.ts +35 -0
- package/src/rules/effect/serviceTypes.ts +101 -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/react/jsxConditionals.ts +59 -0
- package/src/rules/stories/engineOf.ts +2 -1
- package/src/rules/stories/namedValues.ts +4 -4
- package/src/rules/stories/unitTests.ts +1 -1
- package/src/rules/unusedCode.ts +10 -0
|
@@ -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"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { packageNameOf } from "#imports/packageName.ts";
|
|
3
|
+
import { documentedImports } from "./documentedImports.js";
|
|
4
|
+
import { documentedModule } from "./documentedModule.js";
|
|
5
|
+
import { exportsName } from "./exportsName.js";
|
|
6
|
+
function missingExport(specifier, path, name) {
|
|
7
|
+
return name === "default"
|
|
8
|
+
? `"${specifier}" has no default export. Import a named export of ${path}, or the module whose default export you mean.`
|
|
9
|
+
: `"${specifier}" does not export ${name}. Name an export of ${path}, or the module that exports ${name}.`;
|
|
10
|
+
}
|
|
11
|
+
function problem(context, entry, module, owner) {
|
|
12
|
+
if (module.kind === "missing") {
|
|
13
|
+
return Effect.succeed(`"${entry.specifier}" names no module of ${owner.name}. Use the path of a module its package.json "exports" maps.`);
|
|
14
|
+
}
|
|
15
|
+
if (module.kind === "private") {
|
|
16
|
+
return Effect.succeed(`"${entry.specifier}" is private: the package.json "exports" of ${owner.name} blocks it. Document a module the package exports.`);
|
|
17
|
+
}
|
|
18
|
+
const name = entry.name;
|
|
19
|
+
if (name === undefined) {
|
|
20
|
+
return Effect.succeed(undefined);
|
|
21
|
+
}
|
|
22
|
+
return Effect.map(context.readText(module.path), (text) => text !== undefined && exportsName(module.path, text, name) === false ? missingExport(entry.specifier, module.path, name) : undefined);
|
|
23
|
+
}
|
|
24
|
+
export function importFindings(context, file, markdown) {
|
|
25
|
+
const entries = documentedImports(markdown, { owner: context.owner, packages: (name) => context.packages.has(name) });
|
|
26
|
+
const unique = [...new Map(entries.map((entry) => [`${entry.line} ${entry.specifier} ${entry.name ?? ""}`, entry])).values()];
|
|
27
|
+
return Effect.map(Effect.forEach(unique, (entry) => {
|
|
28
|
+
const owner = context.packages.get(packageNameOf(entry.specifier));
|
|
29
|
+
if (owner === undefined) {
|
|
30
|
+
return Effect.succeed([]);
|
|
31
|
+
}
|
|
32
|
+
const module = documentedModule(context.root, owner, context.exports.get(owner.name), entry.specifier);
|
|
33
|
+
return Effect.map(problem(context, entry, module, owner), (message) => message === undefined ? [] : [{ file, line: entry.line, message, subject: entry.specifier }]);
|
|
34
|
+
}), (findings) => [...new Map(findings.flat().map((finding) => [`${finding.line} ${finding.message}`, finding])).values()]);
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=importFindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"importFindings.js","sourceRoot":"","sources":["../../src/docs/importFindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAyB,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAyB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAU/C,SAAS,aAAa,CAAC,SAAiB,EAAE,IAAY,EAAE,IAAY;IACnE,OAAO,IAAI,KAAK,SAAS;QACxB,CAAC,CAAC,IAAI,SAAS,qDAAqD,IAAI,gDAAgD;QACxH,CAAC,CAAC,IAAI,SAAS,qBAAqB,IAAI,uBAAuB,IAAI,gCAAgC,IAAI,GAAG,CAAC;AAC7G,CAAC;AAED,SAAS,OAAO,CACf,OAAsB,EACtB,KAAuB,EACvB,MAAwB,EACxB,KAAuB;IAEvB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,SAAS,wBAAwB,KAAK,CAAC,IAAI,6DAA6D,CAAC,CAAC;IAC3I,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,OAAO,CACpB,IAAI,KAAK,CAAC,SAAS,+CAA+C,KAAK,CAAC,IAAI,oDAAoD,CAChI,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CACzD,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CACpI,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAsB,EAAE,IAAY,EAAE,QAAgB;IACpF,MAAM,OAAO,GAAG,iBAAiB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtH,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9H,OAAO,MAAM,CAAC,GAAG,CAChB,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;QAChC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACnE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAsB,EAAE,CACzF,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAC5F,CAAC;IACH,CAAC,CAAC,EACF,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CACtH,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isDocument.d.ts","sourceRoot":"","sources":["../../src/docs/isDocument.ts"],"names":[],"mappings":"AAGA,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEhD"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { posix } from "node:path";
|
|
2
|
+
// Released changelogs keep the links and commands of their release, so a later change does not rewrite history.
|
|
3
|
+
export function isDocument(path) {
|
|
4
|
+
return path.endsWith(".md") && posix.basename(path) !== "CHANGELOG.md";
|
|
5
|
+
}
|
|
6
|
+
//# sourceMappingURL=isDocument.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isDocument.js","sourceRoot":"","sources":["../../src/docs/isDocument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAElC,gHAAgH;AAChH,MAAM,UAAU,UAAU,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,cAAc,CAAC;AACxE,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type { Finding } from "#rule.ts";
|
|
3
|
+
import type { MarkdownLine } from "./markdownLines.ts";
|
|
4
|
+
import { type Repository } from "./repositoryLink.ts";
|
|
5
|
+
export interface LinkContext {
|
|
6
|
+
readonly anchors: (path: string) => Effect.Effect<ReadonlySet<string> | undefined>;
|
|
7
|
+
readonly published: string | undefined;
|
|
8
|
+
readonly repository: Repository | undefined;
|
|
9
|
+
readonly root: string;
|
|
10
|
+
}
|
|
11
|
+
export declare function linkFindings(context: LinkContext, file: string, lines: readonly MarkdownLine[]): Effect.Effect<readonly Finding[]>;
|
|
12
|
+
//# sourceMappingURL=linkFindings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"linkFindings.d.ts","sourceRoot":"","sources":["../../src/docs/linkFindings.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAExC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,KAAK,UAAU,EAAkB,MAAM,qBAAqB,CAAC;AAEtE,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC;IACnF,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AAkED,wBAAgB,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,OAAO,EAAE,CAAC,CAUlI"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { join, posix } from "node:path";
|
|
2
|
+
import { Effect, Result } from "effect";
|
|
3
|
+
import ts from "typescript";
|
|
4
|
+
import { markdownLinks } from "./markdownLinks.js";
|
|
5
|
+
import { repositoryLink } from "./repositoryLink.js";
|
|
6
|
+
const SCHEME = /^(?:[a-z][\d+.a-z-]*:|\/\/)/iu;
|
|
7
|
+
function decoded(text) {
|
|
8
|
+
return Result.getOrElse(Result.try(() => decodeURIComponent(text)), () => text);
|
|
9
|
+
}
|
|
10
|
+
function destination(file, target, repository) {
|
|
11
|
+
if (SCHEME.test(target)) {
|
|
12
|
+
const linked = repositoryLink(target, repository);
|
|
13
|
+
return linked === undefined ? undefined : { anchor: linked.anchor, path: posix.normalize(decoded(linked.path) || ".") };
|
|
14
|
+
}
|
|
15
|
+
const hash = target.indexOf("#");
|
|
16
|
+
const path = decoded(hash === -1 ? target : target.slice(0, hash));
|
|
17
|
+
const anchor = hash === -1 ? undefined : target.slice(hash + 1);
|
|
18
|
+
if (path === "") {
|
|
19
|
+
return { anchor, path: file };
|
|
20
|
+
}
|
|
21
|
+
return { anchor, path: path.startsWith("/") ? posix.normalize(path.slice(1) || ".") : posix.join(posix.dirname(file), path) };
|
|
22
|
+
}
|
|
23
|
+
function inside(path, directory) {
|
|
24
|
+
return path === directory || path.startsWith(`${directory}/`);
|
|
25
|
+
}
|
|
26
|
+
function exampleUrl(repository, to) {
|
|
27
|
+
const anchor = to.anchor === undefined ? "" : `#${to.anchor}`;
|
|
28
|
+
return repository === undefined ? "" : `, such as https://github.com/${repository.owner}/${repository.name}/blob/HEAD/${to.path}${anchor}`;
|
|
29
|
+
}
|
|
30
|
+
function placement(context, target, to) {
|
|
31
|
+
if (to.path === ".." || to.path.startsWith("../")) {
|
|
32
|
+
return `"${target}" leaves the repository. Link to a file inside it, or use an absolute URL.`;
|
|
33
|
+
}
|
|
34
|
+
const absolute = join(context.root, to.path);
|
|
35
|
+
if (!(ts.sys.fileExists(absolute) || ts.sys.directoryExists(absolute))) {
|
|
36
|
+
return `"${target}" links to ${to.path}, which does not exist. Link to the file's current path, or remove the link.`;
|
|
37
|
+
}
|
|
38
|
+
if (context.published !== undefined && !SCHEME.test(target) && !inside(to.path, context.published)) {
|
|
39
|
+
return `"${target}" leaves its package, and npm shows ${context.published}/README.md without the repository around it. Use an absolute URL${exampleUrl(context.repository, to)}.`;
|
|
40
|
+
}
|
|
41
|
+
return undefined;
|
|
42
|
+
}
|
|
43
|
+
function problem(context, target, to) {
|
|
44
|
+
const misplaced = placement(context, target, to);
|
|
45
|
+
const anchor = to.anchor;
|
|
46
|
+
if (misplaced !== undefined || anchor === undefined || anchor === "" || !to.path.endsWith(".md")) {
|
|
47
|
+
return Effect.succeed(misplaced);
|
|
48
|
+
}
|
|
49
|
+
return Effect.map(context.anchors(to.path), (anchors) => anchors === undefined || anchors.has(decoded(anchor).toLowerCase())
|
|
50
|
+
? undefined
|
|
51
|
+
: `"${target}" links to the heading #${anchor}, which ${to.path} does not have. Link to a current heading; GitHub forms its anchor from the heading text.`);
|
|
52
|
+
}
|
|
53
|
+
export function linkFindings(context, file, lines) {
|
|
54
|
+
return Effect.map(Effect.forEach(markdownLinks(lines), (link) => {
|
|
55
|
+
const to = destination(file, link.target, context.repository);
|
|
56
|
+
return Effect.map(to === undefined ? Effect.succeed(undefined) : problem(context, link.target, to), (message) => message === undefined ? [] : [{ file, line: link.line, message, subject: link.target }]);
|
|
57
|
+
}), (findings) => findings.flat());
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=linkFindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"linkFindings.js","sourceRoot":"","sources":["../../src/docs/linkFindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,MAAM,YAAY,CAAC;AAG5B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAmB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AActE,MAAM,MAAM,GAAG,+BAA+B,CAAC;AAE/C,SAAS,OAAO,CAAC,IAAY;IAC5B,OAAO,MAAM,CAAC,SAAS,CACtB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAC1C,GAAG,EAAE,CAAC,IAAI,CACV,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc,EAAE,UAAkC;IACpF,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAClD,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;IACzH,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QACjB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;AAC/H,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,SAAiB;IAC9C,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,UAAkC,EAAE,EAAe;IACtE,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;IAC9D,OAAO,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gCAAgC,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,cAAc,EAAE,CAAC,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5I,CAAC;AAED,SAAS,SAAS,CAAC,OAAoB,EAAE,MAAc,EAAE,EAAe;IACvE,IAAI,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO,IAAI,MAAM,4EAA4E,CAAC;IAC/F,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC7C,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,MAAM,cAAc,EAAE,CAAC,IAAI,8EAA8E,CAAC;IACtH,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACpG,OAAO,IAAI,MAAM,uCAAuC,OAAO,CAAC,SAAS,mEAAmE,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,CAAC;IACnL,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,OAAO,CAAC,OAAoB,EAAE,MAAc,EAAE,EAAe;IACrE,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC;IACzB,IAAI,SAAS,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAClG,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CACvD,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAClE,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,MAAM,2BAA2B,MAAM,WAAW,EAAE,CAAC,IAAI,2FAA2F,CAC3J,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAoB,EAAE,IAAY,EAAE,KAA8B;IAC9F,OAAO,MAAM,CAAC,GAAG,CAChB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE;QAC7C,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,EAAsB,EAAE,CACnI,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CACvF,CAAC;IACH,CAAC,CAAC,EACF,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAC7B,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export type MarkdownLineKind = "code" | "fence" | "prose";
|
|
2
|
+
export interface MarkdownLine {
|
|
3
|
+
readonly kind: MarkdownLineKind;
|
|
4
|
+
readonly language: string;
|
|
5
|
+
readonly number: number;
|
|
6
|
+
readonly text: string;
|
|
7
|
+
}
|
|
8
|
+
export declare function markdownLines(markdown: string): readonly MarkdownLine[];
|
|
9
|
+
export declare function codeSpans(text: string): readonly string[];
|
|
10
|
+
export declare function withoutCodeSpans(text: string): string;
|
|
11
|
+
//# sourceMappingURL=markdownLines.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownLines.d.ts","sourceRoot":"","sources":["../../src/docs/markdownLines.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAE1D,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACtB;AAoBD,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,YAAY,EAAE,CAgBvE;AAID,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAEzD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { linesOf } from "#inventory/linesOf.ts";
|
|
2
|
+
const FENCE = /^ {0,3}(?<marker>`{3,}|~{3,})\s*(?<info>[^`\s]*)[^`]*$/u;
|
|
3
|
+
function opening(text) {
|
|
4
|
+
const match = FENCE.exec(text);
|
|
5
|
+
const marker = match?.groups?.marker;
|
|
6
|
+
return marker === undefined ? undefined : { language: (match?.groups?.info ?? "").toLowerCase(), marker };
|
|
7
|
+
}
|
|
8
|
+
function closes(text, open) {
|
|
9
|
+
const trimmed = text.trim();
|
|
10
|
+
return trimmed.startsWith(open.marker) && /^(?:`+|~+)$/u.test(trimmed);
|
|
11
|
+
}
|
|
12
|
+
export function markdownLines(markdown) {
|
|
13
|
+
const lines = [];
|
|
14
|
+
let open;
|
|
15
|
+
for (const [index, text] of linesOf(markdown).entries()) {
|
|
16
|
+
const number = index + 1;
|
|
17
|
+
if (open === undefined) {
|
|
18
|
+
open = opening(text);
|
|
19
|
+
lines.push({ kind: open === undefined ? "prose" : "fence", language: "", number, text });
|
|
20
|
+
}
|
|
21
|
+
else if (closes(text, open)) {
|
|
22
|
+
lines.push({ kind: "fence", language: open.language, number, text });
|
|
23
|
+
open = undefined;
|
|
24
|
+
}
|
|
25
|
+
else {
|
|
26
|
+
lines.push({ kind: "code", language: open.language, number, text });
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return lines;
|
|
30
|
+
}
|
|
31
|
+
const CODE_SPAN = /(?<ticks>`+)(?<code>.+?)\k<ticks>/gu;
|
|
32
|
+
export function codeSpans(text) {
|
|
33
|
+
return [...text.matchAll(CODE_SPAN)].map((match) => (match.groups?.code ?? "").trim());
|
|
34
|
+
}
|
|
35
|
+
export function withoutCodeSpans(text) {
|
|
36
|
+
return text.replace(CODE_SPAN, "");
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=markdownLines.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownLines.js","sourceRoot":"","sources":["../../src/docs/markdownLines.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgBhD,MAAM,KAAK,GAAG,yDAAyD,CAAC;AAExE,SAAS,OAAO,CAAC,IAAY;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IACrC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC;AAC3G,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,IAAe;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC7C,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,IAAI,IAA2B,CAAC;IAChC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC;QACzB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1F,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YACrE,IAAI,GAAG,SAAS,CAAC;QAClB,CAAC;aAAM,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,SAAS,GAAG,qCAAqC,CAAC;AAExD,MAAM,UAAU,SAAS,CAAC,IAAY;IACrC,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { type MarkdownLine } from "./markdownLines.ts";
|
|
2
|
+
export interface MarkdownLink {
|
|
3
|
+
readonly line: number;
|
|
4
|
+
readonly target: string;
|
|
5
|
+
}
|
|
6
|
+
export declare function markdownLinks(lines: readonly MarkdownLine[]): readonly MarkdownLink[];
|
|
7
|
+
//# sourceMappingURL=markdownLinks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownLinks.d.ts","sourceRoot":"","sources":["../../src/docs/markdownLinks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,oBAAoB,CAAC;AAEzE,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAsBD,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,GAAG,SAAS,YAAY,EAAE,CAKrF"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { withoutCodeSpans } from "./markdownLines.js";
|
|
2
|
+
const INLINE = /\]\(\s*(?<target><[^>]*>|[^\s)]+)/gu;
|
|
3
|
+
const DEFINITION = /^ {0,3}\[[^\]]+\]:\s*(?<target><[^>]*>|\S+)/u;
|
|
4
|
+
const ATTRIBUTE = /\b(?:href|src)="(?<target>[^"]+)"/gu;
|
|
5
|
+
function unwrapped(target) {
|
|
6
|
+
return target.startsWith("<") && target.endsWith(">") ? target.slice(1, -1) : target;
|
|
7
|
+
}
|
|
8
|
+
function targetsIn(text) {
|
|
9
|
+
const prose = withoutCodeSpans(text);
|
|
10
|
+
const definition = DEFINITION.exec(prose)?.groups?.target;
|
|
11
|
+
return [
|
|
12
|
+
...[...prose.matchAll(INLINE)].map((match) => match.groups?.target ?? ""),
|
|
13
|
+
...(definition === undefined ? [] : [definition]),
|
|
14
|
+
...[...prose.matchAll(ATTRIBUTE)].map((match) => match.groups?.target ?? ""),
|
|
15
|
+
].map(unwrapped);
|
|
16
|
+
}
|
|
17
|
+
export function markdownLinks(lines) {
|
|
18
|
+
return lines
|
|
19
|
+
.filter((line) => line.kind === "prose")
|
|
20
|
+
.flatMap((line) => targetsIn(line.text).map((target) => ({ line: line.number, target })))
|
|
21
|
+
.filter((link) => link.target !== "");
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=markdownLinks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownLinks.js","sourceRoot":"","sources":["../../src/docs/markdownLinks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAOzE,MAAM,MAAM,GAAG,qCAAqC,CAAC;AAErD,MAAM,UAAU,GAAG,8CAA8C,CAAC;AAElE,MAAM,SAAS,GAAG,qCAAqC,CAAC;AAExD,SAAS,SAAS,CAAC,MAAc;IAChC,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACtF,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;IAC1D,OAAO;QACN,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;QACzE,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACjD,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;KAC5E,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAA8B;IAC3D,OAAO,KAAK;SACV,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC;SACvC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;SACxF,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC;AACxC,CAAC"}
|