wrangler 0.0.0-eab9542 → 0.0.0-eaf71b86c

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.
Files changed (180) hide show
  1. package/README.md +29 -13
  2. package/bin/wrangler.js +50 -88
  3. package/config-schema.json +3074 -0
  4. package/package.json +196 -157
  5. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  6. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  7. package/templates/__tests__/tsconfig.json +8 -0
  8. package/templates/checked-fetch.js +19 -6
  9. package/templates/facade.d.ts +19 -0
  10. package/templates/gitignore +2 -3
  11. package/templates/init-tests/test-jest-new-worker.js +23 -0
  12. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  13. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  14. package/templates/middleware/common.ts +67 -0
  15. package/templates/middleware/loader-modules.ts +134 -0
  16. package/templates/middleware/loader-sw.ts +229 -0
  17. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-mock-analytics-engine.d.ts +3 -0
  20. package/templates/middleware/middleware-mock-analytics-engine.ts +30 -0
  21. package/templates/middleware/middleware-pretty-error.ts +40 -0
  22. package/templates/middleware/middleware-scheduled.ts +29 -0
  23. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  24. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  25. package/templates/modules-watch-stub.js +4 -0
  26. package/templates/new-worker-scheduled.ts +1 -1
  27. package/templates/new-worker.js +1 -1
  28. package/templates/new-worker.ts +4 -1
  29. package/templates/pages-dev-pipeline.ts +32 -0
  30. package/templates/pages-dev-util.ts +55 -0
  31. package/templates/pages-shim.ts +9 -0
  32. package/templates/pages-template-plugin.ts +53 -18
  33. package/templates/pages-template-worker.ts +49 -12
  34. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  35. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +22 -0
  38. package/templates/tsconfig.json +5 -102
  39. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  40. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  41. package/wrangler-dist/ProxyWorker.js +241 -0
  42. package/wrangler-dist/ProxyWorker.js.map +6 -0
  43. package/wrangler-dist/cli.d.ts +26465 -0
  44. package/wrangler-dist/cli.js +198587 -108581
  45. package/wrangler-dist/wasm-sync.wasm +0 -0
  46. package/Cloudflare_CA.pem +0 -18
  47. package/import_meta_url.js +0 -3
  48. package/miniflare-config-stubs/.env.empty +0 -0
  49. package/miniflare-config-stubs/package.empty.json +0 -1
  50. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  51. package/miniflare-dist/index.mjs +0 -4894
  52. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  53. package/src/__tests__/config-cache.test.ts +0 -42
  54. package/src/__tests__/configuration.test.ts +0 -3946
  55. package/src/__tests__/dev.test.tsx +0 -1159
  56. package/src/__tests__/guess-worker-format.test.ts +0 -85
  57. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  58. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  59. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  60. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  61. package/src/__tests__/helpers/mock-bin.ts +0 -36
  62. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  63. package/src/__tests__/helpers/mock-console.ts +0 -97
  64. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-kv.ts +0 -33
  68. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  69. package/src/__tests__/helpers/mock-process.ts +0 -39
  70. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  71. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  72. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  73. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  74. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  75. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  76. package/src/__tests__/https-options.test.ts +0 -130
  77. package/src/__tests__/index.test.ts +0 -262
  78. package/src/__tests__/init.test.ts +0 -1992
  79. package/src/__tests__/jest.setup.ts +0 -107
  80. package/src/__tests__/kv.test.ts +0 -1619
  81. package/src/__tests__/logger.test.ts +0 -141
  82. package/src/__tests__/package-manager.test.ts +0 -353
  83. package/src/__tests__/pages.test.ts +0 -1254
  84. package/src/__tests__/parse.test.ts +0 -330
  85. package/src/__tests__/publish.test.ts +0 -6569
  86. package/src/__tests__/pubsub.test.ts +0 -367
  87. package/src/__tests__/r2.test.ts +0 -233
  88. package/src/__tests__/route.test.ts +0 -45
  89. package/src/__tests__/secret.test.ts +0 -486
  90. package/src/__tests__/tail.test.ts +0 -690
  91. package/src/__tests__/user.test.ts +0 -143
  92. package/src/__tests__/whoami.test.tsx +0 -220
  93. package/src/__tests__/worker-namespace.test.ts +0 -327
  94. package/src/abort.d.ts +0 -3
  95. package/src/api/dev.ts +0 -52
  96. package/src/api/index.ts +0 -1
  97. package/src/bundle-reporter.tsx +0 -29
  98. package/src/bundle.ts +0 -212
  99. package/src/cfetch/index.ts +0 -121
  100. package/src/cfetch/internal.ts +0 -149
  101. package/src/cli.ts +0 -27
  102. package/src/config/README.md +0 -107
  103. package/src/config/config.ts +0 -243
  104. package/src/config/diagnostics.ts +0 -80
  105. package/src/config/environment.ts +0 -453
  106. package/src/config/index.ts +0 -238
  107. package/src/config/validation-helpers.ts +0 -584
  108. package/src/config/validation.ts +0 -1745
  109. package/src/config-cache.ts +0 -83
  110. package/src/create-worker-preview.ts +0 -255
  111. package/src/create-worker-upload-form.ts +0 -263
  112. package/src/dev/dev-vars.ts +0 -36
  113. package/src/dev/dev.tsx +0 -417
  114. package/src/dev/local.tsx +0 -352
  115. package/src/dev/remote.tsx +0 -382
  116. package/src/dev/use-esbuild.ts +0 -150
  117. package/src/dev.tsx +0 -538
  118. package/src/dialogs.tsx +0 -135
  119. package/src/durable.ts +0 -102
  120. package/src/entry.ts +0 -328
  121. package/src/environment-variables.ts +0 -35
  122. package/src/errors.ts +0 -11
  123. package/src/generate.ts +0 -33
  124. package/src/git-client.ts +0 -42
  125. package/src/https-options.ts +0 -123
  126. package/src/index.tsx +0 -1871
  127. package/src/init.ts +0 -549
  128. package/src/inspect.ts +0 -662
  129. package/src/intl-polyfill.d.ts +0 -139
  130. package/src/is-interactive.ts +0 -12
  131. package/src/kv.ts +0 -408
  132. package/src/logger.ts +0 -73
  133. package/src/miniflare-cli/README.md +0 -30
  134. package/src/miniflare-cli/enum-keys.ts +0 -17
  135. package/src/miniflare-cli/index.ts +0 -53
  136. package/src/miniflare-cli/request-context.ts +0 -40
  137. package/src/module-collection.ts +0 -258
  138. package/src/open-in-browser.ts +0 -17
  139. package/src/package-manager.ts +0 -174
  140. package/src/pages/build.tsx +0 -202
  141. package/src/pages/constants.ts +0 -7
  142. package/src/pages/deployments.tsx +0 -101
  143. package/src/pages/dev.tsx +0 -964
  144. package/src/pages/functions/buildPlugin.ts +0 -105
  145. package/src/pages/functions/buildWorker.ts +0 -151
  146. package/src/pages/functions/filepath-routing.test.ts +0 -234
  147. package/src/pages/functions/filepath-routing.ts +0 -189
  148. package/src/pages/functions/identifiers.ts +0 -78
  149. package/src/pages/functions/routes.ts +0 -151
  150. package/src/pages/index.tsx +0 -84
  151. package/src/pages/projects.tsx +0 -157
  152. package/src/pages/publish.tsx +0 -335
  153. package/src/pages/types.ts +0 -40
  154. package/src/pages/upload.tsx +0 -384
  155. package/src/pages/utils.ts +0 -12
  156. package/src/parse.ts +0 -286
  157. package/src/paths.ts +0 -26
  158. package/src/preview.ts +0 -31
  159. package/src/proxy.ts +0 -476
  160. package/src/publish.ts +0 -767
  161. package/src/pubsub/index.ts +0 -286
  162. package/src/pubsub/pubsub-commands.tsx +0 -577
  163. package/src/r2.ts +0 -50
  164. package/src/selfsigned.d.ts +0 -29
  165. package/src/sites.tsx +0 -372
  166. package/src/tail/filters.ts +0 -279
  167. package/src/tail/index.ts +0 -299
  168. package/src/tail/printing.ts +0 -67
  169. package/src/update-check.ts +0 -19
  170. package/src/user/choose-account.tsx +0 -60
  171. package/src/user/env-vars.ts +0 -46
  172. package/src/user/generate-auth-url.ts +0 -33
  173. package/src/user/generate-random-state.ts +0 -16
  174. package/src/user/index.ts +0 -3
  175. package/src/user/user.tsx +0 -1161
  176. package/src/whoami.tsx +0 -90
  177. package/src/worker-namespace.ts +0 -190
  178. package/src/worker.ts +0 -191
  179. package/src/zones.ts +0 -76
  180. package/templates/static-asset-facade.js +0 -43
