@refrakt-md/docs 0.9.0 → 0.9.2
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-plugin.d.ts +12 -0
- package/dist/cli-plugin.d.ts.map +1 -0
- package/dist/cli-plugin.js +113 -0
- package/dist/cli-plugin.js.map +1 -0
- package/dist/extract/command.d.ts +10 -0
- package/dist/extract/command.d.ts.map +1 -0
- package/dist/extract/command.js +161 -0
- package/dist/extract/command.js.map +1 -0
- package/dist/extract/extractors.d.ts +3 -0
- package/dist/extract/extractors.d.ts.map +1 -0
- package/dist/extract/extractors.js +17 -0
- package/dist/extract/extractors.js.map +1 -0
- package/dist/extract/layout-generator.d.ts +8 -0
- package/dist/extract/layout-generator.d.ts.map +1 -0
- package/dist/extract/layout-generator.js +22 -0
- package/dist/extract/layout-generator.js.map +1 -0
- package/dist/extract/python-docstring.d.ts +26 -0
- package/dist/extract/python-docstring.d.ts.map +1 -0
- package/dist/extract/python-docstring.js +396 -0
- package/dist/extract/python-docstring.js.map +1 -0
- package/dist/extract/python.d.ts +21 -0
- package/dist/extract/python.d.ts.map +1 -0
- package/dist/extract/python.js +557 -0
- package/dist/extract/python.js.map +1 -0
- package/dist/extract/symbol-generator.d.ts +14 -0
- package/dist/extract/symbol-generator.d.ts.map +1 -0
- package/dist/extract/symbol-generator.js +201 -0
- package/dist/extract/symbol-generator.js.map +1 -0
- package/dist/extract/types.d.ts +55 -0
- package/dist/extract/types.d.ts.map +1 -0
- package/dist/extract/types.js +2 -0
- package/dist/extract/types.js.map +1 -0
- package/dist/extract/typescript.d.ts +28 -0
- package/dist/extract/typescript.d.ts.map +1 -0
- package/dist/extract/typescript.js +562 -0
- package/dist/extract/typescript.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/props.d.ts +34 -0
- package/dist/props.d.ts.map +1 -0
- package/dist/props.js +2 -0
- package/dist/props.js.map +1 -0
- package/dist/tags/api.d.ts.map +1 -1
- package/dist/tags/api.js +1 -2
- package/dist/tags/api.js.map +1 -1
- package/dist/tags/changelog.d.ts.map +1 -1
- package/dist/tags/changelog.js +20 -34
- package/dist/tags/changelog.js.map +1 -1
- package/dist/tags/symbol.d.ts.map +1 -1
- package/dist/tags/symbol.js +3 -4
- package/dist/tags/symbol.js.map +1 -1
- package/package.json +18 -5
- package/dist/schema/api.d.ts +0 -6
- package/dist/schema/api.d.ts.map +0 -1
- package/dist/schema/api.js +0 -8
- package/dist/schema/api.js.map +0 -1
- package/dist/schema/changelog.d.ts +0 -10
- package/dist/schema/changelog.d.ts.map +0 -1
- package/dist/schema/changelog.js +0 -15
- package/dist/schema/changelog.js.map +0 -1
- package/dist/schema/symbol.d.ts +0 -14
- package/dist/schema/symbol.d.ts.map +0 -1
- package/dist/schema/symbol.js +0 -20
- package/dist/schema/symbol.js.map +0 -1
- package/dist/types.d.ts +0 -12
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -13
- package/dist/types.js.map +0 -1
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
const GROUP_KINDS = ['class', 'interface', 'module'];
|
|
2
|
+
function isGroupKind(kind) {
|
|
3
|
+
return GROUP_KINDS.includes(kind);
|
|
4
|
+
}
|
|
5
|
+
/** Convert camelCase/PascalCase to kebab-case for file slugs */
|
|
6
|
+
export function toSlug(name) {
|
|
7
|
+
return name
|
|
8
|
+
.replace(/([a-z0-9])([A-Z])/g, '$1-$2')
|
|
9
|
+
.replace(/([A-Z])([A-Z][a-z])/g, '$1-$2')
|
|
10
|
+
.toLowerCase();
|
|
11
|
+
}
|
|
12
|
+
function escapeYaml(s) {
|
|
13
|
+
if (/[:"'{}\[\]#&*!|>%@`]/.test(s) || s.startsWith(' ') || s.endsWith(' ')) {
|
|
14
|
+
return `"${s.replace(/"/g, '\\"')}"`;
|
|
15
|
+
}
|
|
16
|
+
return s;
|
|
17
|
+
}
|
|
18
|
+
function heading(level, text) {
|
|
19
|
+
return `${'#'.repeat(level)} ${text}`;
|
|
20
|
+
}
|
|
21
|
+
function formatParameter(param) {
|
|
22
|
+
const optionalMark = param.optional ? ' *(optional)*' : '';
|
|
23
|
+
const defaultMark = param.defaultValue ? ` *Default: \`${param.defaultValue}\`*` : '';
|
|
24
|
+
const desc = param.description ? ` -- ${param.description}` : '';
|
|
25
|
+
return `- **${param.name}** \`${param.type}\`${optionalMark}${desc}${defaultMark}`;
|
|
26
|
+
}
|
|
27
|
+
function formatChildParameter(param) {
|
|
28
|
+
const optionalMark = param.optional ? ' *(optional)*' : '';
|
|
29
|
+
const defaultMark = param.defaultValue ? ` *Default: \`${param.defaultValue}\`*` : '';
|
|
30
|
+
const desc = param.description ? ` -- ${param.description}` : '';
|
|
31
|
+
return ` - **${param.name}** \`${param.type}\`${optionalMark}${desc}${defaultMark}`;
|
|
32
|
+
}
|
|
33
|
+
function writeMember(lines, member, memberLevel, lang = 'typescript') {
|
|
34
|
+
lines.push(heading(memberLevel, member.name));
|
|
35
|
+
lines.push('');
|
|
36
|
+
if (member.description) {
|
|
37
|
+
lines.push(member.description);
|
|
38
|
+
lines.push('');
|
|
39
|
+
}
|
|
40
|
+
lines.push(`\`\`\`${lang}`);
|
|
41
|
+
lines.push(member.signature);
|
|
42
|
+
lines.push('```');
|
|
43
|
+
lines.push('');
|
|
44
|
+
if (member.parameters && member.parameters.length > 0) {
|
|
45
|
+
for (const param of member.parameters) {
|
|
46
|
+
lines.push(formatParameter(param));
|
|
47
|
+
if (param.children) {
|
|
48
|
+
for (const child of param.children) {
|
|
49
|
+
lines.push(formatChildParameter(child));
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
lines.push('');
|
|
54
|
+
}
|
|
55
|
+
if (member.returns) {
|
|
56
|
+
const desc = member.returns.description ? ` -- ${member.returns.description}` : '';
|
|
57
|
+
lines.push(`> Returns \`${member.returns.type}\`${desc}`);
|
|
58
|
+
lines.push('');
|
|
59
|
+
}
|
|
60
|
+
if (member.throws) {
|
|
61
|
+
for (const t of member.throws) {
|
|
62
|
+
const desc = t.description ? ` ${t.description}` : '';
|
|
63
|
+
lines.push(`> Throws \`${t.type}\`${desc}`);
|
|
64
|
+
lines.push('');
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
/** Generate a single {% symbol %} Markdown block for one SymbolDoc */
|
|
69
|
+
export function generateSymbolMarkdown(doc, options) {
|
|
70
|
+
const level = 2;
|
|
71
|
+
const lines = [];
|
|
72
|
+
// Frontmatter
|
|
73
|
+
if (options?.frontmatter !== false) {
|
|
74
|
+
lines.push('---');
|
|
75
|
+
lines.push(`title: ${escapeYaml(doc.name)}`);
|
|
76
|
+
const firstLine = doc.description.split('\n')[0].trim();
|
|
77
|
+
if (firstLine) {
|
|
78
|
+
lines.push(`description: ${escapeYaml(firstLine)}`);
|
|
79
|
+
}
|
|
80
|
+
lines.push('---');
|
|
81
|
+
lines.push('');
|
|
82
|
+
}
|
|
83
|
+
// Opening tag
|
|
84
|
+
const lang = options?.lang ?? 'typescript';
|
|
85
|
+
const attrs = [`kind="${doc.kind}"`];
|
|
86
|
+
attrs.push(`lang="${lang}"`);
|
|
87
|
+
if (doc.since)
|
|
88
|
+
attrs.push(`since="${doc.since}"`);
|
|
89
|
+
if (doc.deprecated)
|
|
90
|
+
attrs.push(`deprecated="${doc.deprecated}"`);
|
|
91
|
+
if (doc.source)
|
|
92
|
+
attrs.push(`source="${doc.source}"`);
|
|
93
|
+
lines.push(`{% symbol ${attrs.join(' ')} %}`);
|
|
94
|
+
lines.push('');
|
|
95
|
+
// Symbol name heading
|
|
96
|
+
lines.push(heading(level, doc.name));
|
|
97
|
+
lines.push('');
|
|
98
|
+
// For functions/enums/types: description before signature
|
|
99
|
+
// For classes/interfaces/modules: description after signature
|
|
100
|
+
if (!isGroupKind(doc.kind)) {
|
|
101
|
+
if (doc.description) {
|
|
102
|
+
lines.push(doc.description);
|
|
103
|
+
lines.push('');
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
// Type signature
|
|
107
|
+
lines.push(`\`\`\`${lang}`);
|
|
108
|
+
lines.push(doc.signature);
|
|
109
|
+
lines.push('```');
|
|
110
|
+
lines.push('');
|
|
111
|
+
// For group kinds: description after signature
|
|
112
|
+
if (isGroupKind(doc.kind)) {
|
|
113
|
+
if (doc.description) {
|
|
114
|
+
lines.push(doc.description);
|
|
115
|
+
lines.push('');
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
// Parameters (for function/enum kinds)
|
|
119
|
+
if (doc.parameters && doc.parameters.length > 0) {
|
|
120
|
+
for (const param of doc.parameters) {
|
|
121
|
+
lines.push(formatParameter(param));
|
|
122
|
+
if (param.children) {
|
|
123
|
+
for (const child of param.children) {
|
|
124
|
+
lines.push(formatChildParameter(child));
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
lines.push('');
|
|
129
|
+
}
|
|
130
|
+
// Returns (as blockquote)
|
|
131
|
+
if (doc.returns) {
|
|
132
|
+
const desc = doc.returns.description ? ` -- ${doc.returns.description}` : '';
|
|
133
|
+
lines.push(`> Returns \`${doc.returns.type}\`${desc}`);
|
|
134
|
+
lines.push('');
|
|
135
|
+
}
|
|
136
|
+
// Throws (as blockquotes)
|
|
137
|
+
if (doc.throws) {
|
|
138
|
+
for (const t of doc.throws) {
|
|
139
|
+
const desc = t.description ? ` ${t.description}` : '';
|
|
140
|
+
lines.push(`> Throws \`${t.type}\`${desc}`);
|
|
141
|
+
lines.push('');
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
// Groups (for class/interface/module kinds)
|
|
145
|
+
if (doc.groups) {
|
|
146
|
+
const groupLevel = level + 1;
|
|
147
|
+
const memberLevel = level + 2;
|
|
148
|
+
for (const group of doc.groups) {
|
|
149
|
+
// Special case: Constructor group has no group heading in the docs format
|
|
150
|
+
// Actually, looking at the docs, Constructor IS a group heading
|
|
151
|
+
lines.push(heading(groupLevel, group.label));
|
|
152
|
+
lines.push('');
|
|
153
|
+
if (group.members.length === 1 && group.label === 'Constructor') {
|
|
154
|
+
// Constructor is typically shown without a member sub-heading
|
|
155
|
+
const member = group.members[0];
|
|
156
|
+
if (member.description) {
|
|
157
|
+
lines.push(member.description);
|
|
158
|
+
lines.push('');
|
|
159
|
+
}
|
|
160
|
+
lines.push(`\`\`\`${lang}`);
|
|
161
|
+
lines.push(member.signature);
|
|
162
|
+
lines.push('```');
|
|
163
|
+
lines.push('');
|
|
164
|
+
if (member.parameters && member.parameters.length > 0) {
|
|
165
|
+
for (const param of member.parameters) {
|
|
166
|
+
lines.push(formatParameter(param));
|
|
167
|
+
if (param.children) {
|
|
168
|
+
for (const child of param.children) {
|
|
169
|
+
lines.push(formatChildParameter(child));
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
lines.push('');
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
else {
|
|
177
|
+
for (const member of group.members) {
|
|
178
|
+
writeMember(lines, member, memberLevel, lang);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
// Closing tag
|
|
184
|
+
lines.push('{% /symbol %}');
|
|
185
|
+
lines.push('');
|
|
186
|
+
return lines.join('\n');
|
|
187
|
+
}
|
|
188
|
+
/** Generate a single file containing multiple symbols from the same source file */
|
|
189
|
+
export function generateMultiSymbolMarkdown(docs, fileName) {
|
|
190
|
+
const lines = [];
|
|
191
|
+
lines.push('---');
|
|
192
|
+
lines.push(`title: ${escapeYaml(fileName)}`);
|
|
193
|
+
lines.push(`description: ${escapeYaml(`API reference for ${fileName}`)}`);
|
|
194
|
+
lines.push('---');
|
|
195
|
+
lines.push('');
|
|
196
|
+
for (const doc of docs) {
|
|
197
|
+
lines.push(generateSymbolMarkdown(doc, { frontmatter: false }));
|
|
198
|
+
}
|
|
199
|
+
return lines.join('\n');
|
|
200
|
+
}
|
|
201
|
+
//# sourceMappingURL=symbol-generator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"symbol-generator.js","sourceRoot":"","sources":["../../src/extract/symbol-generator.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,GAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;AAEnE,SAAS,WAAW,CAAC,IAAgB;IACpC,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,MAAM,CAAC,IAAY;IAClC,OAAO,IAAI;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,sBAAsB,EAAE,OAAO,CAAC;SACxC,WAAW,EAAE,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,CAAS;IAC5B,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;IACtC,CAAC;IACD,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,IAAY;IAC3C,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,eAAe,CAAC,KAAsB;IAC9C,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3D,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,OAAO,OAAO,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,KAAK,YAAY,GAAG,IAAI,GAAG,WAAW,EAAE,CAAC;AACpF,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAsB;IACnD,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3D,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,OAAO,SAAS,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,KAAK,YAAY,GAAG,IAAI,GAAG,WAAW,EAAE,CAAC;AACtF,CAAC;AAED,SAAS,WAAW,CAAC,KAAe,EAAE,MAAuB,EAAE,WAAmB,EAAE,IAAI,GAAG,YAAY;IACtG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACpC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzC,CAAC;YACF,CAAC;QACF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,KAAK,CAAC,IAAI,CAAC,eAAe,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;IACF,CAAC;AACF,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,sBAAsB,CAAC,GAAc,EAAE,OAA0B;IAChF,MAAM,KAAK,GAAG,CAAC,CAAC;IAChB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,cAAc;IACd,IAAI,OAAO,EAAE,WAAW,KAAK,KAAK,EAAE,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,UAAU,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxD,IAAI,SAAS,EAAE,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,cAAc;IACd,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,YAAY,CAAC;IAC3C,MAAM,KAAK,GAAa,CAAC,SAAS,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC;IAC7B,IAAI,GAAG,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC;IAClD,IAAI,GAAG,CAAC,UAAU;QAAE,KAAK,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;IACjE,IAAI,GAAG,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,sBAAsB;IACtB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,0DAA0D;IAC1D,8DAA8D;IAC9D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;IACF,CAAC;IAED,iBAAiB;IACjB,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,+CAA+C;IAC/C,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;IACF,CAAC;IAED,uCAAuC;IACvC,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACpC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzC,CAAC;YACF,CAAC;QACF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,KAAK,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChB,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;IACF,CAAC;IAED,4CAA4C;IAC5C,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,UAAU,GAAG,KAAK,GAAG,CAAC,CAAC;QAC7B,MAAM,WAAW,GAAG,KAAK,GAAG,CAAC,CAAC;QAE9B,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YAChC,0EAA0E;YAC1E,gEAAgE;YAChE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAEf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;gBACjE,8DAA8D;gBAC9D,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAEhC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;oBACxB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;oBAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAChB,CAAC;gBAED,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;gBAC5B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEf,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACvD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;wBACvC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;wBACnC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;4BACpB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gCACpC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;4BACzC,CAAC;wBACF,CAAC;oBACF,CAAC;oBACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAChB,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBACpC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;gBAC/C,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,cAAc;IACd,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,2BAA2B,CAAC,IAAiB,EAAE,QAAgB;IAC9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,UAAU,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,CAAC,gBAAgB,UAAU,CAAC,qBAAqB,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1E,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
export type SymbolKind = 'function' | 'class' | 'interface' | 'enum' | 'type' | 'module' | 'hook' | 'component';
|
|
2
|
+
export interface SymbolParameter {
|
|
3
|
+
name: string;
|
|
4
|
+
type: string;
|
|
5
|
+
description: string;
|
|
6
|
+
optional: boolean;
|
|
7
|
+
defaultValue?: string;
|
|
8
|
+
children?: SymbolParameter[];
|
|
9
|
+
}
|
|
10
|
+
export interface SymbolReturn {
|
|
11
|
+
type: string;
|
|
12
|
+
description: string;
|
|
13
|
+
}
|
|
14
|
+
export interface SymbolThrows {
|
|
15
|
+
type: string;
|
|
16
|
+
description: string;
|
|
17
|
+
}
|
|
18
|
+
export interface SymbolMemberDoc {
|
|
19
|
+
name: string;
|
|
20
|
+
kind: 'property' | 'method' | 'constructor' | 'accessor' | 'index-signature';
|
|
21
|
+
signature: string;
|
|
22
|
+
description: string;
|
|
23
|
+
parameters?: SymbolParameter[];
|
|
24
|
+
returns?: SymbolReturn;
|
|
25
|
+
throws?: SymbolThrows[];
|
|
26
|
+
since?: string;
|
|
27
|
+
deprecated?: string;
|
|
28
|
+
}
|
|
29
|
+
export interface SymbolGroupDoc {
|
|
30
|
+
label: string;
|
|
31
|
+
members: SymbolMemberDoc[];
|
|
32
|
+
}
|
|
33
|
+
export interface SymbolDoc {
|
|
34
|
+
name: string;
|
|
35
|
+
kind: SymbolKind;
|
|
36
|
+
signature: string;
|
|
37
|
+
description: string;
|
|
38
|
+
parameters?: SymbolParameter[];
|
|
39
|
+
returns?: SymbolReturn;
|
|
40
|
+
throws?: SymbolThrows[];
|
|
41
|
+
since?: string;
|
|
42
|
+
deprecated?: string;
|
|
43
|
+
source?: string;
|
|
44
|
+
groups?: SymbolGroupDoc[];
|
|
45
|
+
filePath: string;
|
|
46
|
+
line: number;
|
|
47
|
+
}
|
|
48
|
+
export interface ExtractorResult {
|
|
49
|
+
symbols: SymbolDoc[];
|
|
50
|
+
filePath: string;
|
|
51
|
+
}
|
|
52
|
+
export interface SymbolExtractor {
|
|
53
|
+
extractFile(filePath: string): ExtractorResult;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/extract/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;AAEhH,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,aAAa,GAAG,UAAU,GAAG,iBAAiB,CAAC;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAe;IAC/B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC/B,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,CAAC;CAC/C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/extract/types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { SymbolExtractor, ExtractorResult } from './types.js';
|
|
2
|
+
export declare class TypeScriptExtractor implements SymbolExtractor {
|
|
3
|
+
private program;
|
|
4
|
+
private checker;
|
|
5
|
+
private rootDir;
|
|
6
|
+
private sourceUrl?;
|
|
7
|
+
constructor(rootDir: string, sourceUrl?: string);
|
|
8
|
+
extractFile(filePath: string): ExtractorResult;
|
|
9
|
+
private extractExport;
|
|
10
|
+
private extractFunction;
|
|
11
|
+
private extractVariable;
|
|
12
|
+
private extractClass;
|
|
13
|
+
private extractClassMembers;
|
|
14
|
+
private extractInterface;
|
|
15
|
+
private extractInterfaceMembers;
|
|
16
|
+
private extractEnum;
|
|
17
|
+
private extractTypeAlias;
|
|
18
|
+
private extractMemberDoc;
|
|
19
|
+
private extractParameters;
|
|
20
|
+
private extractReturn;
|
|
21
|
+
private extractThrows;
|
|
22
|
+
private isPrivateOrProtected;
|
|
23
|
+
private hasModifier;
|
|
24
|
+
private buildSourceUrl;
|
|
25
|
+
}
|
|
26
|
+
/** Find all TypeScript source files in a directory */
|
|
27
|
+
export declare function findSourceFiles(dir: string): string[];
|
|
28
|
+
//# sourceMappingURL=typescript.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/extract/typescript.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEsB,eAAe,EAAE,eAAe,EACjE,MAAM,YAAY,CAAC;AAkFpB,qBAAa,mBAAoB,YAAW,eAAe;IAC1D,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAC,CAAS;gBAEf,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAoB/C,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe;IAmB9C,OAAO,CAAC,aAAa;IAuCrB,OAAO,CAAC,eAAe;IAyBvB,OAAO,CAAC,eAAe;IAiDvB,OAAO,CAAC,YAAY;IA0BpB,OAAO,CAAC,mBAAmB;IAuC3B,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,uBAAuB;IAuB/B,OAAO,CAAC,WAAW;IAyCnB,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,gBAAgB;IAkFxB,OAAO,CAAC,iBAAiB;IA8CzB,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,oBAAoB;IAK5B,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,cAAc;CAKtB;AAED,sDAAsD;AACtD,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAQrD"}
|