asciidoc-abundant-tree 0.1.21 → 0.2.1

package/README.md

@@ -191,7 +191,7 @@ Default output is a pretty tree:
 
 ```text
 <document mode="single-file" sourcePath="samples/reference-links.adoc">
-    <parser name="@asciidoctor/core" version="3.0.4">
+    <parser name="@asciidoctor/core" version="4.1.1">
     children[]
         <section idOrigin="source" ids="section-basics" level=1 title="基础概念">
             <source>
@@ -253,11 +253,11 @@ import {
 	serializeAbundantTreeToJson,
 } from "asciidoc-abundant-tree";
 
-const document = parseAbundantTree({
+const document = await parseAbundantTree({
 	sourcePath: "docs/index.adoc",
 });
 
-const book = parseAbundantTree({
+const book = await parseAbundantTree({
 	sourcePath: "samples/book-entry-demo/book.adoc",
 	mode: "book-entry",
 	documentRoot: "samples/book-entry-demo",
@@ -274,6 +274,29 @@ const ttl = projection.ttl;
 const jsonLd = projection.jsonLd;
 ```
 
+Book-entry callers can register include resolvers for includes that select by something other than a file path, such as a symbol in a TypeScript file. A resolver claims targets by prefix and returns whole consecutive lines of a source file inside `documentRoot`, plus the line they start at; the lines get coordinates in that file just like a file include:
+
+```ts
+const book = await parseAbundantTree({
+	sourcePath: "bookshelf/books/08-design/book.adoc",
+	mode: "book-entry",
+	documentRoot: ".",
+	includeResolvers: [
+		{
+			// include::docloom:examples/replay.ts[symbol=replay,part=source]
+			prefix: "docloom:",
+			resolve: ({ target, attributes }) => {
+				// Your own selector: find the declaration, widen it to whole lines.
+				const { text, startLine } = selectWholeLines(target, attributes);
+				return { text, origin: { path: target, startLine } };
+			},
+		},
+	],
+});
+```
+
+`attributes` are the include attributes as Asciidoctor parses them, the same an Asciidoctor include processor receives, so the bookshelf build and this parser can register the same selector. A resolver that throws fails construction with `include.resolver-failed`; returned text that does not match its source leaves those lines without coordinates and reports `origin-map.selection-mismatch`.
+
 `parseAbundantTree` reads only the supplied source file. Interdocument xrefs keep their raw target and official href when Asciidoctor exposes one, but this package does not open the referenced `.adoc` file.
 
 Browser tools that already hold AsciiDoc source text can use the browser-safe subpath:
@@ -281,7 +304,7 @@ Browser tools that already hold AsciiDoc source text can use the browser-safe su
 ```ts
 import { parseAbundantTreeFromSource } from "asciidoc-abundant-tree/browser";
 
-const document = parseAbundantTreeFromSource({
+const document = await parseAbundantTreeFromSource({
 	sourceText,
 	sourcePath: "document.adoc",
 });
@@ -310,7 +333,7 @@ List unresolved local xrefs:
 ```ts
 import { parseAbundantTree } from "asciidoc-abundant-tree";
 
-const document = parseAbundantTree({ sourcePath: "docs/index.adoc" });
+const document = await parseAbundantTree({ sourcePath: "docs/index.adoc" });
 
 for (const xref of document.xrefOccurrences) {
 	if (xref.scope === "unresolved") {
@@ -324,7 +347,7 @@ Inspect target kinds:
 ```ts
 import { parseAbundantTree } from "asciidoc-abundant-tree";
 
-const document = parseAbundantTree({ sourcePath: "docs/index.adoc" });
+const document = await parseAbundantTree({ sourcePath: "docs/index.adoc" });
 
 const byKind = new Map<string, number>();
 for (const target of document.targets) {

package/dist/animation-yaml-export/cli.d.mts

@@ -1,4 +1,4 @@
-import { r as exportAnimationYaml } from "../export-animation-yaml-Tq1LM1lx.mjs";
+import { r as exportAnimationYaml } from "../export-animation-yaml-BHp1vISl.mjs";
 
 //#region src/animation-yaml-export/cli.d.ts
 type AnimationYamlCliResult = {
@@ -6,6 +6,6 @@ type AnimationYamlCliResult = {
   readonly stdout: string;
   readonly stderr: string;
 };
-declare function runAnimationYamlCli(args: string[]): AnimationYamlCliResult;
+declare function runAnimationYamlCli(args: string[]): Promise<AnimationYamlCliResult>;
 //#endregion
 export { AnimationYamlCliResult, exportAnimationYaml, runAnimationYamlCli };

package/dist/animation-yaml-export/cli.mjs

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import { o as exportAnimationYaml } from "../src-DmtfeBaM.mjs";
+import { o as exportAnimationYaml } from "../src-DMOLXZbF.mjs";
 import process from "node:process";
 //#region src/animation-yaml-export/cli.ts
 const USAGE = `Usage:
   animation-yaml-export <book.adoc>
   animation-yaml-export <book.adoc> --document-root <root>
   animation-yaml-export --help`;
-function runAnimationYamlCli(args) {
+async function runAnimationYamlCli(args) {
 	let parsed;
 	try {
 		parsed = parseArgs(args);
@@ -30,10 +30,10 @@ function runAnimationYamlCli(args) {
 	try {
 		return {
 			code: 0,
-			stdout: exportAnimationYaml({
+			stdout: (await exportAnimationYaml({
 				sourcePath: parsed.sourcePath,
 				...parsed.documentRoot === void 0 ? {} : { documentRoot: parsed.documentRoot }
-			}).yaml,
+			})).yaml,
 			stderr: ""
 		};
 	} catch (error) {
@@ -80,7 +80,7 @@ function formatError(error) {
 }
 /* c8 ignore start */
 if (import.meta.url === `file://${process.argv[1]}`) {
-	const result = runAnimationYamlCli(process.argv.slice(2));
+	const result = await runAnimationYamlCli(process.argv.slice(2));
 	if (result.stdout) process.stdout.write(result.stdout);
 	if (result.stderr) process.stderr.write(result.stderr.endsWith("\n") ? result.stderr : `${result.stderr}\n`);
 	process.exitCode = result.code;

package/dist/browser.d.mts

@@ -210,7 +210,7 @@ type ParseAbundantTreeFromSourceOptions = {
 };
 //#endregion
 //#region src/browser-parser.d.ts
-declare function parseAbundantTreeFromSource(options: ParseAbundantTreeFromSourceOptions): AbundantDocument;
+declare function parseAbundantTreeFromSource(options: ParseAbundantTreeFromSourceOptions): Promise<AbundantDocument>;
 //#endregion
 //#region src/serializers.d.ts
 declare function formatAbundantTree(document: AbundantDocument): string;