@qualcomm-ui/mdx-vite 3.5.0 → 3.6.1
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/dist/cli.js +6 -2
- package/dist/cli.js.map +2 -2
- package/dist/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.d.ts +2 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.d.ts.map +1 -1
- package/dist/docs-plugin/markdown/knowledge/section-extractor.d.ts.map +1 -1
- package/dist/docs-plugin/markdown/knowledge/types.d.ts +1 -0
- package/dist/docs-plugin/markdown/knowledge/types.d.ts.map +1 -1
- package/dist/index.js +19 -4
- package/dist/index.js.map +2 -2
- package/dist/tsbuildinfo +1 -1
- package/package.json +5 -5
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Plugin } from "unified";
|
|
2
2
|
import type { SimplifiedProp } from "@qualcomm-ui/mdx-common";
|
|
3
|
+
import type { QuiComment } from "@qualcomm-ui/typedoc-common";
|
|
3
4
|
import type { ComponentProps, DocProps } from "../types";
|
|
4
5
|
export interface PropFormatterOptions {
|
|
5
6
|
docPropsPath?: string;
|
|
@@ -15,6 +16,7 @@ export declare class PropFormatter {
|
|
|
15
16
|
loadDocProps(): Promise<DocProps | null>;
|
|
16
17
|
private formatCommentParts;
|
|
17
18
|
private formatComment;
|
|
19
|
+
extractSinceTag(comment: QuiComment | undefined): string | undefined;
|
|
18
20
|
extractProps(props: ComponentProps, isPartial: boolean): SimplifiedProp[];
|
|
19
21
|
private convertPropInfo;
|
|
20
22
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doc-props-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAA;
|
|
1
|
+
{"version":3,"file":"doc-props-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAA;AAC3D,OAAO,KAAK,EACV,UAAU,EAEX,MAAM,6BAA6B,CAAA;AAIpC,OAAO,KAAK,EAAC,cAAc,EAAE,QAAQ,EAAW,MAAM,UAAU,CAAA;AAoDhE,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAwB;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,oBAAoB;IAMnC,YAAY,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAoC9C,OAAO,CAAC,kBAAkB;IAoC1B,OAAO,CAAC,aAAa;IAoCrB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAKpE,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,cAAc,EAAE;IA0BzE,OAAO,CAAC,eAAe;IAkBvB;;;OAGG;IACH,mBAAmB,IAAI,MAAM;CAoG9B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"section-extractor.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/section-extractor.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAqB,IAAI,EAAoB,MAAM,OAAO,CAAA;AAOtE,OAAO,KAAK,EAEV,SAAS,EACT,WAAW,EACX,YAAY,EAGb,MAAM,yBAAyB,CAAA;AAOhC,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAeD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,GAAG,EAAE,WAAW,EAAE,CAAA;CACnB;AA+BD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;gBAEzB,OAAO,CAAC,EAAE,uBAAuB;IAO7C;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,gBAAgB;IA2FzD;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI;IA6B7D,OAAO,CAAC,iBAAiB;
|
|
1
|
+
{"version":3,"file":"section-extractor.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/section-extractor.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAqB,IAAI,EAAoB,MAAM,OAAO,CAAA;AAOtE,OAAO,KAAK,EAEV,SAAS,EACT,WAAW,EACX,YAAY,EAGb,MAAM,yBAAyB,CAAA;AAOhC,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAeD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,GAAG,EAAE,WAAW,EAAE,CAAA;CACnB;AA+BD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;gBAEzB,OAAO,CAAC,EAAE,uBAAuB;IAO7C;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,gBAAgB;IA2FzD;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI;IA6B7D,OAAO,CAAC,iBAAiB;IA6EzB,OAAO,CAAC,YAAY;IAwCpB,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,iBAAiB;CAG1B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,OAAO,CAAA;AAE/B,OAAO,KAAK,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAA;AAE3D,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAA;IAClB,iEAAiE;IACjE,UAAU,EAAE,IAAI,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,mBAAmB,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAC3B,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB;AAED,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,OAAO,CAAA;AAE/B,OAAO,KAAK,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAA;AAE3D,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAA;IACnB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAA;IAClB,iEAAiE;IACjE,UAAU,EAAE,IAAI,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,mBAAmB,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAC3B,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB;AAED,MAAM,MAAM,kBAAkB,GAAG,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -2364,6 +2364,10 @@ ${tagContent.trim()}
|
|
|
2364
2364
|
}
|
|
2365
2365
|
return parts.join("\n\n");
|
|
2366
2366
|
}
|
|
2367
|
+
extractSinceTag(comment) {
|
|
2368
|
+
const sinceTag = comment?.blockTags?.find((tag) => tag?.tag === "@since");
|
|
2369
|
+
return sinceTag?.content?.[0]?.text;
|
|
2370
|
+
}
|
|
2367
2371
|
extractProps(props, isPartial) {
|
|
2368
2372
|
const propsInfo = [];
|
|
2369
2373
|
if (props.props?.length) {
|
|
@@ -2396,7 +2400,8 @@ ${tagContent.trim()}
|
|
|
2396
2400
|
},
|
|
2397
2401
|
description: this.formatComment(propInfo.comment || null),
|
|
2398
2402
|
propType,
|
|
2399
|
-
required: extractRequired(propInfo, isPartial) || void 0
|
|
2403
|
+
required: extractRequired(propInfo, isPartial) || void 0,
|
|
2404
|
+
since: this.extractSinceTag(propInfo.comment)
|
|
2400
2405
|
};
|
|
2401
2406
|
}
|
|
2402
2407
|
/**
|
|
@@ -2476,7 +2481,13 @@ ${propsToDefinitionList(outputs)}`);
|
|
|
2476
2481
|
return;
|
|
2477
2482
|
}
|
|
2478
2483
|
Object.assign(node, {
|
|
2479
|
-
data: {
|
|
2484
|
+
data: {
|
|
2485
|
+
typeDocProps: {
|
|
2486
|
+
name: propsName,
|
|
2487
|
+
props: propTypes,
|
|
2488
|
+
since: this.extractSinceTag(componentProps.comment)
|
|
2489
|
+
}
|
|
2490
|
+
},
|
|
2480
2491
|
lang: null,
|
|
2481
2492
|
meta: null,
|
|
2482
2493
|
type: "code",
|
|
@@ -2772,8 +2783,12 @@ var SectionExtractor = class {
|
|
|
2772
2783
|
if (node.type === "code") {
|
|
2773
2784
|
const codeNode = node;
|
|
2774
2785
|
if (codeNode.data?.typeDocProps) {
|
|
2775
|
-
const { name, props } = codeNode.data.typeDocProps;
|
|
2776
|
-
sectionTypes.push({
|
|
2786
|
+
const { name, props, since } = codeNode.data.typeDocProps;
|
|
2787
|
+
sectionTypes.push({
|
|
2788
|
+
props,
|
|
2789
|
+
since,
|
|
2790
|
+
type: name
|
|
2791
|
+
});
|
|
2777
2792
|
}
|
|
2778
2793
|
codeExamples.push({
|
|
2779
2794
|
code: codeNode.value,
|