@tsdoctor/pages 0.3.12 → 0.3.13
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/Blocks.js +1 -2
- package/Build.js +1 -2
- package/Examples.js +1 -2
- package/Llms.js +1 -2
- package/Markdown.js +1 -2
- package/Nav.js +1 -2
- package/Page.js +1 -2
- package/Scope.js +1 -2
- package/TwoslashDirectives.js +1 -2
- package/WorkItems.js +1 -2
- package/index.d.ts +0 -20
- package/package.json +8 -8
package/Blocks.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { FlowContent, PhrasingContent } from "@effected/markdown";
|
|
2
2
|
import { Schema } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Blocks.ts
|
|
5
5
|
/**
|
|
6
6
|
* The block vocabulary — the things a generated API page is built from,
|
|
7
7
|
* named once so every adapter emits the same page in its own dialect.
|
|
@@ -354,5 +354,4 @@ const Block = Schema.Union([
|
|
|
354
354
|
MemberIndex
|
|
355
355
|
]);
|
|
356
356
|
|
|
357
|
-
//#endregion
|
|
358
357
|
export { AvailableFrom, BaseClass, Block, CodeText, EnumMemberRow, EnumMemberTable, Example, ExampleGroup, Inline, Member, MemberGroup, MemberIndex, MemberIndexEntry, MemberRole, ParameterRow, ParameterTable, Prose, ProseBlock, ProseRole, ReleaseTag, SeeAlso, Signature, SourceLink, Title };
|
package/Build.js
CHANGED
|
@@ -7,7 +7,7 @@ import { Effect, Option, Result, Schema } from "effect";
|
|
|
7
7
|
import { ApiItemKind } from "@microsoft/api-extractor-model";
|
|
8
8
|
import { ApiItems, Routes, Signature, Tsdoc, TypeReferenceExtractor } from "@tsdoctor/model";
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
// src/Build.ts
|
|
11
11
|
/**
|
|
12
12
|
* The description a page carries when its item has no summary.
|
|
13
13
|
*
|
|
@@ -521,5 +521,4 @@ const buildPage = Effect.fn("Build.buildPage")(function* (input) {
|
|
|
521
521
|
}));
|
|
522
522
|
});
|
|
523
523
|
|
|
524
|
-
//#endregion
|
|
525
524
|
export { INDEX_PAGE_TITLE, IndexPage, NO_DESCRIPTION, buildIndexPage, buildPage, isPageKind };
|
package/Examples.js
CHANGED
|
@@ -4,7 +4,7 @@ import { Effect, Schema } from "effect";
|
|
|
4
4
|
import { TypeReferenceExtractor } from "@tsdoctor/model";
|
|
5
5
|
import { format } from "prettier";
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
// src/Examples.ts
|
|
8
8
|
/**
|
|
9
9
|
* Prettier could not format an example.
|
|
10
10
|
*
|
|
@@ -233,5 +233,4 @@ const buildExample = Effect.fn("Examples.buildExample")(function* (example, apiI
|
|
|
233
233
|
});
|
|
234
234
|
});
|
|
235
235
|
|
|
236
|
-
//#endregion
|
|
237
236
|
export { ExampleFormatError, addLogicalBlankLines, buildExample, codeText, formatExampleCode, prepareExampleCode, prependHiddenImports, stripTwoslashDirectives };
|
package/Llms.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/Llms.ts
|
|
2
2
|
/** Pre-compiled regex for parsing llms.txt link lines. */
|
|
3
3
|
const LLMS_TXT_LINE_RE = /^-\s+\[([^\]]+)\]\(([^)]+)\)(?::\s*(\S.*))?$/;
|
|
4
4
|
/**
|
|
@@ -278,5 +278,4 @@ function generatePackageLlmsFullTxt(pages) {
|
|
|
278
278
|
return sections.join("\n\n\n");
|
|
279
279
|
}
|
|
280
280
|
|
|
281
|
-
//#endregion
|
|
282
281
|
export { filterLlmsFullTxt, filterLlmsTxt, generatePackageLlmsFullTxt, generatePackageLlmsTxt, generateStructuredLlmsTxt, parseLlmsTxtLine };
|
package/Markdown.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Blockquote, Code, Heading, InlineCode, Link, List, ListItem, Markdown, Paragraph, Root, Strong, Table, TableCell, TableRow, Text } from "@effected/markdown";
|
|
2
2
|
import { Effect, Result } from "effect";
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
// src/Markdown.ts
|
|
5
5
|
const text = (value) => Text.make({ value });
|
|
6
6
|
const heading = (depth, value) => Heading.make({
|
|
7
7
|
depth,
|
|
@@ -151,5 +151,4 @@ function renderMarkdownResult(page) {
|
|
|
151
151
|
*/
|
|
152
152
|
const renderMarkdown = Effect.fn("Markdown.renderMarkdown")((page) => Effect.fromResult(renderMarkdownResult(page)));
|
|
153
153
|
|
|
154
|
-
//#endregion
|
|
155
154
|
export { markdownBlockTree, markdownTree, renderMarkdown, renderMarkdownResult };
|
package/Nav.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/Nav.ts
|
|
4
4
|
/**
|
|
5
5
|
* The per-API navigation tree — category groups of pages plus the index —
|
|
6
6
|
* as data, so a sidebar that is files in one framework and config in another
|
|
@@ -144,5 +144,4 @@ function buildNav(input) {
|
|
|
144
144
|
});
|
|
145
145
|
}
|
|
146
146
|
|
|
147
|
-
//#endregion
|
|
148
147
|
export { NAV_INDEX_LABEL, NavCategory, NavEntry, NavGroup, NavPage, NavTree, buildNav, sortNavPages };
|
package/Page.js
CHANGED
|
@@ -2,7 +2,7 @@ import { Block } from "./Blocks.js";
|
|
|
2
2
|
import { NavEntry } from "./Nav.js";
|
|
3
3
|
import { Schema } from "effect";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
// src/Page.ts
|
|
6
6
|
/**
|
|
7
7
|
* The neutral head tag, as a schema — the same shape as `@tsdoctor/seo`'s
|
|
8
8
|
* `HeadTag` interface, so a value from `headTags` is accepted unchanged.
|
|
@@ -76,5 +76,4 @@ var Page = class extends Schema.Class("Page")({
|
|
|
76
76
|
}
|
|
77
77
|
};
|
|
78
78
|
|
|
79
|
-
//#endregion
|
|
80
79
|
export { HeadTag, Page, PageKind };
|
package/Scope.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/Scope.ts
|
|
2
2
|
/**
|
|
3
3
|
* API scope naming — the helpers that turn a package name and a base route
|
|
4
4
|
* into the identifiers every adapter must agree on.
|
|
@@ -52,5 +52,4 @@ function apiScopeOf(baseRoute, packageName) {
|
|
|
52
52
|
return baseRoute.replace(/^\//, "").split("/")[0] || packageName;
|
|
53
53
|
}
|
|
54
54
|
|
|
55
|
-
//#endregion
|
|
56
55
|
export { apiScopeOf, normalizeBaseRoute, unscopedName };
|
package/TwoslashDirectives.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/TwoslashDirectives.ts
|
|
2
2
|
/**
|
|
3
3
|
* Twoslash directive detection — the regexes that decide which lines of a
|
|
4
4
|
* code block are notation rather than code.
|
|
@@ -59,5 +59,4 @@ function classifyCutDirective(trimmedLine) {
|
|
|
59
59
|
return null;
|
|
60
60
|
}
|
|
61
61
|
|
|
62
|
-
//#endregion
|
|
63
62
|
export { classifyCutDirective, isTwoslashDirective };
|
package/WorkItems.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ApiItems, EntryPoints, Routes, SyntheticBases } from "@tsdoctor/model";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
// src/WorkItems.ts
|
|
4
4
|
/**
|
|
5
5
|
* Cross-link priority by API item kind (lower = higher priority). When a bare
|
|
6
6
|
* name maps to multiple pages (the const+type companion pattern), the bare
|
|
@@ -158,5 +158,4 @@ function prepareWorkItems(input) {
|
|
|
158
158
|
};
|
|
159
159
|
}
|
|
160
160
|
|
|
161
|
-
//#endregion
|
|
162
161
|
export { crossLinkKindPriority, prepareWorkItems };
|
package/index.d.ts
CHANGED
|
@@ -2,7 +2,6 @@ import { FlowContent, MarkdownStringifyError, PhrasingContent } from "@effected/
|
|
|
2
2
|
import { Effect, Option, Result, Schema } from "effect";
|
|
3
3
|
import { ApiItem, ApiItemKind, ApiPackage } from "@microsoft/api-extractor-model";
|
|
4
4
|
import { ApiItems, CrossLinker, ImportStatement, Routes } from "@tsdoctor/model";
|
|
5
|
-
//#region src/Blocks.d.ts
|
|
6
5
|
/**
|
|
7
6
|
* A run of block-level mdast — a summary paragraph, a remarks section.
|
|
8
7
|
*
|
|
@@ -334,8 +333,6 @@ export type Block = typeof Block.Type;
|
|
|
334
333
|
* @public
|
|
335
334
|
*/
|
|
336
335
|
type BlockKind = Block["kind"];
|
|
337
|
-
//#endregion
|
|
338
|
-
//#region src/Examples.d.ts
|
|
339
336
|
declare const ExampleFormatError_base: Schema.Class<ExampleFormatError, Schema.TaggedStruct<"ExampleFormatError", {
|
|
340
337
|
/** The fence language the parser was chosen for. */
|
|
341
338
|
readonly language: Schema.String;
|
|
@@ -462,8 +459,6 @@ export declare const formatExampleCode: (code: string, language: string) => Effe
|
|
|
462
459
|
* @public
|
|
463
460
|
*/
|
|
464
461
|
export declare const buildExample: (example: RawExample, apiItemName: string, packageName: string, suppressErrors?: boolean) => Effect.Effect<Example, ExampleFormatError>;
|
|
465
|
-
//#endregion
|
|
466
|
-
//#region src/Nav.d.ts
|
|
467
462
|
declare const NavEntry_base: Schema.Class<NavEntry, Schema.Struct<{
|
|
468
463
|
/** The category key the page was categorized under. */
|
|
469
464
|
readonly categoryKey: Schema.String;
|
|
@@ -577,8 +572,6 @@ export declare function sortNavPages(pages: ReadonlyArray<NavPage>): ReadonlyArr
|
|
|
577
572
|
* @public
|
|
578
573
|
*/
|
|
579
574
|
export declare function buildNav(input: BuildNavInput): NavTree;
|
|
580
|
-
//#endregion
|
|
581
|
-
//#region src/Page.d.ts
|
|
582
575
|
/**
|
|
583
576
|
* The neutral head tag, as a schema — the same shape as `@tsdoctor/seo`'s
|
|
584
577
|
* `HeadTag` interface, so a value from `headTags` is accepted unchanged.
|
|
@@ -651,8 +644,6 @@ export declare class Page extends Page_base {
|
|
|
651
644
|
*/
|
|
652
645
|
get title(): string;
|
|
653
646
|
}
|
|
654
|
-
//#endregion
|
|
655
|
-
//#region src/Build.d.ts
|
|
656
647
|
/**
|
|
657
648
|
* The description a page carries when its item has no summary.
|
|
658
649
|
*
|
|
@@ -768,8 +759,6 @@ export declare function isPageKind(kind: ApiItemKind): boolean;
|
|
|
768
759
|
* @public
|
|
769
760
|
*/
|
|
770
761
|
export declare const buildPage: (input: BuildPageInput) => Effect.Effect<Option.Option<Page>>;
|
|
771
|
-
//#endregion
|
|
772
|
-
//#region src/Llms.d.ts
|
|
773
762
|
/**
|
|
774
763
|
* A parsed link entry from llms.txt format.
|
|
775
764
|
*
|
|
@@ -950,8 +939,6 @@ export declare function generatePackageLlmsTxt(input: PackageLlmsTxtInput): stri
|
|
|
950
939
|
* @public
|
|
951
940
|
*/
|
|
952
941
|
export declare function generatePackageLlmsFullTxt(pages: PageContent[]): string;
|
|
953
|
-
//#endregion
|
|
954
|
-
//#region src/Markdown.d.ts
|
|
955
942
|
/**
|
|
956
943
|
* Render one block to flow nodes.
|
|
957
944
|
*
|
|
@@ -984,8 +971,6 @@ export declare function renderMarkdownResult(page: Page): Result.Result<string,
|
|
|
984
971
|
* @public
|
|
985
972
|
*/
|
|
986
973
|
export declare const renderMarkdown: (page: Page) => Effect.Effect<string, MarkdownStringifyError>;
|
|
987
|
-
//#endregion
|
|
988
|
-
//#region src/Scope.d.ts
|
|
989
974
|
/**
|
|
990
975
|
* API scope naming — the helpers that turn a package name and a base route
|
|
991
976
|
* into the identifiers every adapter must agree on.
|
|
@@ -1030,8 +1015,6 @@ export declare function normalizeBaseRoute(route: string): string;
|
|
|
1030
1015
|
* @public
|
|
1031
1016
|
*/
|
|
1032
1017
|
export declare function apiScopeOf(baseRoute: string, packageName: string): string;
|
|
1033
|
-
//#endregion
|
|
1034
|
-
//#region src/TwoslashDirectives.d.ts
|
|
1035
1018
|
/**
|
|
1036
1019
|
* Twoslash directive detection — the regexes that decide which lines of a
|
|
1037
1020
|
* code block are notation rather than code.
|
|
@@ -1069,8 +1052,6 @@ export declare function isTwoslashDirective(trimmedLine: string): boolean;
|
|
|
1069
1052
|
* @public
|
|
1070
1053
|
*/
|
|
1071
1054
|
export declare function classifyCutDirective(trimmedLine: string): CutDirective | null;
|
|
1072
|
-
//#endregion
|
|
1073
|
-
//#region src/WorkItems.d.ts
|
|
1074
1055
|
/**
|
|
1075
1056
|
* Lower number = higher priority for which page a bare cross-link name
|
|
1076
1057
|
* resolves to.
|
|
@@ -1188,6 +1169,5 @@ interface PrepareWorkItemsResult<C extends WorkItemCategory = WorkItemCategory>
|
|
|
1188
1169
|
* @public
|
|
1189
1170
|
*/
|
|
1190
1171
|
export declare function prepareWorkItems<C extends WorkItemCategory>(input: PrepareWorkItemsInput<C>): PrepareWorkItemsResult<C>;
|
|
1191
|
-
//#endregion
|
|
1192
1172
|
export type { BlockKind, BuildIndexPageInput, BuildNavInput, BuildPageInput, CrossLinkData, CutDirective, HeadTag, LlmsTxtEntry, NamespaceMemberFacts, PackageLlmsTxtInput, PackagePointer, PackageScopeInfo, PageContent, PrepareWorkItemsInput, PrepareWorkItemsResult, PreparedExample, RawExample, WorkItem, WorkItemCategory };
|
|
1193
1173
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tsdoctor/pages",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.13",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Framework-neutral documentation page IR for static TypeScript API sites: typed doc blocks over an API Extractor model, per-API navigation trees, display/source code preparation, a plain-markdown emitter and the llms.txt text transforms.",
|
|
6
6
|
"keywords": [
|
|
@@ -40,16 +40,16 @@
|
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@microsoft/api-extractor-model": "7.33.12",
|
|
43
|
-
"@tsdoctor/model": "0.8.
|
|
44
|
-
"@tsdoctor/seo": "0.4.
|
|
43
|
+
"@tsdoctor/model": "0.8.12",
|
|
44
|
+
"@tsdoctor/seo": "0.4.10",
|
|
45
45
|
"prettier": "^3.9.10"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
|
-
"@effected/markdown": "^0.
|
|
49
|
-
"@effected/package-json": "^0.
|
|
50
|
-
"@effected/schema-org": "^0.
|
|
51
|
-
"@effected/tsconfig-json": "^0.
|
|
52
|
-
"effect": "^4.0.
|
|
48
|
+
"@effected/markdown": "^0.20.0",
|
|
49
|
+
"@effected/package-json": "^0.24.0",
|
|
50
|
+
"@effected/schema-org": "^0.11.0",
|
|
51
|
+
"@effected/tsconfig-json": "^0.17.0",
|
|
52
|
+
"effect": "^4.0.6"
|
|
53
53
|
},
|
|
54
54
|
"engines": {
|
|
55
55
|
"node": ">=24.11.0"
|