@typespec/tspd 0.47.0-dev.0 → 0.68.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/README.md +18 -0
- package/dist/src/cli.js +24 -5
- package/dist/src/cli.js.map +1 -1
- package/dist/src/gen-extern-signatures/decorators-signatures.d.ts +5 -0
- package/dist/src/gen-extern-signatures/decorators-signatures.d.ts.map +1 -0
- package/dist/src/gen-extern-signatures/decorators-signatures.js +338 -0
- package/dist/src/gen-extern-signatures/decorators-signatures.js.map +1 -0
- package/dist/src/gen-extern-signatures/doc-builder.d.ts +3 -0
- package/dist/src/gen-extern-signatures/doc-builder.d.ts.map +1 -0
- package/dist/src/gen-extern-signatures/doc-builder.js +14 -0
- package/dist/src/gen-extern-signatures/doc-builder.js.map +1 -0
- package/dist/src/gen-extern-signatures/gen-extern-signatures.d.ts +11 -0
- package/dist/src/gen-extern-signatures/gen-extern-signatures.d.ts.map +1 -0
- package/dist/src/gen-extern-signatures/gen-extern-signatures.js +122 -0
- package/dist/src/gen-extern-signatures/gen-extern-signatures.js.map +1 -0
- package/dist/src/gen-extern-signatures/types.d.ts +11 -0
- package/dist/src/gen-extern-signatures/types.d.ts.map +1 -0
- package/dist/src/gen-extern-signatures/types.js +2 -0
- package/dist/src/gen-extern-signatures/types.js.map +1 -0
- package/dist/src/ref-doc/api-docs.d.ts.map +1 -1
- package/dist/src/ref-doc/api-docs.js +3 -3
- package/dist/src/ref-doc/api-docs.js.map +1 -1
- package/dist/src/ref-doc/emitters/docusaurus.d.ts +4 -4
- package/dist/src/ref-doc/emitters/docusaurus.d.ts.map +1 -1
- package/dist/src/ref-doc/emitters/docusaurus.js +72 -72
- package/dist/src/ref-doc/emitters/docusaurus.js.map +1 -1
- package/dist/src/ref-doc/emitters/markdown.d.ts +22 -7
- package/dist/src/ref-doc/emitters/markdown.d.ts.map +1 -1
- package/dist/src/ref-doc/emitters/markdown.js +125 -24
- package/dist/src/ref-doc/emitters/markdown.js.map +1 -1
- package/dist/src/ref-doc/emitters/starlight.d.ts +24 -0
- package/dist/src/ref-doc/emitters/starlight.d.ts.map +1 -0
- package/dist/src/ref-doc/emitters/starlight.js +213 -0
- package/dist/src/ref-doc/emitters/starlight.js.map +1 -0
- package/dist/src/ref-doc/experimental.d.ts +4 -1
- package/dist/src/ref-doc/experimental.d.ts.map +1 -1
- package/dist/src/ref-doc/experimental.js +7 -8
- package/dist/src/ref-doc/experimental.js.map +1 -1
- package/dist/src/ref-doc/extractor.d.ts.map +1 -1
- package/dist/src/ref-doc/extractor.js +112 -80
- package/dist/src/ref-doc/extractor.js.map +1 -1
- package/dist/src/ref-doc/lib.d.ts +55 -2
- package/dist/src/ref-doc/lib.d.ts.map +1 -1
- package/dist/src/ref-doc/lib.js +8 -1
- package/dist/src/ref-doc/lib.js.map +1 -1
- package/dist/src/ref-doc/types.d.ts +79 -53
- package/dist/src/ref-doc/types.d.ts.map +1 -1
- package/dist/src/ref-doc/utils/markdown.d.ts +0 -6
- package/dist/src/ref-doc/utils/markdown.d.ts.map +1 -1
- package/dist/src/ref-doc/utils/markdown.js +1 -9
- package/dist/src/ref-doc/utils/markdown.js.map +1 -1
- package/dist/src/ref-doc/utils/type-signature.d.ts.map +1 -1
- package/dist/src/ref-doc/utils/type-signature.js +8 -22
- package/dist/src/ref-doc/utils/type-signature.js.map +1 -1
- package/package.json +30 -32
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/gen-extern-signatures/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAErE,MAAM,WAAW,kBAAkB;IACjC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IAEf,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,SAAS,CAAC;CACtB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/gen-extern-signatures/types.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-docs.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,
|
|
1
|
+
{"version":3,"file":"api-docs.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAyC,MAAM,SAAS,CAAC;AAG7E,wBAAsB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,iBAmD7E;AAQD,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,QAO5C"}
|
|
@@ -12,7 +12,6 @@ export async function generateJsApiDocs(libraryPath, outputDir) {
|
|
|
12
12
|
typeDeclarationFormat: "table",
|
|
13
13
|
hidePageTitle: true,
|
|
14
14
|
hideBreadcrumbs: true,
|
|
15
|
-
hideInPageTOC: true,
|
|
16
15
|
hidePageHeader: true,
|
|
17
16
|
useCodeBlocks: true,
|
|
18
17
|
};
|
|
@@ -29,6 +28,7 @@ export async function generateJsApiDocs(libraryPath, outputDir) {
|
|
|
29
28
|
readme: "none",
|
|
30
29
|
hideGenerator: true,
|
|
31
30
|
disableSources: true,
|
|
31
|
+
out: outputDir,
|
|
32
32
|
...markdownPluginOptions,
|
|
33
33
|
});
|
|
34
34
|
const project = await app.convert();
|
|
@@ -36,7 +36,7 @@ export async function generateJsApiDocs(libraryPath, outputDir) {
|
|
|
36
36
|
if (!project) {
|
|
37
37
|
return;
|
|
38
38
|
}
|
|
39
|
-
await app.
|
|
39
|
+
await app.generateOutputs(project);
|
|
40
40
|
await writeFile(joinPaths(outputDir, "_category_.json"), JSON.stringify({
|
|
41
41
|
label: "JS API",
|
|
42
42
|
link: {
|
|
@@ -52,7 +52,7 @@ function setOptions(app, options, reportErrors = true) {
|
|
|
52
52
|
}
|
|
53
53
|
export function loadRenderer(app) {
|
|
54
54
|
app.renderer.on(PageEvent.END, (page) => {
|
|
55
|
-
if (page.contents) {
|
|
55
|
+
if (page.contents && page) {
|
|
56
56
|
const frontMatter = createFrontMatter(page.model);
|
|
57
57
|
page.contents = frontMatter + page.contents.replace(/\\</g, "<");
|
|
58
58
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-docs.js","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,
|
|
1
|
+
{"version":3,"file":"api-docs.js","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAc,cAAc,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAiB,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,WAAmB,EAAE,SAAiB;IAC5E,MAAM,qBAAqB,GAA2B;QACpD,aAAa,EAAE,UAAU;QACzB,gBAAgB,EAAE,OAAO;QACzB,gBAAgB,EAAE,OAAO;QACzB,iBAAiB,EAAE,OAAO;QAC1B,qBAAqB,EAAE,OAAO;QAC9B,aAAa,EAAE,IAAI;QACnB,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;KACpB,CAAC;IAEF,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACrD,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;QACjD,kBAAkB,EAAE,SAAS;KAC9B,CAAC,CAAC;IAEH,YAAY,CAAC,GAAG,CAAC,CAAC;IAClB,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,MAAM;QACd,aAAa,EAAE,IAAI;QACnB,cAAc,EAAE,IAAI;QACpB,GAAG,EAAE,SAAS;QACd,GAAG,qBAAqB;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IAEpC,6FAA6F;IAC7F,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;IACT,CAAC;IAED,MAAM,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAEnC,MAAM,SAAS,CACb,SAAS,CAAC,SAAS,EAAE,iBAAiB,CAAC,EACvC,IAAI,CAAC,SAAS,CAAC;QACb,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE;YACJ,IAAI,EAAE,KAAK;YACX,EAAE,EAAE,OAAO;SACZ;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,GAAgB,EAAE,OAAY,EAAE,YAAY,GAAG,IAAI;IACrE,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAY,EAAE,GAAY,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAgB;IAC3C,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAoB,EAAE,EAAE;QACtD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAiB;IAC1C,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAiB;IAC9C,MAAM,IAAI,GAAG,cAAc,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1D,OAAO;QACL,KAAK,EAAE,IAAI;QACX,KAAK,EAAE,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE;KACjC,CAAC;AACJ,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { NamedTypeRefDoc, TypeSpecLibraryRefDoc, TypeSpecRefDoc, TypeSpecRefDocBase } from "../types.js";
|
|
2
|
-
import { MarkdownSection } from "../utils/markdown.js";
|
|
1
|
+
import { DeprecationNotice, NamedTypeRefDoc, RefDocEntity, TypeSpecLibraryRefDoc, TypeSpecRefDoc, TypeSpecRefDocBase } from "../types.js";
|
|
2
|
+
import { MarkdownDoc, MarkdownSection } from "../utils/markdown.js";
|
|
3
3
|
import { MarkdownRenderer } from "./markdown.js";
|
|
4
4
|
/**
|
|
5
5
|
* Render doc to a markdown using docusaurus addons.
|
|
@@ -14,11 +14,11 @@ export type DataTypeRenderOptions = {
|
|
|
14
14
|
};
|
|
15
15
|
export declare function renderDataTypes(renderer: DocusaurusRenderer, refDoc: TypeSpecRefDoc, options?: DataTypeRenderOptions): string | undefined;
|
|
16
16
|
export declare class DocusaurusRenderer extends MarkdownRenderer {
|
|
17
|
-
#private;
|
|
18
|
-
constructor(refDoc: TypeSpecLibraryRefDoc);
|
|
19
17
|
headingTitle(item: NamedTypeRefDoc): string;
|
|
20
18
|
anchorId(item: NamedTypeRefDoc): string;
|
|
21
19
|
install(refDoc: TypeSpecLibraryRefDoc): MarkdownSection;
|
|
20
|
+
filename(type: RefDocEntity): string;
|
|
22
21
|
linterRuleLink(url: string): string;
|
|
22
|
+
deprecationNotice(notice: DeprecationNotice): MarkdownDoc;
|
|
23
23
|
}
|
|
24
24
|
//# sourceMappingURL=docusaurus.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docusaurus.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,
|
|
1
|
+
{"version":3,"file":"docusaurus.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,eAAe,EAKhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAoB,MAAM,eAAe,CAAC;AAEnE;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA+BzF;AA2CD,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,MAAM,GAAG,SAAS,CAepB;AAsCD,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,MAAM,GAAG,SAAS,CAyCpB;AAuCD,qBAAa,kBAAmB,SAAQ,gBAAgB;IACtD,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAI3C,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAKvC,OAAO,CAAC,MAAM,EAAE,qBAAqB,GAAG,eAAe;IAkBvD,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM;IAgBpC,cAAc,CAAC,GAAG,EAAE,MAAM;IAU1B,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW;CAG1D"}
|
|
@@ -1,16 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
3
|
-
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
4
|
-
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
|
|
5
|
-
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
6
|
-
};
|
|
7
|
-
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
8
|
-
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
9
|
-
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
10
|
-
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
11
|
-
};
|
|
12
|
-
var _DocusaurusRenderer_refDoc;
|
|
13
|
-
import { codeblock, inlinecode, renderMarkdowDoc, section, tabs, } from "../utils/markdown.js";
|
|
1
|
+
import { codeblock, inlinecode, renderMarkdowDoc, section, } from "../utils/markdown.js";
|
|
14
2
|
import { MarkdownRenderer, groupByNamespace } from "./markdown.js";
|
|
15
3
|
/**
|
|
16
4
|
* Render doc to a markdown using docusaurus addons.
|
|
@@ -43,7 +31,6 @@ export function renderToDocusaurusMarkdown(refDoc) {
|
|
|
43
31
|
return files;
|
|
44
32
|
}
|
|
45
33
|
function renderIndexFile(renderer, refDoc) {
|
|
46
|
-
var _a, _b;
|
|
47
34
|
const content = [
|
|
48
35
|
"---",
|
|
49
36
|
`title: Overview`,
|
|
@@ -54,36 +41,33 @@ function renderIndexFile(renderer, refDoc) {
|
|
|
54
41
|
"import Tabs from '@theme/Tabs';",
|
|
55
42
|
"import TabItem from '@theme/TabItem';",
|
|
56
43
|
"",
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
}),
|
|
77
|
-
]),
|
|
44
|
+
refDoc.description ?? [],
|
|
45
|
+
renderer.install(refDoc),
|
|
46
|
+
refDoc.emitter?.options ? section("Emitter usage", `[See documentation](./emitter.md)`) : [],
|
|
47
|
+
groupByNamespace(refDoc.namespaces, (namespace) => {
|
|
48
|
+
const content = [];
|
|
49
|
+
if (namespace.decorators.length > 0) {
|
|
50
|
+
content.push(section("Decorators", renderer.toc(namespace.decorators)));
|
|
51
|
+
}
|
|
52
|
+
if (namespace.interfaces.length > 0) {
|
|
53
|
+
content.push(section("Interfaces", renderer.toc(namespace.interfaces)));
|
|
54
|
+
}
|
|
55
|
+
if (namespace.operations.length > 0) {
|
|
56
|
+
content.push(section("Operations", renderer.toc(namespace.operations)));
|
|
57
|
+
}
|
|
58
|
+
if (namespace.models.length > 0) {
|
|
59
|
+
content.push(section("Models", renderer.toc(namespace.models)));
|
|
60
|
+
}
|
|
61
|
+
return content;
|
|
62
|
+
}),
|
|
78
63
|
];
|
|
79
|
-
return renderMarkdowDoc(content);
|
|
64
|
+
return renderMarkdowDoc(content, 2);
|
|
80
65
|
}
|
|
81
66
|
export function renderDecoratorFile(renderer, refDoc, options) {
|
|
82
|
-
var _a;
|
|
83
67
|
if (!refDoc.namespaces.some((x) => x.decorators.length > 0)) {
|
|
84
68
|
return undefined;
|
|
85
69
|
}
|
|
86
|
-
const title =
|
|
70
|
+
const title = options?.title ?? "Decorators";
|
|
87
71
|
const content = [
|
|
88
72
|
"---",
|
|
89
73
|
`title: "${title}"`,
|
|
@@ -91,8 +75,8 @@ export function renderDecoratorFile(renderer, refDoc, options) {
|
|
|
91
75
|
"toc_max_heading_level: 3",
|
|
92
76
|
"---",
|
|
93
77
|
];
|
|
94
|
-
content.push(
|
|
95
|
-
return renderMarkdowDoc(content);
|
|
78
|
+
content.push(renderer.decoratorsSection(refDoc));
|
|
79
|
+
return renderMarkdowDoc(content, 2);
|
|
96
80
|
}
|
|
97
81
|
function renderInterfacesFile(renderer, refDoc) {
|
|
98
82
|
if (!refDoc.namespaces.some((x) => x.operations.length > 0 || x.interfaces.length > 0)) {
|
|
@@ -105,29 +89,26 @@ function renderInterfacesFile(renderer, refDoc) {
|
|
|
105
89
|
"toc_max_heading_level: 3",
|
|
106
90
|
"---",
|
|
107
91
|
];
|
|
108
|
-
content.push(
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
]));
|
|
123
|
-
return renderMarkdowDoc(content);
|
|
92
|
+
content.push(groupByNamespace(refDoc.namespaces, (namespace) => {
|
|
93
|
+
if (namespace.operations.length === 0 && namespace.interfaces.length === 0) {
|
|
94
|
+
return undefined;
|
|
95
|
+
}
|
|
96
|
+
const content = [];
|
|
97
|
+
for (const iface of namespace.interfaces) {
|
|
98
|
+
content.push(renderer.interface(iface), "");
|
|
99
|
+
}
|
|
100
|
+
for (const operation of namespace.operations) {
|
|
101
|
+
content.push(renderer.operation(operation), "");
|
|
102
|
+
}
|
|
103
|
+
return content;
|
|
104
|
+
}));
|
|
105
|
+
return renderMarkdowDoc(content, 2);
|
|
124
106
|
}
|
|
125
107
|
export function renderDataTypes(renderer, refDoc, options) {
|
|
126
|
-
var _a;
|
|
127
108
|
if (!refDoc.namespaces.some((x) => x.models.length > 0)) {
|
|
128
109
|
return undefined;
|
|
129
110
|
}
|
|
130
|
-
const title =
|
|
111
|
+
const title = options?.title ?? "Data types";
|
|
131
112
|
const content = [
|
|
132
113
|
"---",
|
|
133
114
|
`title: "${title}"`,
|
|
@@ -135,7 +116,7 @@ export function renderDataTypes(renderer, refDoc, options) {
|
|
|
135
116
|
"toc_max_heading_level: 3",
|
|
136
117
|
"---",
|
|
137
118
|
];
|
|
138
|
-
content.push(
|
|
119
|
+
content.push(groupByNamespace(refDoc.namespaces, (namespace) => {
|
|
139
120
|
const modelCount = namespace.models.length +
|
|
140
121
|
namespace.enums.length +
|
|
141
122
|
namespace.unions.length +
|
|
@@ -157,12 +138,11 @@ export function renderDataTypes(renderer, refDoc, options) {
|
|
|
157
138
|
content.push(renderer.scalar(scalar), "");
|
|
158
139
|
}
|
|
159
140
|
return content;
|
|
160
|
-
}))
|
|
161
|
-
return renderMarkdowDoc(content);
|
|
141
|
+
}));
|
|
142
|
+
return renderMarkdowDoc(content, 2);
|
|
162
143
|
}
|
|
163
144
|
function renderEmitter(renderer, refDoc) {
|
|
164
|
-
|
|
165
|
-
if (((_a = refDoc.emitter) === null || _a === void 0 ? void 0 : _a.options) === undefined) {
|
|
145
|
+
if (refDoc.emitter?.options === undefined) {
|
|
166
146
|
return undefined;
|
|
167
147
|
}
|
|
168
148
|
const content = [
|
|
@@ -173,7 +153,7 @@ function renderEmitter(renderer, refDoc) {
|
|
|
173
153
|
"---",
|
|
174
154
|
renderer.emitterUsage(refDoc),
|
|
175
155
|
];
|
|
176
|
-
return renderMarkdowDoc(content);
|
|
156
|
+
return renderMarkdowDoc(content, 2);
|
|
177
157
|
}
|
|
178
158
|
function renderLinter(renderer, refDoc) {
|
|
179
159
|
if (refDoc.linter === undefined) {
|
|
@@ -187,14 +167,9 @@ function renderLinter(renderer, refDoc) {
|
|
|
187
167
|
"---",
|
|
188
168
|
renderer.linterUsage(refDoc),
|
|
189
169
|
];
|
|
190
|
-
return renderMarkdowDoc(content);
|
|
170
|
+
return renderMarkdowDoc(content, 2);
|
|
191
171
|
}
|
|
192
172
|
export class DocusaurusRenderer extends MarkdownRenderer {
|
|
193
|
-
constructor(refDoc) {
|
|
194
|
-
super();
|
|
195
|
-
_DocusaurusRenderer_refDoc.set(this, void 0);
|
|
196
|
-
__classPrivateFieldSet(this, _DocusaurusRenderer_refDoc, refDoc, "f");
|
|
197
|
-
}
|
|
198
173
|
headingTitle(item) {
|
|
199
174
|
// Set an explicit anchor id.
|
|
200
175
|
return `${inlinecode(item.name)} {#${item.id}}`;
|
|
@@ -217,8 +192,23 @@ export class DocusaurusRenderer extends MarkdownRenderer {
|
|
|
217
192
|
},
|
|
218
193
|
]));
|
|
219
194
|
}
|
|
195
|
+
filename(type) {
|
|
196
|
+
switch (type.kind) {
|
|
197
|
+
case "decorator":
|
|
198
|
+
return "./decorators.md";
|
|
199
|
+
case "operation":
|
|
200
|
+
case "interface":
|
|
201
|
+
return "./interfaces.md";
|
|
202
|
+
case "model":
|
|
203
|
+
case "enum":
|
|
204
|
+
case "union":
|
|
205
|
+
return "./data-types.md";
|
|
206
|
+
default:
|
|
207
|
+
return "";
|
|
208
|
+
}
|
|
209
|
+
}
|
|
220
210
|
linterRuleLink(url) {
|
|
221
|
-
const homepage =
|
|
211
|
+
const homepage = this.refDoc.packageJson.docusaurusWebsite;
|
|
222
212
|
if (homepage && url.includes(homepage)) {
|
|
223
213
|
const fromRoot = url.replace(homepage, "");
|
|
224
214
|
return `${fromRoot}.md`;
|
|
@@ -227,6 +217,16 @@ export class DocusaurusRenderer extends MarkdownRenderer {
|
|
|
227
217
|
return url;
|
|
228
218
|
}
|
|
229
219
|
}
|
|
220
|
+
deprecationNotice(notice) {
|
|
221
|
+
return [":::warning", `**Deprecated**: ${notice.message}`, ":::"];
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
function tabs(tabs) {
|
|
225
|
+
const result = ["<Tabs>"];
|
|
226
|
+
for (const tab of tabs) {
|
|
227
|
+
result.push(`<TabItem value="${tab.id}" label="${tab.label}" default>`, "", tab.content, "", "</TabItem>");
|
|
228
|
+
}
|
|
229
|
+
result.push("</Tabs>", "");
|
|
230
|
+
return result.join("\n");
|
|
230
231
|
}
|
|
231
|
-
_DocusaurusRenderer_refDoc = new WeakMap();
|
|
232
232
|
//# sourceMappingURL=docusaurus.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docusaurus.js","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docusaurus.js","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":"AAQA,OAAO,EAGL,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,OAAO,GACR,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEnE;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAsB;IAC/D,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,KAAK,GAA2B;QACpC,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC/C,CAAC;IAEF,MAAM,aAAa,GAAG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC5D,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC;IACzC,CAAC;IAED,MAAM,aAAa,GAAG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC;IACzC,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACpD,IAAI,SAAS,EAAE,CAAC;QACd,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IACrC,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IAChC,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,MAAM,EAAE,CAAC;QACX,KAAK,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAC9B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,QAA4B,EAAE,MAA6B;IAClF,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,iBAAiB;QACjB,qBAAqB;QACrB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,iCAAiC;QACjC,uCAAuC;QACvC,EAAE;QAEF,MAAM,CAAC,WAAW,IAAI,EAAE;QACxB,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QACxB,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,mCAAmC,CAAC,CAAC,CAAC,CAAC,EAAE;QAE5F,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;YAChD,MAAM,OAAO,GAAG,EAAE,CAAC;YAEnB,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC1E,CAAC;YAED,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC1E,CAAC;YAED,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC1E,CAAC;YAED,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;KACH,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AAMD,MAAM,UAAU,mBAAmB,CACjC,QAA4B,EAC5B,MAA0B,EAC1B,OAAgC;IAEhC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;IAC7C,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,WAAW,KAAK,GAAG;QACnB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAA4B,EAC5B,MAAsB;IAEtB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QACvF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,oCAAoC;QACpC,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CACV,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;QAChD,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3E,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAgB,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YAC7C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AAMD,MAAM,UAAU,eAAe,CAC7B,QAA4B,EAC5B,MAAsB,EACtB,OAA+B;IAE/B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC;IAC7C,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,WAAW,KAAK,GAAG;QACnB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CACV,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;QAChD,MAAM,UAAU,GACd,SAAS,CAAC,MAAM,CAAC,MAAM;YACvB,SAAS,CAAC,KAAK,CAAC,MAAM;YACtB,SAAS,CAAC,MAAM,CAAC,MAAM;YACvB,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;QAC3B,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAgB,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,aAAa,CACpB,QAA4B,EAC5B,MAA6B;IAE7B,IAAI,MAAM,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,wBAAwB;QACxB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC;KAC9B,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AACD,SAAS,YAAY,CACnB,QAA4B,EAC5B,MAA6B;IAE7B,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,uBAAuB;QACvB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;KAC7B,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,gBAAgB;IACtD,YAAY,CAAC,IAAqB;QAChC,6BAA6B;QAC7B,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,GAAG,CAAC;IAClD,CAAC;IACD,QAAQ,CAAC,IAAqB;QAC5B,6BAA6B;QAC7B,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,MAA6B;QACnC,OAAO,OAAO,CACZ,SAAS,EACT,IAAI,CAAC;YACH;gBACE,EAAE,EAAE,MAAM;gBACV,KAAK,EAAE,WAAW;gBAClB,OAAO,EAAE,SAAS,CAAC,eAAe,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC;aACzD;YACD;gBACE,EAAE,EAAE,SAAS;gBACb,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,SAAS,CAAC,2BAA2B,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC;aACrE;SACF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,IAAkB;QACzB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,WAAW;gBACd,OAAO,iBAAiB,CAAC;YAC3B,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW;gBACd,OAAO,iBAAiB,CAAC;YAC3B,KAAK,OAAO,CAAC;YACb,KAAK,MAAM,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,iBAAiB,CAAC;YAC3B;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAED,cAAc,CAAC,GAAW;QACxB,MAAM,QAAQ,GAAI,IAAI,CAAC,MAAM,CAAC,WAAmB,CAAC,iBAAiB,CAAC;QACpE,IAAI,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC3C,OAAO,GAAG,QAAQ,KAAK,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,MAAyB;QACzC,OAAO,CAAC,YAAY,EAAE,mBAAmB,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;CACF;AAQD,SAAS,IAAI,CAAC,IAAW;IACvB,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CACT,mBAAmB,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC,KAAK,YAAY,EAC1D,EAAE,EACF,GAAG,CAAC,OAAO,EACX,EAAE,EACF,YAAY,CACb,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC"}
|
|
@@ -1,31 +1,46 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Entity, MixedParameterConstraint } from "@typespec/compiler";
|
|
2
|
+
import { DecoratorRefDoc, DeprecationNotice, EmitterOptionRefDoc, EnumRefDoc, ExampleRefDoc, InterfaceRefDoc, LinterRuleRefDoc, ModelPropertyRefDoc, ModelRefDoc, NamedTypeRefDoc, NamespaceRefDoc, OperationRefDoc, RefDocEntity, ReferencableElement, ScalarRefDoc, TemplateParameterRefDoc, TypeSpecRefDoc, TypeSpecRefDocBase, UnionRefDoc } from "../types.js";
|
|
2
3
|
import { MarkdownDoc } from "../utils/markdown.js";
|
|
3
4
|
export declare function renderReadme(refDoc: TypeSpecRefDoc, projectRoot: string): Promise<string>;
|
|
4
|
-
export declare function groupByNamespace(namespaces: NamespaceRefDoc[], callback: (namespace: NamespaceRefDoc) => MarkdownDoc | undefined): MarkdownDoc;
|
|
5
|
+
export declare function groupByNamespace(namespaces: readonly NamespaceRefDoc[], callback: (namespace: NamespaceRefDoc) => MarkdownDoc | undefined): MarkdownDoc;
|
|
5
6
|
/**
|
|
6
7
|
* Github flavored markdown renderer.
|
|
7
8
|
*/
|
|
8
9
|
export declare class MarkdownRenderer {
|
|
10
|
+
protected readonly refDoc: TypeSpecRefDoc;
|
|
11
|
+
constructor(refDoc: TypeSpecRefDoc);
|
|
9
12
|
headingTitle(item: NamedTypeRefDoc): string;
|
|
10
13
|
anchorId(item: ReferencableElement): string;
|
|
14
|
+
deprecationNotice(notice: DeprecationNotice): MarkdownDoc;
|
|
15
|
+
typeSection(type: NamedTypeRefDoc, content: MarkdownDoc): import("../utils/markdown.js").MarkdownSection;
|
|
11
16
|
operation(op: OperationRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
12
17
|
interface(iface: InterfaceRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
13
18
|
model(model: ModelRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
19
|
+
modelProperties(model: ModelRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
20
|
+
modelPropertyRows(prop: ModelPropertyRefDoc): {
|
|
21
|
+
name: string;
|
|
22
|
+
type: string;
|
|
23
|
+
doc: string;
|
|
24
|
+
}[];
|
|
25
|
+
ref(type: Entity, prefix?: string): string;
|
|
14
26
|
enum(e: EnumRefDoc): MarkdownDoc;
|
|
27
|
+
enumMembers(e: EnumRefDoc): MarkdownDoc;
|
|
15
28
|
union(union: UnionRefDoc): MarkdownDoc;
|
|
16
29
|
scalar(scalar: ScalarRefDoc): MarkdownDoc;
|
|
17
|
-
templateParameters(templateParameters: TemplateParameterRefDoc[]): MarkdownDoc;
|
|
30
|
+
templateParameters(templateParameters: readonly TemplateParameterRefDoc[]): MarkdownDoc;
|
|
18
31
|
decorator(dec: DecoratorRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
19
|
-
|
|
32
|
+
MixedParameterConstraint(constraint: MixedParameterConstraint): string;
|
|
33
|
+
examples(examples: readonly ExampleRefDoc[]): "" | import("../utils/markdown.js").MarkdownSection;
|
|
20
34
|
/** Render all decorators */
|
|
21
35
|
decoratorsSection(refDoc: TypeSpecRefDocBase, options?: {
|
|
22
36
|
includeToc?: boolean;
|
|
23
37
|
}): MarkdownDoc;
|
|
24
|
-
toc(items: ReferencableElement
|
|
38
|
+
toc(items: readonly (ReferencableElement & RefDocEntity)[]): string[];
|
|
39
|
+
filename(type: ReferencableElement & RefDocEntity): string;
|
|
25
40
|
install(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection;
|
|
26
|
-
emitterUsage(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection
|
|
41
|
+
emitterUsage(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection[];
|
|
27
42
|
emitterOptions(options: EmitterOptionRefDoc[]): import("../utils/markdown.js").MarkdownSection;
|
|
28
|
-
linterUsage(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection
|
|
43
|
+
linterUsage(refDoc: TypeSpecRefDoc): (never[] | import("../utils/markdown.js").MarkdownSection)[];
|
|
29
44
|
linterRuleToc(rules: LinterRuleRefDoc[]): string;
|
|
30
45
|
linterRuleLink(url: string): string;
|
|
31
46
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/markdown.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,wBAAwB,EAIzB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,UAAU,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EAOZ,MAAM,sBAAsB,CAAC;AAc9B,wBAAsB,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,mBAmC7E;AAED,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,SAAS,eAAe,EAAE,EACtC,QAAQ,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,WAAW,GAAG,SAAS,GAChE,WAAW,CASb;AAED;;GAEG;AACH,qBAAa,gBAAgB;IACf,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc;gBAAtB,MAAM,EAAE,cAAc;IACrD,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAI3C,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM;IAI3C,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW;IAIzD,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW;IAMvD,SAAS,CAAC,EAAE,EAAE,eAAe;IAY7B,SAAS,CAAC,KAAK,EAAE,eAAe;IAkBhC,KAAK,CAAC,KAAK,EAAE,WAAW;IAYxB,eAAe,CAAC,KAAK,EAAE,WAAW;IA0BlC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE;IAoB3F,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAW,GAAG,MAAM;IAqB9C,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,WAAW;IAahC,WAAW,CAAC,CAAC,EAAE,UAAU,GAAG,WAAW;IAevC,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAYtC,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW;IAYzC,kBAAkB,CAAC,kBAAkB,EAAE,SAAS,uBAAuB,EAAE,GAAG,WAAW;IASvF,SAAS,CAAC,GAAG,EAAE,eAAe;IAoB9B,wBAAwB,CAAC,UAAU,EAAE,wBAAwB,GAAG,MAAM;IAOtE,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE;IAkB3C,4BAA4B;IAC5B,iBAAiB,CACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GACrC,WAAW;IAYd,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,mBAAmB,GAAG,YAAY,CAAC,EAAE;IAM1D,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,YAAY,GAAG,MAAM;IAI1D,OAAO,CAAC,MAAM,EAAE,cAAc;IAI9B,YAAY,CAAC,MAAM,EAAE,cAAc;IAqBnC,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE;IAY7C,WAAW,CAAC,MAAM,EAAE,cAAc;IAqBlC,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE;IAWvC,cAAc,CAAC,GAAG,EAAE,MAAM;CAG3B"}
|