wrangler 0.0.0-bfbb0be → 0.0.0-bfbe49d0

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 (161) hide show
  1. package/README.md +29 -11
  2. package/bin/wrangler.js +99 -114
  3. package/package.json +194 -155
  4. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  5. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  6. package/templates/__tests__/tsconfig.json +8 -0
  7. package/templates/checked-fetch.js +30 -0
  8. package/templates/facade.d.ts +17 -0
  9. package/templates/gitignore +1 -0
  10. package/templates/init-tests/test-jest-new-worker.js +23 -0
  11. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  12. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  13. package/templates/middleware/common.ts +67 -0
  14. package/templates/middleware/loader-modules.ts +137 -0
  15. package/templates/middleware/loader-sw.ts +228 -0
  16. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  17. package/templates/middleware/middleware-d1-beta.ts +244 -0
  18. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  19. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  20. package/templates/middleware/middleware-multiworker-dev.ts +59 -0
  21. package/templates/middleware/middleware-pretty-error.ts +40 -0
  22. package/templates/middleware/middleware-scheduled.ts +15 -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/new-worker-scheduled.js +3 -3
  26. package/templates/new-worker-scheduled.ts +16 -16
  27. package/templates/new-worker.js +3 -3
  28. package/templates/new-worker.ts +19 -16
  29. package/templates/no-op-worker.js +8 -8
  30. package/templates/pages-dev-pipeline.ts +31 -0
  31. package/templates/pages-dev-util.ts +55 -0
  32. package/templates/pages-shim.ts +9 -0
  33. package/templates/pages-template-plugin.ts +159 -124
  34. package/templates/pages-template-worker.ts +161 -124
  35. package/templates/tsconfig-sanity.ts +11 -0
  36. package/templates/tsconfig.init.json +105 -0
  37. package/templates/tsconfig.json +6 -103
  38. package/wrangler-dist/cli.d.ts +1732 -0
  39. package/wrangler-dist/cli.js +112895 -89619
  40. package/wrangler-dist/wasm-sync.wasm +0 -0
  41. package/import_meta_url.js +0 -3
  42. package/miniflare-config-stubs/.env.empty +0 -0
  43. package/miniflare-config-stubs/package.empty.json +0 -1
  44. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  45. package/miniflare-dist/index.mjs +0 -4886
  46. package/src/__tests__/config-cache.test.ts +0 -36
  47. package/src/__tests__/configuration.test.ts +0 -3548
  48. package/src/__tests__/dev.test.tsx +0 -1055
  49. package/src/__tests__/guess-worker-format.test.ts +0 -85
  50. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  51. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  52. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  53. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  54. package/src/__tests__/helpers/mock-bin.ts +0 -36
  55. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  56. package/src/__tests__/helpers/mock-console.ts +0 -97
  57. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  58. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  59. package/src/__tests__/helpers/mock-istty.ts +0 -32
  60. package/src/__tests__/helpers/mock-kv.ts +0 -33
  61. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -250
  62. package/src/__tests__/helpers/mock-process.ts +0 -39
  63. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  64. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  65. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  66. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  67. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  68. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  69. package/src/__tests__/https-options.test.ts +0 -130
  70. package/src/__tests__/index.test.ts +0 -258
  71. package/src/__tests__/init.test.ts +0 -1992
  72. package/src/__tests__/jest.setup.ts +0 -107
  73. package/src/__tests__/kv.test.ts +0 -1619
  74. package/src/__tests__/logger.test.ts +0 -141
  75. package/src/__tests__/package-manager.test.ts +0 -353
  76. package/src/__tests__/pages.test.ts +0 -1242
  77. package/src/__tests__/parse.test.ts +0 -330
  78. package/src/__tests__/publish.test.ts +0 -6188
  79. package/src/__tests__/r2.test.ts +0 -233
  80. package/src/__tests__/route.test.ts +0 -45
  81. package/src/__tests__/secret.test.ts +0 -486
  82. package/src/__tests__/tail.test.ts +0 -690
  83. package/src/__tests__/user.test.ts +0 -132
  84. package/src/__tests__/whoami.test.tsx +0 -139
  85. package/src/abort.d.ts +0 -3
  86. package/src/bundle-reporter.tsx +0 -29
  87. package/src/bundle.ts +0 -204
  88. package/src/cfetch/index.ts +0 -121
  89. package/src/cfetch/internal.ts +0 -142
  90. package/src/cli.ts +0 -13
  91. package/src/config/README.md +0 -107
  92. package/src/config/config.ts +0 -243
  93. package/src/config/diagnostics.ts +0 -80
  94. package/src/config/environment.ts +0 -420
  95. package/src/config/index.ts +0 -225
  96. package/src/config/validation-helpers.ts +0 -584
  97. package/src/config/validation.ts +0 -1580
  98. package/src/config-cache.ts +0 -44
  99. package/src/create-worker-preview.ts +0 -185
  100. package/src/create-worker-upload-form.ts +0 -254
  101. package/src/dev/dev-vars.ts +0 -36
  102. package/src/dev/dev.tsx +0 -399
  103. package/src/dev/local.tsx +0 -321
  104. package/src/dev/remote.tsx +0 -282
  105. package/src/dev/use-esbuild.ts +0 -112
  106. package/src/dialogs.tsx +0 -135
  107. package/src/durable.ts +0 -102
  108. package/src/entry.ts +0 -328
  109. package/src/environment-variables.ts +0 -35
  110. package/src/errors.ts +0 -11
  111. package/src/git-client.ts +0 -42
  112. package/src/https-options.ts +0 -123
  113. package/src/index.tsx +0 -2908
  114. package/src/inspect.ts +0 -662
  115. package/src/intl-polyfill.d.ts +0 -139
  116. package/src/kv.ts +0 -408
  117. package/src/logger.ts +0 -73
  118. package/src/miniflare-cli/README.md +0 -30
  119. package/src/miniflare-cli/enum-keys.ts +0 -17
  120. package/src/miniflare-cli/index.ts +0 -41
  121. package/src/miniflare-cli/request-context.ts +0 -40
  122. package/src/module-collection.ts +0 -258
  123. package/src/open-in-browser.ts +0 -17
  124. package/src/package-manager.ts +0 -174
  125. package/src/pages/build.tsx +0 -202
  126. package/src/pages/constants.ts +0 -7
  127. package/src/pages/deployments.tsx +0 -101
  128. package/src/pages/dev.tsx +0 -948
  129. package/src/pages/functions/buildPlugin.ts +0 -105
  130. package/src/pages/functions/buildWorker.ts +0 -151
  131. package/src/pages/functions/filepath-routing.test.ts +0 -234
  132. package/src/pages/functions/filepath-routing.ts +0 -189
  133. package/src/pages/functions/identifiers.ts +0 -78
  134. package/src/pages/functions/routes.ts +0 -151
  135. package/src/pages/index.tsx +0 -84
  136. package/src/pages/projects.tsx +0 -157
  137. package/src/pages/publish.tsx +0 -325
  138. package/src/pages/types.ts +0 -40
  139. package/src/pages/upload.tsx +0 -363
  140. package/src/pages/utils.ts +0 -12
  141. package/src/parse.ts +0 -222
  142. package/src/paths.ts +0 -26
  143. package/src/proxy.ts +0 -476
  144. package/src/publish.ts +0 -739
  145. package/src/r2.ts +0 -50
  146. package/src/selfsigned.d.ts +0 -29
  147. package/src/sites.tsx +0 -372
  148. package/src/tail/filters.ts +0 -279
  149. package/src/tail/index.ts +0 -299
  150. package/src/tail/printing.ts +0 -67
  151. package/src/update-check.ts +0 -19
  152. package/src/user/choose-account.tsx +0 -60
  153. package/src/user/env-vars.ts +0 -17
  154. package/src/user/generate-auth-url.ts +0 -33
  155. package/src/user/generate-random-state.ts +0 -16
  156. package/src/user/index.ts +0 -3
  157. package/src/user/user.tsx +0 -1133
  158. package/src/whoami.tsx +0 -71
  159. package/src/worker.ts +0 -181
  160. package/src/zones.ts +0 -73
  161. package/templates/static-asset-facade.js +0 -43
