-
Notifications
You must be signed in to change notification settings - Fork 24
/
tsReader.ts
436 lines (365 loc) · 15.2 KB
/
tsReader.ts
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
import {
Project,
Node,
SyntaxKind,
MethodDeclaration,
SourceFile,
VariableDeclaration,
ExportAssignment,
ObjectLiteralExpression
} from "ts-morph";
import glob from "glob";
import path from "path";
import * as fs from "fs";
import stripJsonComments from "strip-json-comments";
import { TsReaderModelTypes } from "../types";
function getNameAndType(funcDeclaration: MethodDeclaration) {
const name = funcDeclaration.getName();
const typeNode = funcDeclaration.getType();
const type = typeNode.getText(funcDeclaration);
return { name, type };
}
function findCommentsInFile(
sourceFile: SourceFile,
modelTypes: TsReaderModelTypes,
maxCommentDepth: number
) {
// TODO: this is reused from findTypesInFile, should abstract out instead
const schemaModelMapping: {
[schemaVariableName: string]: string;
} = {};
Object.keys(modelTypes).forEach((modelName: string) => {
const { schemaVariableName } = modelTypes[modelName];
if (schemaVariableName) schemaModelMapping[schemaVariableName] = modelName;
});
for (const statement of sourceFile.getStatements()) {
if (!Node.isVariableStatement(statement)) continue;
const varDeclarationList = statement.getChildAtIndexIfKind(
0,
SyntaxKind.VariableDeclarationList
);
if (!varDeclarationList) continue;
const varDeclaration = varDeclarationList.getFirstChildByKind(SyntaxKind.VariableDeclaration);
if (!varDeclaration) continue;
const schemaName = varDeclaration.getFirstChildByKind(SyntaxKind.Identifier)?.getText();
if (!schemaName) continue;
const modelName = schemaModelMapping[schemaName];
if (!modelName) {
continue;
}
const newExpression = varDeclaration.getFirstChildByKind(SyntaxKind.NewExpression);
if (!newExpression) continue;
const objLiteralExp = newExpression.getFirstChildByKind(SyntaxKind.ObjectLiteralExpression);
if (!objLiteralExp) continue;
const extractComments = (objLiteralExp: ObjectLiteralExpression, rootPath: string) => {
const propAssignments = objLiteralExp.getChildrenOfKind(SyntaxKind.PropertyAssignment);
propAssignments.forEach((propAssignment) => {
const propName = propAssignment.getFirstChildByKind(SyntaxKind.Identifier)?.getText();
if (!propName) return;
const path = rootPath ? `${rootPath}.${propName}` : propName;
propAssignment.getLeadingCommentRanges().forEach((commentRange) => {
const commentText = commentRange.getText();
// skip comments that are not jsdocs
if (!commentText.startsWith("/**")) return;
modelTypes[modelName].comments.push({
path,
comment: commentText
});
});
if (rootPath.split(".").length < maxCommentDepth) {
const nestedObjLiteralExp = propAssignment.getFirstChildByKind(
SyntaxKind.ObjectLiteralExpression
);
if (nestedObjLiteralExp) {
extractComments(nestedObjLiteralExp, path);
}
}
});
};
extractComments(objLiteralExp, "");
}
// TODO: get virtual comments
return modelTypes;
}
function findTypesInFile(sourceFile: SourceFile, modelTypes: TsReaderModelTypes) {
const schemaModelMapping: {
[schemaVariableName: string]: string;
} = {};
Object.keys(modelTypes).forEach((modelName: string) => {
const { schemaVariableName } = modelTypes[modelName];
if (schemaVariableName) schemaModelMapping[schemaVariableName] = modelName;
});
for (const statement of sourceFile.getStatements()) {
if (!Node.isExpressionStatement(statement)) continue;
const binaryExpr = statement.getChildAtIndexIfKind(0, SyntaxKind.BinaryExpression);
const callExpr = statement.getChildAtIndexIfKind(0, SyntaxKind.CallExpression);
if (binaryExpr) {
// left is a propertyaccessexpression, children are [identifier, dottoken, identifier]
const left = binaryExpr.getLeft();
const right = binaryExpr.getRight();
if (left.getKind() !== SyntaxKind.PropertyAccessExpression) continue;
if (
right.getKind() !== SyntaxKind.AsExpression &&
right.getKind() !== SyntaxKind.ObjectLiteralExpression &&
right.getKind() !== SyntaxKind.TypeAssertionExpression
)
continue;
const leftChildren = left.getChildren();
let modelName: string;
const hasSchemaIdentifier = leftChildren.some((child) => {
if (child.getKind() !== SyntaxKind.Identifier) return false;
modelName = schemaModelMapping[child.getText()];
if (!modelName) return false;
return true;
});
const hasDotToken = leftChildren.some((child) => child.getKind() === SyntaxKind.DotToken);
if (!hasSchemaIdentifier || !hasDotToken) continue;
const hasMethodsIdentifier = leftChildren.some(
(child) => child.getKind() === SyntaxKind.Identifier && child.getText() === "methods"
);
const hasStaticsIdentifier = leftChildren.some(
(child) => child.getKind() === SyntaxKind.Identifier && child.getText() === "statics"
);
const hasQueryIdentifier = leftChildren.some(
(child) => child.getKind() === SyntaxKind.Identifier && child.getText() === "query"
);
let rightFuncDeclarations: any[] = [];
if (right.getKind() === SyntaxKind.ObjectLiteralExpression) {
rightFuncDeclarations = right.getChildrenOfKind(SyntaxKind.MethodDeclaration);
} else if (right.getKind() === SyntaxKind.AsExpression) {
const objLiteralExp = right.getFirstChildByKind(SyntaxKind.ObjectLiteralExpression);
if (objLiteralExp)
rightFuncDeclarations = objLiteralExp.getChildrenOfKind(SyntaxKind.MethodDeclaration);
} else if (right.getKind() === SyntaxKind.TypeAssertionExpression) {
const objLiteralExp = right.getFirstChildByKind(SyntaxKind.ObjectLiteralExpression);
if (objLiteralExp) {
rightFuncDeclarations = objLiteralExp.getChildrenOfKind(SyntaxKind.MethodDeclaration);
}
} else {
rightFuncDeclarations = right.getChildrenOfKind(SyntaxKind.MethodDeclaration);
}
if (hasMethodsIdentifier) {
rightFuncDeclarations.forEach((declaration: MethodDeclaration) => {
const { name, type } = getNameAndType(declaration);
modelTypes[modelName].methods[name] = type;
});
} else if (hasStaticsIdentifier) {
rightFuncDeclarations.forEach((declaration: MethodDeclaration) => {
const { name, type } = getNameAndType(declaration);
modelTypes[modelName].statics[name] = type;
});
} else if (hasQueryIdentifier) {
rightFuncDeclarations.forEach((declaration: MethodDeclaration) => {
const { name, type } = getNameAndType(declaration);
modelTypes[modelName].query[name] = type;
});
}
} else if (callExpr) {
// virtual property
let propAccessExpr = callExpr.getFirstChildByKind(SyntaxKind.PropertyAccessExpression);
if (propAccessExpr?.getName() === "set") {
propAccessExpr = propAccessExpr
.getFirstChildByKind(SyntaxKind.CallExpression)
?.getFirstChildByKind(SyntaxKind.PropertyAccessExpression);
}
if (propAccessExpr?.getName() !== "get") continue;
const schemaVariableName = propAccessExpr
.getFirstChildByKind(SyntaxKind.CallExpression)
?.getFirstChildByKind(SyntaxKind.PropertyAccessExpression)
?.getFirstChildByKind(SyntaxKind.Identifier)
?.getText();
if (schemaVariableName) {
if (process.env.DEBUG)
console.log("tsreader: Found virtual on schema: " + schemaVariableName);
} else continue;
const modelName = schemaModelMapping[schemaVariableName];
if (!modelName) {
if (process.env.DEBUG)
console.warn(
"tsreader: Associated model name not found for schema: " + schemaVariableName
);
continue;
}
const funcExpr = propAccessExpr
?.getParent()
?.getFirstChildByKind(SyntaxKind.FunctionExpression);
const type = funcExpr?.getType()?.getText(funcExpr);
const callExpr2 = propAccessExpr.getFirstChildByKind(SyntaxKind.CallExpression);
const stringLiteral = callExpr2?.getArguments()[0];
const propAccessExpr2 = callExpr2?.getFirstChildByKind(SyntaxKind.PropertyAccessExpression);
if (propAccessExpr2?.getName() !== "virtual") continue;
const virtualName = stringLiteral?.getText();
let returnType = type?.split("=> ")?.[1];
if (!returnType || !virtualName) {
if (process.env.DEBUG)
console.warn("tsreader: virtualName or returnType not found: ", {
virtualName,
returnType
});
continue;
}
/**
* @experimental trying this out since certain virtual types are indeterminable and get set to void, which creates incorrect TS errors
* This should be a fine workaround because virtual properties shouldn't return solely `void`, they return real values.
*/
if (returnType === "void") returnType = "any";
const virtualNameSanitized = virtualName.slice(1, virtualName.length - 1);
modelTypes[modelName].virtuals[virtualNameSanitized] = returnType;
}
}
return modelTypes;
}
const parseModelInitializer = (
d: VariableDeclaration | ExportAssignment,
isModelNamedImport: boolean
) => {
const callExpr = d.getFirstChildByKind(SyntaxKind.CallExpression);
if (!callExpr) return undefined;
const callExprStr = callExpr.getText().replace(/[\r\n\t ]/g, "");
// if model is a named import, we can match this without `mongoose.` prefix
const pattern = isModelNamedImport
? /model(?:<.+?>)?\(["'`](\w+)["'`],(\w+),?\)/
: /mongoose\.model(?:<.+?>)?\(["'`](\w+)["'`],(\w+),?\)/;
const modelInitMatch = callExprStr.match(pattern);
if (!modelInitMatch) {
if (process.env.DEBUG) {
console.warn(
`tsreader: Could not find model name in Mongoose model initialization: ${callExprStr}`
);
}
return undefined;
}
const [, modelName, schemaVariableName] = modelInitMatch;
return { modelName, schemaVariableName };
};
function initModelTypes(sourceFile: SourceFile, filePath: string) {
if (process.env.DEBUG) console.log("tsreader: Searching file for Mongoose schemas: " + filePath);
const modelTypes: TsReaderModelTypes = {};
const mongooseImport = sourceFile.getImportDeclaration("mongoose");
let isModelNamedImport = false;
mongooseImport?.getNamedImports().forEach((importSpecifier) => {
if (importSpecifier.getText() === "model") isModelNamedImport = true;
});
sourceFile.getVariableDeclarations().forEach((d) => {
const { modelName, schemaVariableName } = parseModelInitializer(d, isModelNamedImport) ?? {};
if (!modelName || !schemaVariableName) return;
const modelVariableName = d.getName();
modelTypes[modelName] = {
schemaVariableName,
modelVariableName,
filePath,
methods: {},
statics: {},
query: {},
virtuals: {},
comments: []
};
});
const defaultExportAssignment = sourceFile.getExportAssignment((d) => !d.isExportEquals());
if (defaultExportAssignment) {
const defaultModelInit = parseModelInitializer(defaultExportAssignment, isModelNamedImport);
if (defaultModelInit) {
modelTypes[defaultModelInit.modelName] = {
schemaVariableName: defaultModelInit.schemaVariableName,
filePath,
methods: {},
statics: {},
query: {},
virtuals: {},
comments: []
};
}
}
if (process.env.DEBUG) {
const schemaNames = Object.keys(modelTypes);
if (schemaNames.length === 0)
console.warn(
`tsreader: No schema found in file. If a schema exists & is exported, it will still be typed but will use generic types for methods, statics, queries & virtuals`
);
else console.log("tsreader: Schemas found: " + schemaNames);
}
return modelTypes;
}
export const getModelTypes = (modelsPaths: string[], maxCommentDepth = 2): TsReaderModelTypes => {
const project = new Project({});
project.addSourceFilesAtPaths(modelsPaths);
let allModelTypes: TsReaderModelTypes = {};
// TODO: ideally we only parse the files that we know have methods, statics, or virtuals.
// Would save a lot of time
modelsPaths.forEach((modelPath) => {
const sourceFile = project.getSourceFileOrThrow(modelPath);
let modelTypes = initModelTypes(sourceFile, modelPath);
modelTypes = findTypesInFile(sourceFile, modelTypes);
modelTypes = findCommentsInFile(sourceFile, modelTypes, maxCommentDepth);
allModelTypes = {
...allModelTypes,
...modelTypes
};
});
return allModelTypes;
};
export const registerUserTs = (basePath: string): (() => void) | null => {
const pathToSearch = basePath.endsWith(".json")
? basePath
: path.join(basePath, "**/tsconfig.json");
const files = glob.sync(pathToSearch, { ignore: "**/node_modules/**" });
if (files.length === 0) throw new Error(`No tsconfig.json file found at path "${basePath}"`);
else if (files.length > 1)
throw new Error(
`Multiple tsconfig.json files found. Please specify a more specific --project value.\nPaths found: ${files}`
);
const foundPath = path.join(process.cwd(), files[0]);
if (process.env.DEBUG) {
console.log("tsreader: Registering tsconfig.json with ts-node at path: " + foundPath);
}
require("ts-node").register({
transpileOnly: true,
project: foundPath,
compilerOptions: {
module: "commonjs"
}
});
// handle path aliases
try {
const tsConfig = parseTSConfig(foundPath);
if (tsConfig?.compilerOptions?.paths) {
const baseUrl = process.cwd();
if (process.env.DEBUG) {
console.log(
"tsreader: Found paths field in tsconfig.json, registering project with tsconfig-paths using baseUrl " +
baseUrl
);
}
const cleanup = require("tsconfig-paths").register({
baseUrl,
paths: tsConfig.compilerOptions.paths
});
return cleanup;
}
return null;
} catch (err) {
throw new Error(`Error parsing your tsconfig.json file: ${(err as Error).message}`);
}
};
export function parseTSConfig(tsconfigFilePath: string) {
const tsConfigString = fs.readFileSync(tsconfigFilePath, "utf8");
const tsConfig = JSON.parse(stripJsonComments(tsConfigString));
// Handle the case where the tsconfig.json file has a "extends" property
if (tsConfig.extends) {
// Resolve the path to the extended tsconfig.json file
const extendedPath = path.resolve(path.dirname(tsconfigFilePath), tsConfig.extends);
// Read and merge paths from the extended tsconfig.json recursively
const extendedConfig = parseTSConfig(extendedPath);
// Merge paths from extendedConfig into tsConfig
tsConfig.compilerOptions.paths = {
...extendedConfig.compilerOptions.paths,
...tsConfig.compilerOptions.paths
};
// We only want to set the base URL if its not already set, since the child tsconfig should always overwrite extended tsconfigs.
// So the first child we find with a base URL be the final base URL
if (extendedConfig.compilerOptions.baseUrl && !tsConfig.compilerOptions.baseUrl) {
tsConfig.compilerOptions.baseUrl = extendedConfig.compilerOptions.baseUrl
}
}
return tsConfig;
}