compmark-vue 0.2.5 → 0.3.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 +169 -7
- package/dist/cli.mjs +728 -53
- package/dist/index.d.mts +37 -2
- package/dist/index.mjs +534 -25
- package/package.json +9 -3
package/dist/index.d.mts
CHANGED
|
@@ -25,27 +25,62 @@ interface ExposeDoc {
|
|
|
25
25
|
type: string;
|
|
26
26
|
description: string;
|
|
27
27
|
}
|
|
28
|
+
interface ComposableVariable {
|
|
29
|
+
name: string;
|
|
30
|
+
type?: string;
|
|
31
|
+
}
|
|
28
32
|
interface ComposableDoc {
|
|
29
33
|
name: string;
|
|
34
|
+
source?: string;
|
|
35
|
+
variables: ComposableVariable[];
|
|
30
36
|
}
|
|
31
37
|
interface ComponentDoc {
|
|
32
38
|
name: string;
|
|
33
39
|
description?: string;
|
|
34
40
|
internal?: boolean;
|
|
41
|
+
scriptSetup?: boolean;
|
|
35
42
|
props: PropDoc[];
|
|
36
43
|
emits: EmitDoc[];
|
|
37
44
|
slots?: SlotDoc[];
|
|
38
45
|
exposes?: ExposeDoc[];
|
|
39
46
|
composables?: ComposableDoc[];
|
|
40
47
|
}
|
|
48
|
+
type OutputFormat = "md" | "json";
|
|
49
|
+
interface RunSummary {
|
|
50
|
+
documented: number;
|
|
51
|
+
skipped: number;
|
|
52
|
+
errors: number;
|
|
53
|
+
files: Array<{
|
|
54
|
+
path: string;
|
|
55
|
+
doc: ComponentDoc;
|
|
56
|
+
}>;
|
|
57
|
+
errorDetails: Array<{
|
|
58
|
+
path: string;
|
|
59
|
+
error: string;
|
|
60
|
+
}>;
|
|
61
|
+
}
|
|
41
62
|
//#endregion
|
|
42
63
|
//#region src/parser.d.ts
|
|
43
|
-
declare function parseSFC(source: string, filename: string): ComponentDoc;
|
|
64
|
+
declare function parseSFC(source: string, filename: string, sfcDir?: string): ComponentDoc;
|
|
44
65
|
//#endregion
|
|
45
66
|
//#region src/markdown.d.ts
|
|
46
67
|
declare function generateMarkdown(doc: ComponentDoc): string;
|
|
68
|
+
declare function adjustHeadingLevel(md: string, increment: number): string;
|
|
69
|
+
//#endregion
|
|
70
|
+
//#region src/discovery.d.ts
|
|
71
|
+
declare function discoverFiles(inputs: string[], ignore?: string[]): Promise<string[]>;
|
|
72
|
+
//#endregion
|
|
73
|
+
//#region src/runner.d.ts
|
|
74
|
+
declare function processFiles(filePaths: string[], options: {
|
|
75
|
+
silent?: boolean;
|
|
76
|
+
}): RunSummary;
|
|
77
|
+
//#endregion
|
|
78
|
+
//#region src/type-resolver.d.ts
|
|
79
|
+
declare function resolveImportedPropsType(typeName: string, importMap: Map<string, string>, sfcDir: string): {
|
|
80
|
+
members: Array<any>;
|
|
81
|
+
} | null;
|
|
47
82
|
//#endregion
|
|
48
83
|
//#region src/index.d.ts
|
|
49
84
|
declare function parseComponent(filePath: string): ComponentDoc;
|
|
50
85
|
//#endregion
|
|
51
|
-
export { type ComponentDoc, type ComposableDoc, type EmitDoc, type ExposeDoc, type PropDoc, type SlotDoc, generateMarkdown, parseComponent, parseSFC };
|
|
86
|
+
export { type ComponentDoc, type ComposableDoc, type ComposableVariable, type EmitDoc, type ExposeDoc, type OutputFormat, type PropDoc, type RunSummary, type SlotDoc, adjustHeadingLevel, discoverFiles, generateMarkdown, parseComponent, parseSFC, processFiles, resolveImportedPropsType };
|