@@ -1,363 +0,0 @@
1
- import { readdir, readFile, stat } from "node:fs/promises";
2
- import { basename, extname, join, relative, resolve, sep } from "node:path";
3
- import { hash as blake3hash } from "blake3-wasm";
4
- import { render, Text } from "ink";
5
- import Spinner from "ink-spinner";
6
- import { getType } from "mime";
7
- import PQueue from "p-queue";
8
- import prettyBytes from "pretty-bytes";
9
- import React from "react";
10
- import { fetchResult } from "../cfetch";
11
- import { FatalError } from "../errors";
12
- import { logger } from "../logger";
13
- import {
14
- BULK_UPLOAD_CONCURRENCY,
15
- MAX_BUCKET_FILE_COUNT,
16
- MAX_BUCKET_SIZE,
17
- MAX_UPLOAD_ATTEMPTS,
18
- } from "./constants";
19
- import { pagesBetaWarning } from "./utils";
20
- import type { UploadPayloadFile } from "./types";
21
- import type { ArgumentsCamelCase, Argv } from "yargs";
22
-
23
- type UploadArgs = {
24
- directory: string;
25
- };
26
-
27
- export function Options(yargs: Argv): Argv<UploadArgs> {
28
- return yargs
29
- .positional("directory", {
30
- type: "string",
31
- demandOption: true,
32
- description: "The directory of static files to upload",
33
- })
34
- .epilogue(pagesBetaWarning);
35
- }
36
-
37
- export const Handler = async ({
38
- directory,
39
- }: ArgumentsCamelCase<UploadArgs>) => {
40
- if (!directory) {
41
- throw new FatalError("Must specify a directory.", 1);
42
- }
43
-
44
- if (!process.env.CF_PAGES_UPLOAD_JWT) {
45
- throw new FatalError("No JWT given.", 1);
46
- }
47
-
48
- await upload({
49
- directory,
50
- jwt: process.env.CF_PAGES_UPLOAD_JWT,
51
- });
52
-
53
- logger.log(`✨ Upload complete!`);
54
- };
55
-
56
- export const upload = async (
57
- args:
58
- | {
59
- directory: string;
60
- jwt: string;
61
- }
62
- | { directory: string; accountId: string; projectName: string }
63
- ) => {
64
- async function fetchJwt(): Promise<string> {
65
- if ("jwt" in args) {
66
- return args.jwt;
67
- } else {
68
- return (
69
- await fetchResult<{ jwt: string }>(
70
- `/accounts/${args.accountId}/pages/projects/${args.projectName}/upload-token`
71
- )
72
- ).jwt;
73
- }
74
- }
75
-
76
- type FileContainer = {
77
- content: string;
78
- contentType: string;
79
- sizeInBytes: number;
80
- hash: string;
81
- };
82
-
83
- const IGNORE_LIST = [
84
- "_worker.js",
85
- "_redirects",
86
- "_headers",
87
- ".DS_Store",
88
- "node_modules",
89
- ".git",
90
- ];
91
-
92
- const directory = resolve(args.directory);
93
-
94
- const walk = async (
95
- dir: string,
96
- fileMap: Map<string, FileContainer> = new Map(),
97
- startingDir: string = dir
98
- ) => {
99
- const files = await readdir(dir);
100
-
101
- await Promise.all(
102
- files.map(async (file) => {
103
- const filepath = join(dir, file);
104
- const filestat = await stat(filepath);
105
-
106
- if (IGNORE_LIST.includes(file)) {
107
- return;
108
- }
109
-
110
- if (filestat.isSymbolicLink()) {
111
- return;
112
- }
113
-
114
- if (filestat.isDirectory()) {
115
- fileMap = await walk(filepath, fileMap, startingDir);
116
- } else {
117
- const name = relative(startingDir, filepath).split(sep).join("/");
118
-
119
- // TODO: Move this to later so we don't hold as much in memory
120
- const fileContent = await readFile(filepath);
121
-
122
- const base64Content = fileContent.toString("base64");
123
- const extension = extname(basename(name)).substring(1);
124
-
125
- if (filestat.size > 25 * 1024 * 1024) {
126
- throw new FatalError(
127
- `Error: Pages only supports files up to ${prettyBytes(
128
- 25 * 1024 * 1024
129
- )} in size\n${name} is ${prettyBytes(filestat.size)} in size`,
130
- 1
131
- );
132
- }
133
-
134
- fileMap.set(name, {
135
- content: base64Content,
136
- contentType: getType(name) || "application/octet-stream",
137
- sizeInBytes: filestat.size,
138
- hash: blake3hash(base64Content + extension)
139
- .toString("hex")
140
- .slice(0, 32),
141
- });
142
- }
143
- })
144
- );
145
-
146
- return fileMap;
147
- };
148
-
149
- const fileMap = await walk(directory);
150
-
151
- if (fileMap.size > 20000) {
152
- throw new FatalError(
153
- `Error: Pages only supports up to 20,000 files in a deployment. Ensure you have specified your build output directory correctly.`,
154
- 1
155
- );
156
- }
157
-
158
- const files = [...fileMap.values()];
159
-
160
- let jwt = await fetchJwt();
161
-
162
- const start = Date.now();
163
-
164
- const missingHashes = await fetchResult<string[]>(
165
- `/pages/assets/check-missing`,
166
- {
167
- method: "POST",
168
- headers: {
169
- "Content-Type": "application/json",
170
- Authorization: `Bearer ${jwt}`,
171
- },
172
- body: JSON.stringify({
173
- hashes: files.map(({ hash }) => hash),
174
- }),
175
- }
176
- );
177
-
178
- const sortedFiles = files
179
- .filter((file) => missingHashes.includes(file.hash))
180
- .sort((a, b) => b.sizeInBytes - a.sizeInBytes);
181
-
182
- // Start with a few buckets so small projects still get
183
- // the benefit of multiple upload streams
184
- const buckets: {
185
- files: FileContainer[];
186
- remainingSize: number;
187
- }[] = new Array(BULK_UPLOAD_CONCURRENCY).fill(null).map(() => ({
188
- files: [],
189
- remainingSize: MAX_BUCKET_SIZE,
190
- }));
191
-
192
- let bucketOffset = 0;
193
- for (const file of sortedFiles) {
194
- let inserted = false;
195
-
196
- for (let i = 0; i < buckets.length; i++) {
197
- // Start at a different bucket for each new file
198
- const bucket = buckets[(i + bucketOffset) % buckets.length];
199
- if (
200
- bucket.remainingSize >= file.sizeInBytes &&
201
- bucket.files.length < MAX_BUCKET_FILE_COUNT
202
- ) {
203
- bucket.files.push(file);
204
- bucket.remainingSize -= file.sizeInBytes;
205
- inserted = true;
206
- break;
207
- }
208
- }
209
-
210
- if (!inserted) {
211
- buckets.push({
212
- files: [file],
213
- remainingSize: MAX_BUCKET_SIZE - file.sizeInBytes,
214
- });
215
- }
216
- bucketOffset++;
217
- }
218
-
219
- let counter = fileMap.size - sortedFiles.length;
220
- const { rerender, unmount } = render(
221
- <Progress done={counter} total={fileMap.size} />
222
- );
223
-
224
- const queue = new PQueue({ concurrency: BULK_UPLOAD_CONCURRENCY });
225
-
226
- for (const bucket of buckets) {
227
- // Don't upload empty buckets (can happen for tiny projects)
228
- if (bucket.files.length === 0) continue;
229
-
230
- const payload: UploadPayloadFile[] = bucket.files.map((file) => ({
231
- key: file.hash,
232
- value: file.content,
233
- metadata: {
234
- contentType: file.contentType,
235
- },
236
- base64: true,
237
- }));
238
-
239
- let attempts = 0;
240
- const doUpload = async (): Promise<void> => {
241
- try {
242
- return await fetchResult(`/pages/assets/upload`, {
243
- method: "POST",
244
- headers: {
245
- "Content-Type": "application/json",
246
- Authorization: `Bearer ${jwt}`,
247
- },
248
- body: JSON.stringify(payload),
249
- });
250
- } catch (e) {
251
- if (attempts < MAX_UPLOAD_ATTEMPTS) {
252
- // Linear backoff, 0 second first time, then 1 second etc.
253
- await new Promise((resolvePromise) =>
254
- setTimeout(resolvePromise, attempts++ * 1000)
255
- );
256
-
257
- if ((e as { code: number }).code === 8000013) {
258
- // Looks like the JWT expired, fetch another one
259
- jwt = await fetchJwt();
260
- }
261
- return doUpload();
262
- } else {
263
- throw e;
264
- }
265
- }
266
- };
267
-
268
- queue.add(() =>
269
- doUpload().then(
270
- () => {
271
- counter += bucket.files.length;
272
- rerender(<Progress done={counter} total={fileMap.size} />);
273
- },
274
- (error) => {
275
- return Promise.reject(
276
- new FatalError(
277
- "Failed to upload files. Please try again.",
278
- error.code || 1
279
- )
280
- );
281
- }
282
- )
283
- );
284
- }
285
-
286
- await queue.onIdle();
287
-
288
- unmount();
289
-
290
- const uploadMs = Date.now() - start;
291
-
292
- const skipped = fileMap.size - missingHashes.length;
293
- const skippedMessage = skipped > 0 ? `(${skipped} already uploaded) ` : "";
294
-
295
- logger.log(
296
- `✨ Success! Uploaded ${
297
- sortedFiles.length
298
- } files ${skippedMessage}${formatTime(uploadMs)}\n`
299
- );
300
-
301
- const doUpsertHashes = async (): Promise<void> => {
302
- try {
303
- return await fetchResult(`/pages/assets/upsert-hashes`, {
304
- method: "POST",
305
- headers: {
306
- "Content-Type": "application/json",
307
- Authorization: `Bearer ${jwt}`,
308
- },
309
- body: JSON.stringify({
310
- hashes: files.map(({ hash }) => hash),
311
- }),
312
- });
313
- } catch (e) {
314
- await new Promise((resolvePromise) => setTimeout(resolvePromise, 1000));
315
-
316
- if ((e as { code: number }).code === 8000013) {
317
- // Looks like the JWT expired, fetch another one
318
- jwt = await fetchJwt();
319
- }
320
-
321
- return await fetchResult(`/pages/assets/upsert-hashes`, {
322
- method: "POST",
323
- headers: {
324
- "Content-Type": "application/json",
325
- Authorization: `Bearer ${jwt}`,
326
- },
327
- body: JSON.stringify({
328
- hashes: files.map(({ hash }) => hash),
329
- }),
330
- });
331
- }
332
- };
333
-
334
- try {
335
- await doUpsertHashes();
336
- } catch {
337
- logger.warn(
338
- "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."
339
- );
340
- }
341
-
342
- return Object.fromEntries(
343
- [...fileMap.entries()].map(([fileName, file]) => [
344
- `/${fileName}`,
345
- file.hash,
346
- ])
347
- );
348
- };
349
-
350
- function formatTime(duration: number) {
351
- return `(${(duration / 1000).toFixed(2)} sec)`;
352
- }
353
-
354
- function Progress({ done, total }: { done: number; total: number }) {
355
- return (
356
- <>
357
- <Text>
358
- <Spinner type="earth" />
359
- {` Uploading... (${done}/${total})\n`}
360
- </Text>
361
- </>
362
- );
363
- }
@@ -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,222 +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
- }
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
- }