@cplieger/deadset-ts 8.0.0-dev.14 → 8.0.0-dev.16
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/src/alias-chain.js +2 -2
- package/dist/src/analysis.js +43 -38
- package/dist/src/commands/read.js +6 -7
- package/dist/src/conformance-record.js +1 -1
- package/dist/src/consumers.js +4 -2
- package/dist/src/contract/config.generated.js +1 -1
- package/dist/src/contract/contract.generated.js +120 -2
- package/dist/src/dependencies.js +81 -49
- package/dist/src/entries/build-scripts.js +222 -0
- package/dist/src/{configuration-files.js → entries/configuration-files.js} +20 -58
- package/dist/src/{convention-rows.js → entries/convention-rows.js} +120 -27
- package/dist/src/entries/conventions.js +739 -0
- package/dist/src/{html-entries.js → entries/html-entries.js} +3 -3
- package/dist/src/{mdx-entries.js → entries/mdx-entries.js} +2 -2
- package/dist/src/entries/run-directories.js +77 -0
- package/dist/src/entries/sources.js +144 -0
- package/dist/src/entries/static-module.js +669 -0
- package/dist/src/entries/test-runners.js +684 -0
- package/dist/src/{workflow-steps.js → entries/workflow-steps.js} +18 -8
- package/dist/src/extensions.js +37 -0
- package/dist/src/facts.js +38 -0
- package/dist/src/file-facts.js +1 -1
- package/dist/src/findings/emitters.js +5 -8
- package/dist/src/findings/self-check.js +36 -20
- package/dist/src/findings-pass.js +5 -6
- package/dist/src/framework-lifecycle.js +1 -1
- package/dist/src/fs/manifest.js +15 -20
- package/dist/src/generated-file.js +172 -29
- package/dist/src/graph.js +2 -5
- package/dist/src/index.js +1 -1
- package/dist/src/injection-container.js +1 -1
- package/dist/src/inventory/commonjs.js +507 -0
- package/dist/src/inventory/enumerate.js +167 -0
- package/dist/src/inventory/syntax.js +236 -0
- package/dist/src/inventory.js +305 -705
- package/dist/src/javascript-file.js +26 -11
- package/dist/src/load/classify.js +28 -9
- package/dist/src/load/diagnostics.js +8 -1
- package/dist/src/load/discover.js +16 -8
- package/dist/src/load/package-scope.js +56 -0
- package/dist/src/load/plan.js +2 -2
- package/dist/src/load/synthesize.js +5 -5
- package/dist/src/load/workspace-manifests.js +1 -1
- package/dist/src/matrix.js +6 -13
- package/dist/src/outside-tests.js +1 -1
- package/dist/src/paths.js +16 -0
- package/dist/src/platform-calls.js +78 -0
- package/dist/src/platform-symbols.js +140 -0
- package/dist/src/position.js +41 -0
- package/dist/src/ref.js +11 -20
- package/dist/src/references.js +281 -50
- package/dist/src/resolve.js +1 -1
- package/dist/src/{configured-declarations.js → roots/configured-declarations.js} +4 -4
- package/dist/src/{entry-point-gaps.js → roots/entry-point-gaps.js} +5 -8
- package/dist/src/{manifest.js → roots/manifest.js} +4 -4
- package/dist/src/roots/published-reach.js +412 -0
- package/dist/src/roots/root-set.js +489 -0
- package/dist/src/roots/unseen-loads.js +208 -0
- package/dist/src/serialization-contract.js +1 -1
- package/dist/src/session.js +3 -0
- package/dist/src/source-files.js +5 -9
- package/dist/src/suppress-inline.js +33 -81
- package/dist/src/suppress.js +30 -32
- package/dist/src/test-support.js +4 -2
- package/dist/src/verbs/analyze.js +13 -1
- package/dist/src/verbs/describe.js +5 -3
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/alias-chain.ts +2 -2
- package/src/analysis.ts +77 -53
- package/src/automatic-types.ts +1 -1
- package/src/commands/read.ts +6 -8
- package/src/conformance-record.ts +1 -1
- package/src/consumers.ts +5 -1
- package/src/contract/config.generated.ts +1 -1
- package/src/contract/contract.generated.ts +139 -2
- package/src/dependencies.ts +98 -50
- package/src/entries/build-scripts.ts +292 -0
- package/src/{configuration-files.ts → entries/configuration-files.ts} +23 -75
- package/src/{convention-rows.ts → entries/convention-rows.ts} +167 -28
- package/src/{conventions.ts → entries/conventions.ts} +347 -522
- package/src/{html-entries.ts → entries/html-entries.ts} +5 -5
- package/src/{mdx-entries.ts → entries/mdx-entries.ts} +4 -4
- package/src/entries/run-directories.ts +108 -0
- package/src/entries/sources.ts +266 -0
- package/src/entries/static-module.ts +857 -0
- package/src/entries/test-runners.ts +868 -0
- package/src/{workflow-steps.ts → entries/workflow-steps.ts} +29 -11
- package/src/exempt.ts +3 -2
- package/src/extensions.ts +45 -0
- package/src/facts.ts +44 -0
- package/src/file-facts.ts +2 -2
- package/src/findings/emitters.ts +14 -10
- package/src/findings/self-check.ts +41 -22
- package/src/findings/visibility-narrowing.ts +1 -1
- package/src/findings-pass.ts +5 -12
- package/src/framework-lifecycle.ts +1 -1
- package/src/fs/manifest.ts +25 -21
- package/src/generated-file.ts +240 -36
- package/src/graph.ts +3 -6
- package/src/index.ts +1 -1
- package/src/injection-container.ts +1 -1
- package/src/inventory/commonjs.ts +696 -0
- package/src/inventory/enumerate.ts +203 -0
- package/src/inventory/syntax.ts +311 -0
- package/src/inventory.ts +424 -878
- package/src/javascript-file.ts +29 -12
- package/src/load/classify.ts +49 -13
- package/src/load/diagnostics.ts +11 -1
- package/src/load/discover.ts +28 -12
- package/src/load/package-scope.ts +74 -0
- package/src/load/plan.ts +11 -2
- package/src/load/synthesize.ts +6 -6
- package/src/load/test-globals.ts +1 -1
- package/src/load/workspace-manifests.ts +1 -1
- package/src/load/workspace-run.ts +1 -1
- package/src/matrix.ts +7 -14
- package/src/outside-tests.ts +1 -1
- package/src/paths.ts +18 -0
- package/src/platform-calls.ts +119 -0
- package/src/platform-symbols.ts +205 -0
- package/src/position.ts +42 -0
- package/src/ref.ts +11 -20
- package/src/references.ts +383 -73
- package/src/report.ts +1 -1
- package/src/resolve.ts +1 -1
- package/src/{configured-declarations.ts → roots/configured-declarations.ts} +7 -7
- package/src/{entry-point-gaps.ts → roots/entry-point-gaps.ts} +5 -8
- package/src/{manifest.ts → roots/manifest.ts} +5 -5
- package/src/roots/published-reach.ts +481 -0
- package/src/{roots.ts → roots/root-set.ts} +203 -630
- package/src/roots/unseen-loads.ts +307 -0
- package/src/serialization-contract.ts +1 -1
- package/src/session.ts +17 -1
- package/src/source-files.ts +5 -10
- package/src/suppress-inline.ts +53 -89
- package/src/suppress.ts +48 -33
- package/src/test-support.ts +8 -3
- package/src/verbs/analyze.ts +17 -4
- package/src/verbs/describe.ts +5 -2
- package/src/verbs/explain.ts +1 -1
- package/dist/src/build-scripts.js +0 -418
- package/dist/src/conventions.js +0 -907
- package/dist/src/entry-points.js +0 -513
- package/dist/src/roots.js +0 -865
- package/dist/src/unseen-loads.js +0 -100
- package/src/build-scripts.ts +0 -536
- package/src/entry-points.ts +0 -661
- package/src/unseen-loads.ts +0 -134
|
@@ -0,0 +1,696 @@
|
|
|
1
|
+
import {
|
|
2
|
+
isArrayBindingPattern,
|
|
3
|
+
isArrowFunction,
|
|
4
|
+
isAssignmentOperator,
|
|
5
|
+
isAwaitExpression,
|
|
6
|
+
isBinaryExpression,
|
|
7
|
+
isBindingElement,
|
|
8
|
+
isCallExpression,
|
|
9
|
+
isClassDeclaration,
|
|
10
|
+
isClassExpression,
|
|
11
|
+
isClassStaticBlockDeclaration,
|
|
12
|
+
isComputedPropertyName,
|
|
13
|
+
isDeleteExpression,
|
|
14
|
+
isElementAccessExpression,
|
|
15
|
+
isEqualityOperator,
|
|
16
|
+
isExpressionStatement,
|
|
17
|
+
isForOfStatement,
|
|
18
|
+
isFunctionDeclaration,
|
|
19
|
+
isFunctionExpression,
|
|
20
|
+
isFunctionLikeDeclaration,
|
|
21
|
+
isGetAccessorDeclaration,
|
|
22
|
+
isIdentifier,
|
|
23
|
+
isIfStatement,
|
|
24
|
+
isMetaProperty,
|
|
25
|
+
isMethodDeclaration,
|
|
26
|
+
isNoSubstitutionTemplateLiteral,
|
|
27
|
+
isNumericLiteral,
|
|
28
|
+
isObjectBindingPattern,
|
|
29
|
+
isObjectLiteralExpression,
|
|
30
|
+
isPostfixUnaryExpression,
|
|
31
|
+
isPrefixUnaryExpression,
|
|
32
|
+
isPropertyAccessExpression,
|
|
33
|
+
isPropertyAssignment,
|
|
34
|
+
isSetAccessorDeclaration,
|
|
35
|
+
isShorthandPropertyAssignment,
|
|
36
|
+
isSourceFile,
|
|
37
|
+
isSpreadAssignment,
|
|
38
|
+
isStringLiteral,
|
|
39
|
+
isTypeOfExpression,
|
|
40
|
+
isVariableDeclaration,
|
|
41
|
+
isVariableDeclarationList,
|
|
42
|
+
isVariableStatement,
|
|
43
|
+
ModifierFlags,
|
|
44
|
+
NodeFlags,
|
|
45
|
+
SyntaxKind,
|
|
46
|
+
type BinaryExpression,
|
|
47
|
+
type ClassExpression,
|
|
48
|
+
type Identifier,
|
|
49
|
+
type Node,
|
|
50
|
+
type ObjectLiteralElementLike,
|
|
51
|
+
type PropertyAccessExpression,
|
|
52
|
+
type SourceFile,
|
|
53
|
+
} from "@typescript/native/ast";
|
|
54
|
+
import {
|
|
55
|
+
componentOf,
|
|
56
|
+
modifiersOf,
|
|
57
|
+
type Builder,
|
|
58
|
+
type Building,
|
|
59
|
+
type DeclarationSource,
|
|
60
|
+
type SymbolKind,
|
|
61
|
+
} from "../inventory.ts";
|
|
62
|
+
import { callsPlatformBy, lexicalBinding, writtenName, type BindingOf } from "../platform-calls.ts";
|
|
63
|
+
import type { Component } from "../ref.ts";
|
|
64
|
+
import { spellsNoBinding } from "../spelled-names.ts";
|
|
65
|
+
import { unwrapped } from "../unwrap.ts";
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* The export table of a CommonJS file: the module value `module.exports` is assigned and
|
|
69
|
+
* the properties written on it, read from the top-level unconditional statements in order,
|
|
70
|
+
* as Node runs them (https://nodejs.org/api/modules.html#moduleexports). Each entry is
|
|
71
|
+
* keyed by the node that writes it, the checker's declaration of the export where it binds
|
|
72
|
+
* one. Any other write of the exports opens the table: its entries are kept and the file is
|
|
73
|
+
* listed open. `declarationOf` reads a `require()` call through the file's own scopes.
|
|
74
|
+
*/
|
|
75
|
+
export function commonJS(
|
|
76
|
+
typeIsModule: (path: string) => boolean,
|
|
77
|
+
resolved: Resolved,
|
|
78
|
+
declarationOf: (occurrence: Identifier) => Node | undefined,
|
|
79
|
+
): DeclarationSource {
|
|
80
|
+
return {
|
|
81
|
+
declare(file: SourceFile, owner: Building, into: Builder): void {
|
|
82
|
+
if (!isCommonJS(file, owner.position.path, typeIsModule)) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
const bound = boundOccurrences(file, resolved);
|
|
86
|
+
const free = (node: Node): boolean => !bound.has(node);
|
|
87
|
+
const table = readTable(
|
|
88
|
+
file,
|
|
89
|
+
free,
|
|
90
|
+
topLevelDeclarations(file),
|
|
91
|
+
lexicalBinding(declarationOf),
|
|
92
|
+
);
|
|
93
|
+
const open = table.open || opens(file, free, table.modelled);
|
|
94
|
+
for (const entry of table.entries.values()) {
|
|
95
|
+
const record = into.declare(entry.node, owner, entry.kind, entry.name, {
|
|
96
|
+
component: entry.component,
|
|
97
|
+
localName: entry.localName,
|
|
98
|
+
});
|
|
99
|
+
record.exported = true;
|
|
100
|
+
const target = entry.target === undefined ? undefined : into.recordAt(entry.target);
|
|
101
|
+
if (target !== undefined) {
|
|
102
|
+
target.exported = true;
|
|
103
|
+
}
|
|
104
|
+
if (entry.members !== undefined) {
|
|
105
|
+
into.container({
|
|
106
|
+
owner: record,
|
|
107
|
+
declaration: entry.members,
|
|
108
|
+
nameNode: entry.members.name,
|
|
109
|
+
members: entry.members.members,
|
|
110
|
+
memberKind: "class-member",
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
// No reference source reads a `require` of the table yet, so whether an entry is
|
|
114
|
+
// used is unknown, and it is held live and reported by nothing.
|
|
115
|
+
into.unanswered(record);
|
|
116
|
+
}
|
|
117
|
+
if (open) {
|
|
118
|
+
into.openTable(owner);
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* The declarations the compiler resolves each occurrence to, in the order given, as nodes
|
|
126
|
+
* of the program; an occurrence it leaves unanswered has none.
|
|
127
|
+
*/
|
|
128
|
+
export type Resolved = (occurrences: readonly Identifier[]) => readonly (readonly Node[])[];
|
|
129
|
+
|
|
130
|
+
/** The bindings whose free occurrence is the module system's own. */
|
|
131
|
+
const WATCHED = ["module", "exports", "require"];
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Whether Node runs one file as CommonJS: a `.cjs` file, or a `.js` or `.jsx` file outside a
|
|
135
|
+
* `type: module` package that holds no ECMAScript module syntax
|
|
136
|
+
* (https://nodejs.org/api/packages.html#determining-module-system).
|
|
137
|
+
*/
|
|
138
|
+
function isCommonJS(
|
|
139
|
+
file: SourceFile,
|
|
140
|
+
path: string,
|
|
141
|
+
typeIsModule: (path: string) => boolean,
|
|
142
|
+
): boolean {
|
|
143
|
+
if (file.fileName.endsWith(".cjs")) {
|
|
144
|
+
return true;
|
|
145
|
+
}
|
|
146
|
+
return /\.jsx?$/u.test(file.fileName) && !typeIsModule(path) && !writesModuleSyntax(file);
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/** Whether one file holds an import or export declaration, `import.meta` or a top-level `await`. */
|
|
150
|
+
function writesModuleSyntax(file: SourceFile): boolean {
|
|
151
|
+
const declares = file.statements.some(
|
|
152
|
+
(statement) =>
|
|
153
|
+
(statement.flags & NodeFlags.Reparsed) === 0 &&
|
|
154
|
+
(statement.kind === SyntaxKind.ImportDeclaration ||
|
|
155
|
+
statement.kind === SyntaxKind.ExportDeclaration ||
|
|
156
|
+
statement.kind === SyntaxKind.ExportAssignment ||
|
|
157
|
+
(modifiersOf(statement) & ModifierFlags.Export) !== 0),
|
|
158
|
+
);
|
|
159
|
+
let found = declares;
|
|
160
|
+
const visit = (node: Node, inFunction: boolean): void => {
|
|
161
|
+
if (found) {
|
|
162
|
+
return;
|
|
163
|
+
}
|
|
164
|
+
if (
|
|
165
|
+
(isMetaProperty(node) && node.keywordToken === SyntaxKind.ImportKeyword) ||
|
|
166
|
+
(!inFunction &&
|
|
167
|
+
(isAwaitExpression(node) || (isForOfStatement(node) && node.awaitModifier !== undefined)))
|
|
168
|
+
) {
|
|
169
|
+
found = true;
|
|
170
|
+
return;
|
|
171
|
+
}
|
|
172
|
+
const inner = inFunction || isFunctionLikeDeclaration(node);
|
|
173
|
+
node.forEachChild((child) => {
|
|
174
|
+
visit(child, inner);
|
|
175
|
+
});
|
|
176
|
+
};
|
|
177
|
+
file.forEachChild((child) => {
|
|
178
|
+
visit(child, false);
|
|
179
|
+
});
|
|
180
|
+
return found;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* The occurrences of a watched name that Node binds to a declaration of the file. The
|
|
185
|
+
* compiler resolves each one, and one it leaves unanswered, or resolves to no such
|
|
186
|
+
* declaration, is the module system's own.
|
|
187
|
+
*/
|
|
188
|
+
function boundOccurrences(file: SourceFile, resolved: Resolved): ReadonlySet<Node> {
|
|
189
|
+
const occurrences: Identifier[] = [];
|
|
190
|
+
const visit = (node: Node): void => {
|
|
191
|
+
if (isIdentifier(node)) {
|
|
192
|
+
if (WATCHED.includes(node.text) && !spellsNoBinding(node)) {
|
|
193
|
+
occurrences.push(node);
|
|
194
|
+
}
|
|
195
|
+
return;
|
|
196
|
+
}
|
|
197
|
+
node.forEachChild(visit);
|
|
198
|
+
};
|
|
199
|
+
file.forEachChild(visit);
|
|
200
|
+
const declarations = resolved(occurrences);
|
|
201
|
+
const bound = new Set<Node>();
|
|
202
|
+
occurrences.forEach((occurrence, index) => {
|
|
203
|
+
if (declarations[index]?.some((declaration) => bindsOwn(declaration, file)) === true) {
|
|
204
|
+
bound.add(occurrence);
|
|
205
|
+
}
|
|
206
|
+
});
|
|
207
|
+
return bound;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Whether one declaration the compiler resolves a watched name to is a binding Node gives
|
|
212
|
+
* it in the file. Where the file is the var scope, a `var`, destructured or not, re-declares
|
|
213
|
+
* a parameter of Node's wrapper, which keeps the module system's value until assigned, and
|
|
214
|
+
* an `if`-clause function binds only in its clause, as the parameter stops it hoisting; the
|
|
215
|
+
* compiler gives each its own symbol, so both read as free (Annex B.3.2, B.3.3,
|
|
216
|
+
* https://tc39.es/ecma262/#sec-functiondeclarationinstantiation).
|
|
217
|
+
*/
|
|
218
|
+
function bindsOwn(declaration: Node, file: SourceFile): boolean {
|
|
219
|
+
if (isSourceFile(declaration) || declaration.getSourceFile() !== file) {
|
|
220
|
+
return false;
|
|
221
|
+
}
|
|
222
|
+
let named = declaration;
|
|
223
|
+
while (isBindingElement(named)) {
|
|
224
|
+
named = named.parent.parent;
|
|
225
|
+
}
|
|
226
|
+
const redeclares =
|
|
227
|
+
(isVariableDeclaration(named) &&
|
|
228
|
+
isVariableDeclarationList(named.parent) &&
|
|
229
|
+
(named.parent.flags & NodeFlags.BlockScoped) === 0) ||
|
|
230
|
+
(isFunctionDeclaration(declaration) && isIfStatement(declaration.parent));
|
|
231
|
+
return !redeclares || !inFileVarScope(declaration);
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
/** Whether no function or class static block encloses one node below its file. */
|
|
235
|
+
function inFileVarScope(node: Node): boolean {
|
|
236
|
+
for (let at = node.parent; !isSourceFile(at); at = at.parent) {
|
|
237
|
+
if (isFunctionLikeDeclaration(at) || isClassStaticBlockDeclaration(at)) {
|
|
238
|
+
return false;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
return true;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/** The node that declares each name a file's top-level function, class or variable binds. */
|
|
245
|
+
function topLevelDeclarations(file: SourceFile): ReadonlyMap<string, Node> {
|
|
246
|
+
const found = new Map<string, Node>();
|
|
247
|
+
const bind = (name: Node, node: Node): void => {
|
|
248
|
+
if (isIdentifier(name)) {
|
|
249
|
+
found.set(name.text, node);
|
|
250
|
+
} else if (isObjectBindingPattern(name) || isArrayBindingPattern(name)) {
|
|
251
|
+
for (const element of name.elements) {
|
|
252
|
+
if (isBindingElement(element) && element.name !== undefined) {
|
|
253
|
+
bind(element.name, element);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
};
|
|
258
|
+
for (const statement of file.statements) {
|
|
259
|
+
if ((isFunctionDeclaration(statement) || isClassDeclaration(statement)) && statement.name) {
|
|
260
|
+
found.set(statement.name.text, statement);
|
|
261
|
+
} else if (isVariableStatement(statement)) {
|
|
262
|
+
for (const declaration of statement.declarationList.declarations) {
|
|
263
|
+
bind(declaration.name, declaration);
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
return found;
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
/** One entry of the table: what writes it, where it is placed, and what it declares. */
|
|
271
|
+
interface Entry {
|
|
272
|
+
readonly node: Node;
|
|
273
|
+
readonly name: Node;
|
|
274
|
+
readonly component: Component;
|
|
275
|
+
readonly localName: string | undefined;
|
|
276
|
+
readonly kind: SymbolKind;
|
|
277
|
+
/** The value written under the key, undefined for an accessor. */
|
|
278
|
+
readonly value: Node | undefined;
|
|
279
|
+
/** The declaration of the file the module value names, which the export then exports. */
|
|
280
|
+
readonly target?: Node;
|
|
281
|
+
/** The class whose members the entry holds. */
|
|
282
|
+
readonly members?: ClassExpression;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
interface Table {
|
|
286
|
+
readonly entries: ReadonlyMap<string, Entry>;
|
|
287
|
+
/** Whether a write the scan read opens the table. */
|
|
288
|
+
readonly open: boolean;
|
|
289
|
+
/** Every write the scan read, which the opening walk then passes over. */
|
|
290
|
+
readonly modelled: ReadonlySet<Node>;
|
|
291
|
+
/** The value the last assignment of `module.exports` writes, undefined where none does. */
|
|
292
|
+
readonly whole: Node | undefined;
|
|
293
|
+
/** Whether a member write opens the table, apart from a module value the table cannot read. */
|
|
294
|
+
readonly membersOpen: boolean;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
const DEFAULT: Component = { text: "default", computed: false };
|
|
298
|
+
|
|
299
|
+
/** The table one file's top-level unconditional statements write, in order. */
|
|
300
|
+
function readTable(
|
|
301
|
+
file: SourceFile,
|
|
302
|
+
isFree: (node: Node) => boolean,
|
|
303
|
+
declarations: ReadonlyMap<string, Node>,
|
|
304
|
+
bindingOf: BindingOf,
|
|
305
|
+
): Table {
|
|
306
|
+
const entries = new Map<string, Entry>();
|
|
307
|
+
const modelled = new Set<Node>();
|
|
308
|
+
// Written inside the closures below, which the compiler's narrowing does not follow.
|
|
309
|
+
let open = false as boolean;
|
|
310
|
+
let aliasing = true;
|
|
311
|
+
let whole: Node | undefined;
|
|
312
|
+
let wholeOpen = false;
|
|
313
|
+
const free = (node: Node, name: string): boolean =>
|
|
314
|
+
isIdentifier(node) && node.text === name && isFree(node);
|
|
315
|
+
const isModuleExports = (node: Node): node is PropertyAccessExpression =>
|
|
316
|
+
isPropertyAccessExpression(node) &&
|
|
317
|
+
free(node.expression, "module") &&
|
|
318
|
+
node.name.text === "exports";
|
|
319
|
+
const isRequire = (node: Node): boolean => {
|
|
320
|
+
if (!isCallExpression(node) || node.arguments.length !== 1) {
|
|
321
|
+
return false;
|
|
322
|
+
}
|
|
323
|
+
const [argument] = node.arguments;
|
|
324
|
+
const callee = writtenName(node.expression);
|
|
325
|
+
return (
|
|
326
|
+
argument !== undefined &&
|
|
327
|
+
isLiteralText(argument) &&
|
|
328
|
+
callee !== undefined &&
|
|
329
|
+
callsPlatformBy("require", callee, bindingOf)
|
|
330
|
+
);
|
|
331
|
+
};
|
|
332
|
+
|
|
333
|
+
/** What a value written under one key declares. */
|
|
334
|
+
const entryOf = (
|
|
335
|
+
component: Component,
|
|
336
|
+
node: Node,
|
|
337
|
+
name: Node,
|
|
338
|
+
value: Node | undefined,
|
|
339
|
+
): Entry => {
|
|
340
|
+
const held = value === undefined ? undefined : unwrapped(value);
|
|
341
|
+
const base = { node, name, component, localName: undefined, value };
|
|
342
|
+
if (held === undefined) {
|
|
343
|
+
return { ...base, kind: "variable" };
|
|
344
|
+
}
|
|
345
|
+
if ((isIdentifier(held) && declarations.has(held.text)) || isRequire(held)) {
|
|
346
|
+
return { ...base, kind: "export-alias" };
|
|
347
|
+
}
|
|
348
|
+
if (isFunctionExpression(held) || isArrowFunction(held) || isMethodDeclaration(held)) {
|
|
349
|
+
return { ...base, kind: "function" };
|
|
350
|
+
}
|
|
351
|
+
if (isClassExpression(held)) {
|
|
352
|
+
return { ...base, kind: "class", members: held };
|
|
353
|
+
}
|
|
354
|
+
return { ...base, kind: "variable" };
|
|
355
|
+
};
|
|
356
|
+
|
|
357
|
+
const property = (node: Node, name: Node, value: Node | undefined): void => {
|
|
358
|
+
const component = isComputedPropertyName(name) ? undefined : componentOf(name);
|
|
359
|
+
if (component === undefined) {
|
|
360
|
+
open = true;
|
|
361
|
+
return;
|
|
362
|
+
}
|
|
363
|
+
if (component.text === "__esModule") {
|
|
364
|
+
return;
|
|
365
|
+
}
|
|
366
|
+
if (component.text === "default" && entries.get("default")?.component === DEFAULT) {
|
|
367
|
+
// `#default` would name the module value and this property both.
|
|
368
|
+
open = true;
|
|
369
|
+
return;
|
|
370
|
+
}
|
|
371
|
+
entries.delete(component.text);
|
|
372
|
+
entries.set(component.text, entryOf(component, node, name, value));
|
|
373
|
+
};
|
|
374
|
+
|
|
375
|
+
const literalProperty = (element: ObjectLiteralElementLike): void => {
|
|
376
|
+
if (isShorthandPropertyAssignment(element)) {
|
|
377
|
+
property(element, element.name, element.name);
|
|
378
|
+
} else if (isPropertyAssignment(element)) {
|
|
379
|
+
property(element, element.name, element.initializer);
|
|
380
|
+
} else if (isMethodDeclaration(element)) {
|
|
381
|
+
property(element, element.name, element);
|
|
382
|
+
} else if (isGetAccessorDeclaration(element) || isSetAccessorDeclaration(element)) {
|
|
383
|
+
property(element, element.name, undefined);
|
|
384
|
+
} else if (!isSpreadAssignment(element) || !isRequire(unwrapped(element.expression))) {
|
|
385
|
+
open = true;
|
|
386
|
+
}
|
|
387
|
+
};
|
|
388
|
+
|
|
389
|
+
/** The module value one assignment writes, placed at the `exports` name it assigns. */
|
|
390
|
+
const moduleValue = (node: BinaryExpression, name: Node): void => {
|
|
391
|
+
entries.clear();
|
|
392
|
+
whole = node.right;
|
|
393
|
+
const value = unwrapped(node.right);
|
|
394
|
+
if (isRequire(value)) {
|
|
395
|
+
return;
|
|
396
|
+
}
|
|
397
|
+
if (isObjectLiteralExpression(value)) {
|
|
398
|
+
value.properties.forEach(literalProperty);
|
|
399
|
+
return;
|
|
400
|
+
}
|
|
401
|
+
const base = { node, name, component: DEFAULT, value: node.right };
|
|
402
|
+
const target = isIdentifier(value) ? declarations.get(value.text) : undefined;
|
|
403
|
+
if (target !== undefined) {
|
|
404
|
+
entries.set("default", { ...base, localName: undefined, kind: "export-alias", target });
|
|
405
|
+
} else if (isFunctionExpression(value)) {
|
|
406
|
+
entries.set("default", { ...base, localName: value.name?.text, kind: "function" });
|
|
407
|
+
} else if (isArrowFunction(value)) {
|
|
408
|
+
entries.set("default", { ...base, localName: undefined, kind: "function" });
|
|
409
|
+
} else if (isClassExpression(value)) {
|
|
410
|
+
entries.set("default", {
|
|
411
|
+
...base,
|
|
412
|
+
localName: value.name?.text,
|
|
413
|
+
kind: "class",
|
|
414
|
+
members: value,
|
|
415
|
+
});
|
|
416
|
+
} else {
|
|
417
|
+
wholeOpen = true;
|
|
418
|
+
}
|
|
419
|
+
};
|
|
420
|
+
|
|
421
|
+
/** Whether one expression is the exports object a top-level write may name here. */
|
|
422
|
+
const exportsObject = (node: Node): "module" | "exports" | undefined =>
|
|
423
|
+
isModuleExports(node) ? "module" : free(node, "exports") ? "exports" : undefined;
|
|
424
|
+
|
|
425
|
+
for (const statement of file.statements) {
|
|
426
|
+
if (!isExpressionStatement(statement)) {
|
|
427
|
+
continue;
|
|
428
|
+
}
|
|
429
|
+
const expression = unwrapped(statement.expression);
|
|
430
|
+
if (
|
|
431
|
+
isBinaryExpression(expression) &&
|
|
432
|
+
expression.operatorToken.kind === SyntaxKind.EqualsToken
|
|
433
|
+
) {
|
|
434
|
+
const left = expression.left;
|
|
435
|
+
if (free(left, "exports")) {
|
|
436
|
+
modelled.add(expression);
|
|
437
|
+
const inner = unwrapped(expression.right);
|
|
438
|
+
aliasing = false;
|
|
439
|
+
if (
|
|
440
|
+
isBinaryExpression(inner) &&
|
|
441
|
+
inner.operatorToken.kind === SyntaxKind.EqualsToken &&
|
|
442
|
+
isModuleExports(inner.left)
|
|
443
|
+
) {
|
|
444
|
+
aliasing = true;
|
|
445
|
+
modelled.add(inner);
|
|
446
|
+
moduleValue(inner, inner.left.name);
|
|
447
|
+
}
|
|
448
|
+
} else if (isModuleExports(left)) {
|
|
449
|
+
modelled.add(expression);
|
|
450
|
+
const inner = unwrapped(expression.right);
|
|
451
|
+
const chained =
|
|
452
|
+
isBinaryExpression(inner) &&
|
|
453
|
+
inner.operatorToken.kind === SyntaxKind.EqualsToken &&
|
|
454
|
+
free(inner.left, "exports")
|
|
455
|
+
? inner
|
|
456
|
+
: undefined;
|
|
457
|
+
if (chained !== undefined) {
|
|
458
|
+
modelled.add(chained);
|
|
459
|
+
}
|
|
460
|
+
moduleValue(chained ?? expression, left.name);
|
|
461
|
+
aliasing = chained !== undefined;
|
|
462
|
+
} else if (isPropertyAccessExpression(left) || isElementAccessExpression(left)) {
|
|
463
|
+
const object = exportsObject(left.expression);
|
|
464
|
+
const key = isPropertyAccessExpression(left) ? left.name : left.argumentExpression;
|
|
465
|
+
if (object === "exports" && !aliasing) {
|
|
466
|
+
// Node discards a write through an `exports` that no longer aliases the module.
|
|
467
|
+
modelled.add(expression);
|
|
468
|
+
} else if (
|
|
469
|
+
object !== undefined &&
|
|
470
|
+
(isPropertyAccessExpression(left) || isLiteralKey(key))
|
|
471
|
+
) {
|
|
472
|
+
modelled.add(expression);
|
|
473
|
+
property(expression, key, expression.right);
|
|
474
|
+
}
|
|
475
|
+
}
|
|
476
|
+
continue;
|
|
477
|
+
}
|
|
478
|
+
if (isCallExpression(expression) && isDefineProperty(expression.expression)) {
|
|
479
|
+
const [object, key, descriptor] = expression.arguments;
|
|
480
|
+
const written = object === undefined ? undefined : exportsObject(object);
|
|
481
|
+
if (written === "exports" && !aliasing) {
|
|
482
|
+
modelled.add(expression);
|
|
483
|
+
continue;
|
|
484
|
+
}
|
|
485
|
+
const value = descriptor === undefined ? undefined : describedValue(descriptor);
|
|
486
|
+
if (written !== undefined && key !== undefined && isLiteralText(key) && value !== undefined) {
|
|
487
|
+
modelled.add(expression);
|
|
488
|
+
property(expression, key, value.value);
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
return { entries, open: open || wholeOpen, modelled, whole, membersOpen: open };
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
/** One member a CommonJS file's module value holds, as {@link commonJSModuleValue} reads it. */
|
|
496
|
+
interface WrittenMember {
|
|
497
|
+
readonly key: string;
|
|
498
|
+
/** The value written, undefined for an accessor. */
|
|
499
|
+
readonly value: Node | undefined;
|
|
500
|
+
/** The node that writes the member. */
|
|
501
|
+
readonly node: Node;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
/** The module value a CommonJS file leaves once Node has run its top level. */
|
|
505
|
+
export interface ModuleValue {
|
|
506
|
+
/** The value the last assignment of `module.exports` writes, where that is no object literal. */
|
|
507
|
+
readonly whole: Node | undefined;
|
|
508
|
+
/** The members written on the module value, an object literal assigned to `module.exports` among them. */
|
|
509
|
+
readonly members: readonly WrittenMember[];
|
|
510
|
+
/** Whether a write the table does not model may set any member. */
|
|
511
|
+
readonly open: boolean;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* The module value one file leaves where Node runs it as CommonJS, read by the one table
|
|
516
|
+
* the inventory's export table reads, or undefined where the file writes module syntax.
|
|
517
|
+
* `declarationOf` names the declaration each name resolves to, undefined for none, as a
|
|
518
|
+
* lexical reading of a file outside every program answers it.
|
|
519
|
+
*/
|
|
520
|
+
export function commonJSModuleValue(
|
|
521
|
+
file: SourceFile,
|
|
522
|
+
declarationOf: (occurrence: Identifier) => Node | undefined,
|
|
523
|
+
): ModuleValue | undefined {
|
|
524
|
+
if (writesModuleSyntax(file)) {
|
|
525
|
+
return undefined;
|
|
526
|
+
}
|
|
527
|
+
const free = (node: Node): boolean => {
|
|
528
|
+
const declaration = isIdentifier(node) ? declarationOf(node) : undefined;
|
|
529
|
+
return declaration === undefined || !bindsOwn(declaration, file);
|
|
530
|
+
};
|
|
531
|
+
const table = readTable(file, free, topLevelDeclarations(file), lexicalBinding(declarationOf));
|
|
532
|
+
const held = table.whole === undefined ? undefined : unwrapped(table.whole);
|
|
533
|
+
const members = [...table.entries.values()].flatMap((entry) =>
|
|
534
|
+
entry.component === DEFAULT && held !== undefined && !isObjectLiteralExpression(held)
|
|
535
|
+
? []
|
|
536
|
+
: [{ key: entry.component.text, value: entry.value, node: entry.node }],
|
|
537
|
+
);
|
|
538
|
+
return {
|
|
539
|
+
whole: held === undefined || isObjectLiteralExpression(held) ? undefined : table.whole,
|
|
540
|
+
members,
|
|
541
|
+
open: table.membersOpen || opens(file, free, table.modelled),
|
|
542
|
+
};
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/** Whether one node is `Object.defineProperty`. */
|
|
546
|
+
function isDefineProperty(node: Node): boolean {
|
|
547
|
+
return (
|
|
548
|
+
isPropertyAccessExpression(node) &&
|
|
549
|
+
isIdentifier(node.expression) &&
|
|
550
|
+
node.expression.text === "Object" &&
|
|
551
|
+
node.name.text === "defineProperty"
|
|
552
|
+
);
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
/** The value a property descriptor literal gives, where it writes a `value` or a `get`. */
|
|
556
|
+
function describedValue(descriptor: Node): { readonly value: Node | undefined } | undefined {
|
|
557
|
+
if (!isObjectLiteralExpression(descriptor)) {
|
|
558
|
+
return undefined;
|
|
559
|
+
}
|
|
560
|
+
let found: { readonly value: Node | undefined } | undefined;
|
|
561
|
+
for (const element of descriptor.properties) {
|
|
562
|
+
const key = isSpreadAssignment(element) ? undefined : componentOf(element.name)?.text;
|
|
563
|
+
if (key === "value") {
|
|
564
|
+
return {
|
|
565
|
+
value: isPropertyAssignment(element)
|
|
566
|
+
? element.initializer
|
|
567
|
+
: isMethodDeclaration(element)
|
|
568
|
+
? element
|
|
569
|
+
: undefined,
|
|
570
|
+
};
|
|
571
|
+
}
|
|
572
|
+
if (key === "get") {
|
|
573
|
+
found = { value: undefined };
|
|
574
|
+
}
|
|
575
|
+
}
|
|
576
|
+
return found;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
/** Whether one node is literal text: a string, or a template with no substitution. */
|
|
580
|
+
function isLiteralText(node: Node): boolean {
|
|
581
|
+
return isStringLiteral(node) || isNoSubstitutionTemplateLiteral(node);
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
/** Whether one element access key is literal: text or a number. */
|
|
585
|
+
function isLiteralKey(node: Node): boolean {
|
|
586
|
+
return isLiteralText(node) || isNumericLiteral(node);
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* Whether one file writes its exports anywhere the table does not model: through `module`,
|
|
591
|
+
* `module.exports` or the free `exports` written, assigned, passed or stored outside the
|
|
592
|
+
* statements the scan read, or through a top-level `this`.
|
|
593
|
+
*/
|
|
594
|
+
function opens(
|
|
595
|
+
file: SourceFile,
|
|
596
|
+
isFree: (node: Node) => boolean,
|
|
597
|
+
modelled: ReadonlySet<Node>,
|
|
598
|
+
): boolean {
|
|
599
|
+
let open = false;
|
|
600
|
+
const visit = (node: Node, thisIsExports: boolean): void => {
|
|
601
|
+
if (open) {
|
|
602
|
+
return;
|
|
603
|
+
}
|
|
604
|
+
if (isIdentifier(node)) {
|
|
605
|
+
open = opensAt(node, isFree, modelled);
|
|
606
|
+
return;
|
|
607
|
+
}
|
|
608
|
+
if (node.kind === SyntaxKind.ThisKeyword) {
|
|
609
|
+
open = thisIsExports && writes(node, modelled);
|
|
610
|
+
return;
|
|
611
|
+
}
|
|
612
|
+
const fn = isFunctionLikeDeclaration(node);
|
|
613
|
+
const innerThis =
|
|
614
|
+
thisIsExports &&
|
|
615
|
+
!(fn && !isArrowFunction(node)) &&
|
|
616
|
+
!isClassDeclaration(node) &&
|
|
617
|
+
!isClassExpression(node);
|
|
618
|
+
node.forEachChild((child) => {
|
|
619
|
+
visit(child, innerThis);
|
|
620
|
+
});
|
|
621
|
+
};
|
|
622
|
+
file.forEachChild((child) => {
|
|
623
|
+
visit(child, true);
|
|
624
|
+
});
|
|
625
|
+
return open;
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
/** Whether one free occurrence of `module` or `exports` opens the table. */
|
|
629
|
+
function opensAt(
|
|
630
|
+
node: Identifier,
|
|
631
|
+
isFree: (node: Node) => boolean,
|
|
632
|
+
modelled: ReadonlySet<Node>,
|
|
633
|
+
): boolean {
|
|
634
|
+
const name = node.text;
|
|
635
|
+
if ((name !== "module" && name !== "exports") || !isFree(node) || spellsNoBinding(node)) {
|
|
636
|
+
return false;
|
|
637
|
+
}
|
|
638
|
+
if (name === "exports") {
|
|
639
|
+
return writes(node, modelled);
|
|
640
|
+
}
|
|
641
|
+
const parent = node.parent;
|
|
642
|
+
if (isPropertyAccessExpression(parent) && parent.expression === node) {
|
|
643
|
+
return parent.name.text === "exports" && writes(parent, modelled);
|
|
644
|
+
}
|
|
645
|
+
if (isElementAccessExpression(parent) && parent.expression === node) {
|
|
646
|
+
return writes(parent, modelled);
|
|
647
|
+
}
|
|
648
|
+
return !readOnly(node);
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
/**
|
|
652
|
+
* Whether the exports object one expression names is written, or escapes where it may be
|
|
653
|
+
* written, other than by a write the scan read: assigned, a property of it assigned,
|
|
654
|
+
* incremented or deleted, or the value handed anywhere but a `typeof` or a comparison.
|
|
655
|
+
*/
|
|
656
|
+
function writes(object: Node, modelled: ReadonlySet<Node>): boolean {
|
|
657
|
+
const parent = object.parent;
|
|
658
|
+
if (assigns(parent, object)) {
|
|
659
|
+
return !modelled.has(parent);
|
|
660
|
+
}
|
|
661
|
+
if (
|
|
662
|
+
(isPropertyAccessExpression(parent) || isElementAccessExpression(parent)) &&
|
|
663
|
+
parent.expression === object
|
|
664
|
+
) {
|
|
665
|
+
const holder = parent.parent;
|
|
666
|
+
const written =
|
|
667
|
+
assigns(holder, parent) ||
|
|
668
|
+
isDeleteExpression(holder) ||
|
|
669
|
+
((isPrefixUnaryExpression(holder) || isPostfixUnaryExpression(holder)) &&
|
|
670
|
+
(holder.operator === SyntaxKind.PlusPlusToken ||
|
|
671
|
+
holder.operator === SyntaxKind.MinusMinusToken));
|
|
672
|
+
return written && !modelled.has(holder);
|
|
673
|
+
}
|
|
674
|
+
if (isCallExpression(parent) && modelled.has(parent)) {
|
|
675
|
+
return false;
|
|
676
|
+
}
|
|
677
|
+
return !readOnly(object);
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
/** Whether `holder` assigns to `target`, by any assignment operator. */
|
|
681
|
+
function assigns(holder: Node, target: Node): holder is BinaryExpression {
|
|
682
|
+
return (
|
|
683
|
+
isBinaryExpression(holder) &&
|
|
684
|
+
holder.left === target &&
|
|
685
|
+
isAssignmentOperator(holder.operatorToken.kind)
|
|
686
|
+
);
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
/** Whether one value is only read: the operand of a `typeof` or of an equality comparison. */
|
|
690
|
+
function readOnly(node: Node): boolean {
|
|
691
|
+
const parent = node.parent;
|
|
692
|
+
return (
|
|
693
|
+
isTypeOfExpression(parent) ||
|
|
694
|
+
(isBinaryExpression(parent) && isEqualityOperator(parent.operatorToken.kind))
|
|
695
|
+
);
|
|
696
|
+
}
|