-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
277 lines (231 loc) · 10.1 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
import { readFile, writeFile, mkdir } from "fs/promises";
import { join, dirname } from "path";
import esquery from "esquery";
import { globby } from "globby";
import * as jsdocEslintParser from "@es-joy/jsdoc-eslint-parser/typescript.js";
import {
estreeToString, jsdocVisitorKeys, jsdocTypeVisitorKeys
} from "@es-joy/jsdoccomment";
import * as escodegen from "@es-joy/escodegen";
import { builders } from "ast-types";
/**
* @param {{includeFiles, ignoreFiles}} cfg
* @returns {Promise<string>}
*/
async function js2tsAssistant ({
includeFiles,
ignoreFiles,
customParamHandling,
customClassHandling,
targetDirectory = "tmp"
}) {
if (!includeFiles && !ignoreFiles) {
({
_preprocess_include: includeFiles = includeFiles,
_preprocess_exclude: ignoreFiles = ignoreFiles
} = JSON.parse(await readFile("tsconfig.json")));
}
const files = await globby(includeFiles, {
ignoreFiles
});
await Promise.all(files.map(async file => {
const contents = await readFile(file, "utf8");
const tree = jsdocEslintParser.parseForESLint(contents, {
mode: "typescript",
throwOnTypeParsingErrors: true
});
const { visitorKeys, ast } = tree;
const typedefSiblingsOfLocal = "JsdocTag[tag=local] ~ JsdocTag[tag=typedef]";
const typedefs = esquery.query(ast, typedefSiblingsOfLocal, {
visitorKeys
});
// Replace type shorthands with our typedef long form
typedefs.forEach(({ name, parsedType }) => {
const nameNodes = esquery.query(ast, `JsdocTypeName[value=${name}]`, {
visitorKeys
});
// Rather than go to the trouble of splicing from a child whose index
// we have to work to find, just copy the keys to the existing object
nameNodes.forEach(nameNode => {
Object.keys(nameNode).forEach(prop => {
if (prop === "parent") {
return;
}
delete nameNode[prop];
});
Object.entries(parsedType).forEach(([prop, val]) => {
if (prop === "parent") {
return;
}
nameNode[prop] = val;
});
});
});
// Remove local typedefs from AST
for (const typedef of typedefs) {
const { tags } = typedef.parent;
const idx = tags.indexOf(typedef);
tags.splice(idx, 1);
}
// Now remove the empty locals
const emptyLocals = esquery.query(ast, "JsdocBlock:has(JsdocTag:not([tag!=local]))", {
visitorKeys
});
for (const emptyLocal of emptyLocals) {
const idx = ast.jsdocBlocks.indexOf(emptyLocal);
ast.jsdocBlocks.splice(idx, 1);
}
const exportBlocks = esquery.query(ast, "JsdocBlock:has(JsdocTag[tag=export])", {
visitorKeys
});
/**
* Build a JSDoc type cast.
* @param {Object} extraInfo Extra type info
* @returns {JsdocBlock} The JsdocBlock object
*/
function typeCast(extraInfo) {
return {
type: "JsdocBlock",
initial: "",
delimiter: "/**",
postDelimiter: "",
terminal: "*/",
descriptionLines: [],
tags: [
{
type: "JsdocTag",
tag: "type",
postTag: " ",
descriptionLines: [],
...extraInfo,
postType: "",
initial: "",
delimiter: "",
postDelimiter: " "
}
]
};
}
for (const exportBlock of exportBlocks) {
switch (exportBlock.parent.type) {
case "ReturnStatement": {
const parent = exportBlock.parent.argument;
switch (parent.type) {
case "ClassExpression": {
const classBody = parent.body.body.map(({
type, kind, key, value, computed,
static: statik
}) => {
if (computed) {
return null;
}
const { jsdoc } = value.parent;
switch (type) {
case "MethodDefinition": {
const returns = jsdoc.tags.find(
tag => tag.tag === "returns"
);
const objectExpressionOrOther = !returns || returns.rawType === "void" ||
kind === "constructor"
? builders.identifier("undefined")
: builders.objectExpression([]);
if (kind !== "constructor") {
objectExpressionOrOther.jsdoc = typeCast({
parsedType: returns.parsedType
});
}
const paramNames = jsdoc.tags.filter(
tag => tag.tag === "param"
).map(
// eslint-disable-next-line arrow-body-style
tag => {
const identifier = builders.identifier(tag.name);
if (customParamHandling) {
customParamHandling({tag, identifier, typeCast});
}
return identifier;
}
);
const functionExpression = builders.functionExpression(
null,
paramNames,
builders.blockStatement([
kind === "constructor"
? builders.expressionStatement(
builders.callExpression(
builders.super(),
paramNames
)
)
: builders.returnStatement(
objectExpressionOrOther
)
])
);
const methodDefinition = builders.methodDefinition(
kind,
key,
functionExpression,
statik
);
methodDefinition.jsdoc = jsdoc;
return methodDefinition;
} default:
throw new Error(`Unknown ${type}`);
}
}).filter(Boolean);
let superClass = parent.superClass.name;
if (customClassHandling) {
const match = customClassHandling({
ast, builders, typeCast,
superClassName: parent.superClass.name
});
if (match) {
superClass = match;
}
}
const classDeclaration = builders.classDeclaration(
builders.identifier(parent.id.name),
builders.classBody(classBody),
builders.identifier(superClass)
);
ast.body.push(builders.exportNamedDeclaration(
classDeclaration
));
break;
} default:
throw new Error(`Unsupported type ${parent.type}`);
}
break;
} default:
throw new Error("Currently unsupported AST export structure");
}
}
const generated = escodegen.generate(ast, {
sourceContent: contents,
codegenFactory() {
const { CodeGenerator } = escodegen;
Object.keys(jsdocVisitorKeys).forEach(method => {
CodeGenerator.Statement[method] =
CodeGenerator.prototype[method] = node =>
// We have to add our own line break, as `jsdoccomment` (nor
// `comment-parser`) keep track of trailing content
((
node.endLine ? "\n" : ""
) + estreeToString(node) +
(node.endLine ? `\n${node.initial}` : " "));
});
Object.keys(jsdocTypeVisitorKeys).forEach(method => {
CodeGenerator.Statement[method] =
CodeGenerator.prototype[method] = node =>
estreeToString(node);
});
return new CodeGenerator();
}
});
const targetFile = join(targetDirectory, file);
await mkdir(dirname(targetFile), { recursive: true });
await writeFile(targetFile, generated);
}));
}
export default js2tsAssistant;