-
Notifications
You must be signed in to change notification settings - Fork 464
Expand file tree
/
Copy pathcreateTypesPackages.js
More file actions
296 lines (267 loc) · 13.5 KB
/
createTypesPackages.js
File metadata and controls
296 lines (267 loc) · 13.5 KB
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
// @ts-check
// node deploy/createTypesPackages.js
/**
* @template T
* @typedef {T extends (infer U)[] ? U : T} ArrayInner
*/
/**
* @typedef {ArrayInner<typeof packages>} Package
*/
// prettier-ignore
export const packages = [
{
name: "@types/web",
description: "Types for the DOM, and other web technologies in browsers",
readme: "./readmes/web.md",
files: [
{ from: "../generated/dom.generated.d.ts", to: "index.d.ts", index: true },
{ from: "../generated/dom.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
{ from: "../generated/dom.asynciterable.generated.d.ts", to: "asynciterable.d.ts", autoImport: true },
{ from: "../generated/ts5.5/dom.generated.d.ts", to: "ts5.5/index.d.ts", index: true, group: "ts5.5" },
{ from: "../generated/ts5.5/dom.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.5/dom.asynciterable.generated.d.ts", to: "ts5.5/asynciterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.6/dom.generated.d.ts", to: "ts5.6/index.d.ts", index: true, group: "ts5.6" },
{ from: "../generated/ts5.6/dom.iterable.generated.d.ts", to: "ts5.6/iterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.6/dom.asynciterable.generated.d.ts", to: "ts5.6/asynciterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.9/dom.generated.d.ts", to: "ts5.9/index.d.ts", index: true, group: "ts5.9" },
{ from: "../generated/ts5.9/dom.iterable.generated.d.ts", to: "ts5.9/iterable.d.ts", autoImport: true, group: "ts5.9" },
{ from: "../generated/ts5.9/dom.asynciterable.generated.d.ts", to: "ts5.9/asynciterable.d.ts", autoImport: true, group: "ts5.9" }
],
},
{
name: "@types/serviceworker",
description: "Types for the global scope of Service Workers",
readme: "./readmes/serviceworker.md",
files: [
{ from: "../generated/serviceworker.generated.d.ts", to: "index.d.ts", index: true },
{ from: "../generated/serviceworker.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
{ from: "../generated/serviceworker.asynciterable.generated.d.ts", to: "asynciterable.d.ts", autoImport: true },
{ from: "../generated/ts5.5/serviceworker.generated.d.ts", to: "ts5.5/index.d.ts", index: true, group: "ts5.5" },
{ from: "../generated/ts5.5/serviceworker.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true , group: "ts5.5" },
{ from: "../generated/ts5.5/serviceworker.asynciterable.generated.d.ts", to: "ts5.5/asynciterable.d.ts", autoImport: true , group: "ts5.5" },
{ from: "../generated/ts5.6/serviceworker.generated.d.ts", to: "ts5.6/index.d.ts", index: true, group: "ts5.6" },
{ from: "../generated/ts5.6/serviceworker.iterable.generated.d.ts", to: "ts5.6/iterable.d.ts", autoImport: true , group: "ts5.6" },
{ from: "../generated/ts5.6/serviceworker.asynciterable.generated.d.ts", to: "ts5.6/asynciterable.d.ts", autoImport: true , group: "ts5.6" },
{ from: "../generated/ts5.9/serviceworker.generated.d.ts", to: "ts5.9/index.d.ts", index: true, group: "ts5.9" },
{ from: "../generated/ts5.9/serviceworker.iterable.generated.d.ts", to: "ts5.9/iterable.d.ts", autoImport: true , group: "ts5.9" },
{ from: "../generated/ts5.9/serviceworker.asynciterable.generated.d.ts", to: "ts5.9/asynciterable.d.ts", autoImport: true , group: "ts5.9" }
],
},
{
name: "@types/audioworklet",
description: "Types for the global scope of Audio Worklets",
readme: "./readmes/audioworklet.md",
files: [
{ from: "../generated/audioworklet.generated.d.ts", to: "index.d.ts", index: true },
{ from: "../generated/audioworklet.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
{ from: "../generated/audioworklet.asynciterable.generated.d.ts", to: "asynciterable.d.ts", autoImport: true },
{ from: "../generated/ts5.5/audioworklet.generated.d.ts", to: "ts5.5/index.d.ts", index: true, group: "ts5.5" },
{ from: "../generated/ts5.5/audioworklet.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true , group: "ts5.5" },
{ from: "../generated/ts5.5/audioworklet.asynciterable.generated.d.ts", to: "ts5.5/asynciterable.d.ts", autoImport: true , group: "ts5.5" },
{ from: "../generated/ts5.6/audioworklet.generated.d.ts", to: "ts5.6/index.d.ts", index: true, group: "ts5.6" },
{ from: "../generated/ts5.6/audioworklet.iterable.generated.d.ts", to: "ts5.6/iterable.d.ts", autoImport: true , group: "ts5.6" },
{ from: "../generated/ts5.6/audioworklet.asynciterable.generated.d.ts", to: "ts5.6/asynciterable.d.ts", autoImport: true , group: "ts5.6" },
{ from: "../generated/ts5.9/audioworklet.generated.d.ts", to: "ts5.9/index.d.ts", index: true, group: "ts5.9" },
{ from: "../generated/ts5.9/audioworklet.iterable.generated.d.ts", to: "ts5.9/iterable.d.ts", autoImport: true , group: "ts5.9" },
{ from: "../generated/ts5.9/audioworklet.asynciterable.generated.d.ts", to: "ts5.9/asynciterable.d.ts", autoImport: true , group: "ts5.9" }
],
},
{
name: "@types/sharedworker",
description: "Types for the global scope of Shared Workers",
readme: "./readmes/sharedworker.md",
files: [
{ from: "../generated/sharedworker.generated.d.ts", to: "index.d.ts", index: true },
{ from: "../generated/sharedworker.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
{ from: "../generated/sharedworker.asynciterable.generated.d.ts", to: "asynciterable.d.ts", autoImport: true },
{ from: "../generated/ts5.5/sharedworker.generated.d.ts", to: "ts5.5/index.d.ts", index: true, group: "ts5.5" },
{ from: "../generated/ts5.5/sharedworker.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.5/sharedworker.asynciterable.generated.d.ts", to: "ts5.5/asynciterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.6/sharedworker.generated.d.ts", to: "ts5.6/index.d.ts", index: true, group: "ts5.6" },
{ from: "../generated/ts5.6/sharedworker.iterable.generated.d.ts", to: "ts5.6/iterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.6/sharedworker.asynciterable.generated.d.ts", to: "ts5.6/asynciterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.9/sharedworker.generated.d.ts", to: "ts5.9/index.d.ts", index: true, group: "ts5.9" },
{ from: "../generated/ts5.9/sharedworker.iterable.generated.d.ts", to: "ts5.9/iterable.d.ts", autoImport: true, group: "ts5.9" },
{ from: "../generated/ts5.9/sharedworker.asynciterable.generated.d.ts", to: "ts5.9/asynciterable.d.ts", autoImport: true, group: "ts5.9" }
],
},
{
name: "@types/webworker",
description: "Types for the global scope of Web Workers",
readme: "./readmes/webworker.md",
files: [
{ from: "../generated/webworker.generated.d.ts", to: "index.d.ts", index: true },
{ from: "../generated/webworker.iterable.generated.d.ts", to: "iterable.d.ts", autoImport: true },
{ from: "../generated/webworker.asynciterable.generated.d.ts", to: "asynciterable.d.ts", autoImport: true },
{ from: "../generated/ts5.5/webworker.generated.d.ts", to: "ts5.5/index.d.ts", index: true, group: "ts5.5" },
{ from: "../generated/ts5.5/webworker.iterable.generated.d.ts", to: "ts5.5/iterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.5/webworker.asynciterable.generated.d.ts", to: "ts5.5/asynciterable.d.ts", autoImport: true, group: "ts5.5" },
{ from: "../generated/ts5.6/webworker.generated.d.ts", to: "ts5.6/index.d.ts", index: true, group: "ts5.6" },
{ from: "../generated/ts5.6/webworker.iterable.generated.d.ts", to: "ts5.6/iterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.6/webworker.asynciterable.generated.d.ts", to: "ts5.6/asynciterable.d.ts", autoImport: true, group: "ts5.6" },
{ from: "../generated/ts5.9/webworker.generated.d.ts", to: "ts5.9/index.d.ts", index: true, group: "ts5.9" },
{ from: "../generated/ts5.9/webworker.iterable.generated.d.ts", to: "ts5.9/iterable.d.ts", autoImport: true, group: "ts5.9" },
{ from: "../generated/ts5.9/webworker.asynciterable.generated.d.ts", to: "ts5.9/asynciterable.d.ts", autoImport: true, group: "ts5.9" }
]
}
];
// Note: You can add 'version: "1.0.0"' to a package above
// to set the major or minor, otherwise it will always bump
// the patch.
import fs from "fs";
import { fileURLToPath } from "url";
import semver from "semver";
import pkg from "prettier";
import path from "path";
const { format } = pkg;
const go = async () => {
const generatedDir = new URL("generated/", import.meta.url);
const templateDir = new URL("template/", import.meta.url);
for (const pkg of packages) {
const folderName = pkg.name.replace("@", "").replace("/", "-");
const packagePath = new URL(`${folderName}/`, generatedDir);
if (fs.existsSync(packagePath)) {
await fs.promises.rm(packagePath, { recursive: true });
}
fs.mkdirSync(packagePath, { recursive: true });
// Migrate in the template files
for (const templateFile of fs.readdirSync(templateDir)) {
if (templateFile.startsWith(".")) {
continue;
}
const templatedFile = new URL(templateFile, templateDir);
fs.copyFileSync(templatedFile, new URL(templateFile, packagePath));
}
// Add the reference files in the config above
pkg.files.forEach((fileRef) => {
const from = new URL(fileRef.from, import.meta.url);
const to = new URL(fileRef.to, packagePath);
fs.mkdirSync(new URL(".", to), { recursive: true });
fs.copyFileSync(from, to);
});
prependAutoImports(pkg, packagePath);
// Setup the files in the repo
const newPkgJSON = await updatePackageJSON(pkg, packagePath);
copyREADME(pkg, newPkgJSON, new URL("README.md", packagePath));
// Done
console.log("Built:", pkg.name);
}
};
/**
* @param {Package} pkg
* @param {URL} packagePath
*/
async function updatePackageJSON(pkg, packagePath) {
const pkgJSONPath = new URL("package.json", packagePath);
const packageText = fs.readFileSync(pkgJSONPath, "utf8");
/** @type {typeof import("./template/package.json")} */
const packageJSON = JSON.parse(packageText);
packageJSON.name = pkg.name;
packageJSON.description = pkg.description;
// Bump the last version of the number from npm,
// or use the _version in tsconfig if it's higher,
// or default to 0.0.1
let version = "0.0.1";
try {
const npmResponse = await fetch(
`https://registry.npmjs.org/${packageJSON.name}`,
);
/** @type {*} */
const npmPackage = await npmResponse.json();
const semverMarkers = npmPackage["dist-tags"].latest.split(".");
const bumpedVersion = `${semverMarkers[0]}.${semverMarkers[1]}.${
Number(semverMarkers[2]) + 1
}`;
if (semver.gt(bumpedVersion, version)) {
version = bumpedVersion;
}
} catch (error) {
console.error("Caught error in grabbing version for package");
console.error(error);
// NOOP, this is for the first deploy, which will set it to 0.0.1
}
packageJSON.version = version;
fs.writeFileSync(
pkgJSONPath,
await format(JSON.stringify(packageJSON), {
filepath: fileURLToPath(pkgJSONPath),
}),
);
return packageJSON;
}
/**
* Copies the README and adds some rudimentary templating to the file.
* @param {Package} pkg
* @param {typeof import("./template/package.json")} pkgJSON
* @param {URL} writePath
*/
function copyREADME(pkg, pkgJSON, writePath) {
let readme = fs.readFileSync(new URL(pkg.readme, import.meta.url), "utf-8");
const htmlEncodedTag =
encodeURIComponent(pkgJSON.name) + "%40" + pkgJSON.version;
readme = readme
.replace("{{version}}", pkgJSON.version)
.replace(
"{{release_href}}",
`https://github.com/microsoft/TypeScript-DOM-lib-generator/releases/tag/${htmlEncodedTag}`,
);
fs.writeFileSync(writePath, readme);
}
/**
* Appends any files marked as autoImport in the metadata.
* @param {Package} pkg
* @param {URL} packagePath
*/
function prependAutoImports(pkg, packagePath) {
/**
* @type {Map<string | undefined, typeof pkg.files[number][]>}
*/
const groups = new Map();
for (const file of pkg.files) {
let files = groups.get(file.group);
if (!files) {
groups.set(file.group, (files = []));
}
files.push(file);
}
for (const files of groups.values()) {
const indexFile = files.find((file) => file.index);
if (!indexFile) {
continue;
}
const index = new URL(indexFile.to, packagePath);
if (!fs.existsSync(index)) {
continue;
}
const toPrepend = files
.filter((f) => !!f.autoImport)
.map((f) => relativeUrl(index, new URL(f.to, packagePath)))
.map((f) => `/// <reference path="${f}" />`)
.join("\n");
if (toPrepend) {
const indexText = fs.readFileSync(index, "utf-8");
fs.writeFileSync(index, `${toPrepend}\n\n${indexText}`);
}
}
}
/**
* @param {URL} from
* @param {URL} to
*/
function relativeUrl(from, to) {
if (from.origin !== to.origin) {
return to.toString();
}
if (!from.pathname.endsWith("/")) {
from = new URL("./", from);
}
const relative = path.posix.relative(from.pathname, to.pathname);
return path.isAbsolute(relative) ||
relative.startsWith("../") ||
relative.startsWith("./")
? relative
: `./${relative}`;
}
if (process.argv[1] === fileURLToPath(import.meta.url)) {
await go();
}