@@ -1,384 +0,0 @@
1
- import { mkdir, readdir, readFile, stat, writeFile } from "node:fs/promises";
2
- import {
3
- basename,
4
- dirname,
5
- extname,
6
- join,
7
- relative,
8
- resolve,
9
- sep,
10
- } from "node:path";
11
- import { hash as blake3hash } from "blake3-wasm";
12
- import { render, Text } from "ink";
13
- import Spinner from "ink-spinner";
14
- import { getType } from "mime";
15
- import PQueue from "p-queue";
16
- import prettyBytes from "pretty-bytes";
17
- import React from "react";
18
- import { fetchResult } from "../cfetch";
19
- import { FatalError } from "../errors";
20
- import { logger } from "../logger";
21
- import {
22
- BULK_UPLOAD_CONCURRENCY,
23
- MAX_BUCKET_FILE_COUNT,
24
- MAX_BUCKET_SIZE,
25
- MAX_UPLOAD_ATTEMPTS,
26
- } from "./constants";
27
- import { pagesBetaWarning } from "./utils";
28
- import type { UploadPayloadFile } from "./types";
29
- import type { ArgumentsCamelCase, Argv } from "yargs";
30
-
31
- type UploadArgs = {
32
- directory: string;
33
- "output-manifest-path"?: string;
34
- };
35
-
36
- export function Options(yargs: Argv): Argv<UploadArgs> {
37
- return yargs
38
- .positional("directory", {
39
- type: "string",
40
- demandOption: true,
41
- description: "The directory of static files to upload",
42
- })
43
- .options({
44
- "output-manifest-path": {
45
- type: "string",
46
- description: "The name of the project you want to deploy to",
47
- },
48
- })
49
- .epilogue(pagesBetaWarning);
50
- }
51
-
52
- export const Handler = async ({
53
- directory,
54
- outputManifestPath,
55
- }: ArgumentsCamelCase<UploadArgs>) => {
56
- if (!directory) {
57
- throw new FatalError("Must specify a directory.", 1);
58
- }
59
-
60
- if (!process.env.CF_PAGES_UPLOAD_JWT) {
61
- throw new FatalError("No JWT given.", 1);
62
- }
63
-
64
- const manifest = await upload({
65
- directory,
66
- jwt: process.env.CF_PAGES_UPLOAD_JWT,
67
- });
68
-
69
- if (outputManifestPath) {
70
- await mkdir(dirname(outputManifestPath), { recursive: true });
71
- await writeFile(outputManifestPath, JSON.stringify(manifest));
72
- }
73
-
74
- logger.log(`✨ Upload complete!`);
75
- };
76
-
77
- export const upload = async (
78
- args:
79
- | {
80
- directory: string;
81
- jwt: string;
82
- }
83
- | { directory: string; accountId: string; projectName: string }
84
- ) => {
85
- async function fetchJwt(): Promise<string> {
86
- if ("jwt" in args) {
87
- return args.jwt;
88
- } else {
89
- return (
90
- await fetchResult<{ jwt: string }>(
91
- `/accounts/${args.accountId}/pages/projects/${args.projectName}/upload-token`
92
- )
93
- ).jwt;
94
- }
95
- }
96
-
97
- type FileContainer = {
98
- content: string;
99
- contentType: string;
100
- sizeInBytes: number;
101
- hash: string;
102
- };
103
-
104
- const IGNORE_LIST = [
105
- "_worker.js",
106
- "_redirects",
107
- "_headers",
108
- ".DS_Store",
109
- "node_modules",
110
- ".git",
111
- ];
112
-
113
- const directory = resolve(args.directory);
114
-
115
- const walk = async (
116
- dir: string,
117
- fileMap: Map<string, FileContainer> = new Map(),
118
- startingDir: string = dir
119
- ) => {
120
- const files = await readdir(dir);
121
-
122
- await Promise.all(
123
- files.map(async (file) => {
124
- const filepath = join(dir, file);
125
- const filestat = await stat(filepath);
126
-
127
- if (IGNORE_LIST.includes(file)) {
128
- return;
129
- }
130
-
131
- if (filestat.isSymbolicLink()) {
132
- return;
133
- }
134
-
135
- if (filestat.isDirectory()) {
136
- fileMap = await walk(filepath, fileMap, startingDir);
137
- } else {
138
- const name = relative(startingDir, filepath).split(sep).join("/");
139
-
140
- // TODO: Move this to later so we don't hold as much in memory
141
- const fileContent = await readFile(filepath);
142
-
143
- const base64Content = fileContent.toString("base64");
144
- const extension = extname(basename(name)).substring(1);
145
-
146
- if (filestat.size > 25 * 1024 * 1024) {
147
- throw new FatalError(
148
- `Error: Pages only supports files up to ${prettyBytes(
149
- 25 * 1024 * 1024
150
- )} in size\n${name} is ${prettyBytes(filestat.size)} in size`,
151
- 1
152
- );
153
- }
154
-
155
- fileMap.set(name, {
156
- content: base64Content,
157
- contentType: getType(name) || "application/octet-stream",
158
- sizeInBytes: filestat.size,
159
- hash: blake3hash(base64Content + extension)
160
- .toString("hex")
161
- .slice(0, 32),
162
- });
163
- }
164
- })
165
- );
166
-
167
- return fileMap;
168
- };
169
-
170
- const fileMap = await walk(directory);
171
-
172
- if (fileMap.size > 20000) {
173
- throw new FatalError(
174
- `Error: Pages only supports up to 20,000 files in a deployment. Ensure you have specified your build output directory correctly.`,
175
- 1
176
- );
177
- }
178
-
179
- const files = [...fileMap.values()];
180
-
181
- let jwt = await fetchJwt();
182
-
183
- const start = Date.now();
184
-
185
- const missingHashes = await fetchResult<string[]>(
186
- `/pages/assets/check-missing`,
187
- {
188
- method: "POST",
189
- headers: {
190
- "Content-Type": "application/json",
191
- Authorization: `Bearer ${jwt}`,
192
- },
193
- body: JSON.stringify({
194
- hashes: files.map(({ hash }) => hash),
195
- }),
196
- }
197
- );
198
-
199
- const sortedFiles = files
200
- .filter((file) => missingHashes.includes(file.hash))
201
- .sort((a, b) => b.sizeInBytes - a.sizeInBytes);
202
-
203
- // Start with a few buckets so small projects still get
204
- // the benefit of multiple upload streams
205
- const buckets: {
206
- files: FileContainer[];
207
- remainingSize: number;
208
- }[] = new Array(BULK_UPLOAD_CONCURRENCY).fill(null).map(() => ({
209
- files: [],
210
- remainingSize: MAX_BUCKET_SIZE,
211
- }));
212
-
213
- let bucketOffset = 0;
214
- for (const file of sortedFiles) {
215
- let inserted = false;
216
-
217
- for (let i = 0; i < buckets.length; i++) {
218
- // Start at a different bucket for each new file
219
- const bucket = buckets[(i + bucketOffset) % buckets.length];
220
- if (
221
- bucket.remainingSize >= file.sizeInBytes &&
222
- bucket.files.length < MAX_BUCKET_FILE_COUNT
223
- ) {
224
- bucket.files.push(file);
225
- bucket.remainingSize -= file.sizeInBytes;
226
- inserted = true;
227
- break;
228
- }
229
- }
230
-
231
- if (!inserted) {
232
- buckets.push({
233
- files: [file],
234
- remainingSize: MAX_BUCKET_SIZE - file.sizeInBytes,
235
- });
236
- }
237
- bucketOffset++;
238
- }
239
-
240
- let counter = fileMap.size - sortedFiles.length;
241
- const { rerender, unmount } = render(
242
- <Progress done={counter} total={fileMap.size} />
243
- );
244
-
245
- const queue = new PQueue({ concurrency: BULK_UPLOAD_CONCURRENCY });
246
-
247
- for (const bucket of buckets) {
248
- // Don't upload empty buckets (can happen for tiny projects)
249
- if (bucket.files.length === 0) continue;
250
-
251
- const payload: UploadPayloadFile[] = bucket.files.map((file) => ({
252
- key: file.hash,
253
- value: file.content,
254
- metadata: {
255
- contentType: file.contentType,
256
- },
257
- base64: true,
258
- }));
259
-
260
- let attempts = 0;
261
- const doUpload = async (): Promise<void> => {
262
- try {
263
- return await fetchResult(`/pages/assets/upload`, {
264
- method: "POST",
265
- headers: {
266
- "Content-Type": "application/json",
267
- Authorization: `Bearer ${jwt}`,
268
- },
269
- body: JSON.stringify(payload),
270
- });
271
- } catch (e) {
272
- if (attempts < MAX_UPLOAD_ATTEMPTS) {
273
- // Linear backoff, 0 second first time, then 1 second etc.
274
- await new Promise((resolvePromise) =>
275
- setTimeout(resolvePromise, attempts++ * 1000)
276
- );
277
-
278
- if ((e as { code: number }).code === 8000013) {
279
- // Looks like the JWT expired, fetch another one
280
- jwt = await fetchJwt();
281
- }
282
- return doUpload();
283
- } else {
284
- throw e;
285
- }
286
- }
287
- };
288
-
289
- queue.add(() =>
290
- doUpload().then(
291
- () => {
292
- counter += bucket.files.length;
293
- rerender(<Progress done={counter} total={fileMap.size} />);
294
- },
295
- (error) => {
296
- return Promise.reject(
297
- new FatalError(
298
- "Failed to upload files. Please try again.",
299
- error.code || 1
300
- )
301
- );
302
- }
303
- )
304
- );
305
- }
306
-
307
- await queue.onIdle();
308
-
309
- unmount();
310
-
311
- const uploadMs = Date.now() - start;
312
-
313
- const skipped = fileMap.size - missingHashes.length;
314
- const skippedMessage = skipped > 0 ? `(${skipped} already uploaded) ` : "";
315
-
316
- logger.log(
317
- `✨ Success! Uploaded ${
318
- sortedFiles.length
319
- } files ${skippedMessage}${formatTime(uploadMs)}\n`
320
- );
321
-
322
- const doUpsertHashes = async (): Promise<void> => {
323
- try {
324
- return await fetchResult(`/pages/assets/upsert-hashes`, {
325
- method: "POST",
326
- headers: {
327
- "Content-Type": "application/json",
328
- Authorization: `Bearer ${jwt}`,
329
- },
330
- body: JSON.stringify({
331
- hashes: files.map(({ hash }) => hash),
332
- }),
333
- });
334
- } catch (e) {
335
- await new Promise((resolvePromise) => setTimeout(resolvePromise, 1000));
336
-
337
- if ((e as { code: number }).code === 8000013) {
338
- // Looks like the JWT expired, fetch another one
339
- jwt = await fetchJwt();
340
- }
341
-
342
- return await fetchResult(`/pages/assets/upsert-hashes`, {
343
- method: "POST",
344
- headers: {
345
- "Content-Type": "application/json",
346
- Authorization: `Bearer ${jwt}`,
347
- },
348
- body: JSON.stringify({
349
- hashes: files.map(({ hash }) => hash),
350
- }),
351
- });
352
- }
353
- };
354
-
355
- try {
356
- await doUpsertHashes();
357
- } catch {
358
- logger.warn(
359
- "Failed to update file hashes. Every upload appeared to succeed for this deployment, but you might need to re-upload for future deployments. This shouldn't have any impact other than slowing the upload speed of your next deployment."
360
- );
361
- }
362
-
363
- return Object.fromEntries(
364
- [...fileMap.entries()].map(([fileName, file]) => [
365
- `/${fileName}`,
366
- file.hash,
367
- ])
368
- );
369
- };
370
-
371
- function formatTime(duration: number) {
372
- return `(${(duration / 1000).toFixed(2)} sec)`;
373
- }
374
-
375
- function Progress({ done, total }: { done: number; total: number }) {
376
- return (
377
- <>
378
- <Text>
379
- <Spinner type="earth" />
380
- {` Uploading... (${done}/${total})\n`}
381
- </Text>
382
- </>
383
- );
384
- }
@@ -1,12 +0,0 @@
1
- import type { BuildResult } from "esbuild";
2
-
3
- export const RUNNING_BUILDERS: BuildResult[] = [];
4
-
5
- export const CLEANUP_CALLBACKS: (() => void)[] = [];
6
- export const CLEANUP = () => {
7
- CLEANUP_CALLBACKS.forEach((callback) => callback());
8
- RUNNING_BUILDERS.forEach((builder) => builder.stop?.());
9
- };
10
-
11
- export const pagesBetaWarning =
12
- "🚧 'wrangler pages <command>' is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose";
package/src/parse.ts DELETED
@@ -1,286 +0,0 @@
1
- import * as fs from "node:fs";
2
- import { resolve } from "node:path";
3
- import TOML from "@iarna/toml";
4
- import { formatMessagesSync } from "esbuild";
5
- import { logger } from "./logger";
6
-
7
- export type Message = {
8
- text: string;
9
- location?: Location;
10
- notes?: Message[];
11
- kind?: "warning" | "error";
12
- };
13
-
14
- export type Location = File & {
15
- line: number;
16
- column: number;
17
- length?: number;
18
- lineText?: string;
19
- suggestion?: string;
20
- };
21
-
22
- export type File = {
23
- file?: string;
24
- fileText?: string;
25
- };
26
-
27
- /**
28
- * Formats a `Message` using esbuild's pretty-printing algorithm.
29
- */
30
- export function formatMessage(
31
- { text, notes, location, kind = "error" }: Message,
32
- color = true
33
- ): string {
34
- const input = { text, notes, location };
35
- delete input.location?.fileText;
36
- for (const note of notes ?? []) {
37
- delete note.location?.fileText;
38
- }
39
- const lines = formatMessagesSync([input], {
40
- color,
41
- kind: kind,
42
- terminalWidth: logger.columns,
43
- });
44
- return lines.join("\n");
45
- }
46
-
47
- /**
48
- * An error that's thrown when something fails to parse.
49
- */
50
- export class ParseError extends Error implements Message {
51
- readonly text: string;
52
- readonly notes: Message[];
53
- readonly location?: Location;
54
- readonly kind: "warning" | "error";
55
-
56
- constructor({ text, notes, location, kind }: Message) {
57
- super(text);
58
- this.name = this.constructor.name;
59
- this.text = text;
60
- this.notes = notes ?? [];
61
- this.location = location;
62
- this.kind = kind ?? "error";
63
- }
64
- }
65
-
66
- const TOML_ERROR_NAME = "TomlError";
67
- const TOML_ERROR_SUFFIX = " at row ";
68
-
69
- type TomlError = Error & {
70
- line: number;
71
- col: number;
72
- };
73
-
74
- /**
75
- * A wrapper around `TOML.parse` that throws a `ParseError`.
76
- */
77
- export function parseTOML(input: string, file?: string): TOML.JsonMap | never {
78
- try {
79
- // Normalize CRLF to LF to avoid hitting https://github.com/iarna/iarna-toml/issues/33.
80
- const normalizedInput = input.replace(/\r\n/g, "\n");
81
- return TOML.parse(normalizedInput);
82
- } catch (err) {
83
- const { name, message, line, col } = err as TomlError;
84
- if (name !== TOML_ERROR_NAME) {
85
- throw err;
86
- }
87
- const text = message.substring(0, message.lastIndexOf(TOML_ERROR_SUFFIX));
88
- const lineText = input.split("\n")[line];
89
- const location = {
90
- lineText,
91
- line: line + 1,
92
- column: col - 1,
93
- file,
94
- fileText: input,
95
- };
96
- throw new ParseError({ text, location });
97
- }
98
- }
99
-
100
- const JSON_ERROR_SUFFIX = " in JSON at position ";
101
-
102
- /**
103
- * A minimal type describing a package.json file.
104
- */
105
- export type PackageJSON = {
106
- devDependencies?: Record<string, unknown>;
107
- dependencies?: Record<string, unknown>;
108
- scripts?: Record<string, unknown>;
109
- };
110
-
111
- /**
112
- * A typed version of `parseJSON()`.
113
- */
114
- export function parsePackageJSON<T extends PackageJSON = PackageJSON>(
115
- input: string,
116
- file?: string
117
- ): T {
118
- return parseJSON<T>(input, file);
119
- }
120
-
121
- /**
122
- * A wrapper around `JSON.parse` that throws a `ParseError`.
123
- */
124
- export function parseJSON<T>(input: string, file?: string): T {
125
- try {
126
- return JSON.parse(input);
127
- } catch (err) {
128
- const { message } = err as Error;
129
- const index = message.lastIndexOf(JSON_ERROR_SUFFIX);
130
- if (index < 0) {
131
- throw err;
132
- }
133
- const text = message.substring(0, index);
134
- const position = parseInt(
135
- message.substring(index + JSON_ERROR_SUFFIX.length)
136
- );
137
- const location = indexLocation({ file, fileText: input }, position);
138
- throw new ParseError({ text, location });
139
- }
140
- }
141
-
142
- /**
143
- * Reads a file into a node Buffer.
144
- */
145
- export function readFileSyncToBuffer(file: string): Buffer {
146
- try {
147
- return fs.readFileSync(file);
148
- } catch (err) {
149
- const { message } = err as Error;
150
- throw new ParseError({
151
- text: `Could not read file: ${file}`,
152
- notes: [
153
- {
154
- text: message.replace(file, resolve(file)),
155
- },
156
- ],
157
- });
158
- }
159
- }
160
-
161
- /**
162
- * Reads a file and parses it based on its type.
163
- */
164
- export function readFileSync(file: string): string {
165
- try {
166
- return fs.readFileSync(file, { encoding: "utf-8" });
167
- } catch (err) {
168
- const { message } = err as Error;
169
- throw new ParseError({
170
- text: `Could not read file: ${file}`,
171
- notes: [
172
- {
173
- text: message.replace(file, resolve(file)),
174
- },
175
- ],
176
- });
177
- }
178
- }
179
-
180
- /**
181
- * Calculates the line and column location from an index.
182
- */
183
- export function indexLocation(file: File, index: number): Location {
184
- let lineText,
185
- line = 0,
186
- column = 0,
187
- cursor = 0;
188
- const { fileText = "" } = file;
189
- for (const row of fileText.split("\n")) {
190
- line++;
191
- cursor += row.length + 1;
192
- if (cursor >= index) {
193
- lineText = row;
194
- column = row.length - (cursor - index);
195
- break;
196
- }
197
- }
198
- return { lineText, line, column, ...file };
199
- }
200
-
201
- /**
202
- * Guesses the line and column location of a search query.
203
- */
204
- export function searchLocation(file: File, query: unknown): Location {
205
- let lineText,
206
- length,
207
- line = 0,
208
- column = 0;
209
- const queryText = String(query);
210
- const { fileText = "" } = file;
211
- for (const content of fileText.split("\n")) {
212
- line++;
213
- const index = content.indexOf(queryText);
214
- if (index >= 0) {
215
- lineText = content;
216
- column = index;
217
- length = queryText.length;
218
- break;
219
- }
220
- }
221
- return { lineText, line, column, length, ...file };
222
- }
223
-
224
- const units = {
225
- nanoseconds: 0.000000001,
226
- nanosecond: 0.000000001,
227
- microseconds: 0.000001,
228
- microsecond: 0.000001,
229
- milliseconds: 0.001,
230
- millisecond: 0.001,
231
- seconds: 1,
232
- second: 1,
233
- minutes: 60,
234
- minute: 60,
235
- hours: 3600,
236
- hour: 3600,
237
- days: 86400,
238
- day: 86400,
239
- weeks: 604800,
240
- week: 604800,
241
- month: 18144000,
242
- year: 220752000,
243
-
244
- nsecs: 0.000000001,
245
- nsec: 0.000000001,
246
- usecs: 0.000001,
247
- usec: 0.000001,
248
- msecs: 0.001,
249
- msec: 0.001,
250
- secs: 1,
251
- sec: 1,
252
- mins: 60,
253
- min: 60,
254
-
255
- ns: 0.000000001,
256
- us: 0.000001,
257
- ms: 0.001,
258
- mo: 18144000,
259
- yr: 220752000,
260
-
261
- s: 1,
262
- m: 60,
263
- h: 3600,
264
- d: 86400,
265
- w: 604800,
266
- y: 220752000,
267
- };
268
-
269
- /**
270
- * Parse a human-readable time duration in seconds (including fractional)
271
- *
272
- * Invalid values will return NaN
273
- */
274
- export function parseHumanDuration(s: string): number {
275
- const unitsMap = new Map(Object.entries(units));
276
- s = s.trim().toLowerCase();
277
- let base = 1;
278
- for (const [name, _] of unitsMap) {
279
- if (s.endsWith(name)) {
280
- s = s.substring(0, s.length - name.length);
281
- base = unitsMap.get(name) || 1;
282
- break;
283
- }
284
- }
285
- return Number(s) * base;
286
- }
package/src/paths.ts DELETED
@@ -1,26 +0,0 @@
1
- import { assert } from "console";
2
-
3
- type DiscriminatedPath<Discriminator extends string> = string & {
4
- _discriminator: Discriminator;
5
- };
6
-
7
- /**
8
- * A branded string that expects to be URL compatible.
9
- *
10
- * Require this type when you want callers to ensure that they have converted file-path strings into URL-safe paths.
11
- */
12
- export type UrlPath = DiscriminatedPath<"UrlPath">;
13
-
14
- /**
15
- * Convert a file-path string to a URL-path string.
16
- *
17
- * Use this helper to convert a `string` to a `UrlPath` when it is not clear whether the string needs normalizing.
18
- * Replaces all back-slashes with forward-slashes, and throws an error if the path contains a drive letter (e.g. `C:`).
19
- */
20
- export function toUrlPath(path: string): UrlPath {
21
- assert(
22
- !/^[a-z]:/i.test(path),
23
- "Tried to convert a Windows file path with a drive to a URL path."
24
- );
25
- return path.replace(/\\/g, "/") as UrlPath;
26
- }