wrangler 0.0.0-e043479 → 0.0.0-e0a0509

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 (96) hide show
  1. package/README.md +27 -14
  2. package/bin/wrangler.js +13 -1
  3. package/miniflare-dist/index.mjs +4886 -0
  4. package/package.json +38 -25
  5. package/pages/functions/buildPlugin.ts +92 -0
  6. package/pages/functions/buildWorker.ts +80 -4
  7. package/pages/functions/filepath-routing.test.ts +136 -25
  8. package/pages/functions/filepath-routing.ts +14 -3
  9. package/pages/functions/routes.ts +6 -1
  10. package/pages/functions/template-plugin.ts +146 -0
  11. package/pages/functions/template-worker.ts +21 -8
  12. package/src/__tests__/config-cache.test.ts +36 -0
  13. package/src/__tests__/configuration.test.ts +1294 -355
  14. package/src/__tests__/dev.test.tsx +592 -12
  15. package/src/__tests__/guess-worker-format.test.ts +37 -18
  16. package/src/__tests__/helpers/mock-account-id.ts +4 -0
  17. package/src/__tests__/helpers/mock-cfetch.ts +8 -4
  18. package/src/__tests__/helpers/mock-console.ts +20 -3
  19. package/src/__tests__/helpers/mock-dialogs.ts +26 -1
  20. package/src/__tests__/helpers/mock-http-server.ts +46 -0
  21. package/src/__tests__/helpers/mock-istty.ts +27 -0
  22. package/src/__tests__/helpers/mock-kv.ts +9 -16
  23. package/src/__tests__/helpers/mock-oauth-flow.ts +255 -0
  24. package/src/__tests__/helpers/run-in-tmp.ts +10 -0
  25. package/src/__tests__/helpers/write-worker-source.ts +31 -0
  26. package/src/__tests__/https-options.test.ts +130 -0
  27. package/src/__tests__/index.test.ts +129 -753
  28. package/src/__tests__/init.test.ts +1516 -0
  29. package/src/__tests__/jest.setup.ts +13 -5
  30. package/src/__tests__/kv.test.ts +208 -174
  31. package/src/__tests__/logger.test.ts +115 -0
  32. package/src/__tests__/pages.test.ts +327 -0
  33. package/src/__tests__/parse.test.ts +4 -0
  34. package/src/__tests__/publish.test.ts +3313 -505
  35. package/src/__tests__/r2.test.ts +38 -26
  36. package/src/__tests__/route.test.ts +45 -0
  37. package/src/__tests__/secret.test.ts +55 -34
  38. package/src/__tests__/tail.test.ts +146 -20
  39. package/src/__tests__/user.test.ts +131 -0
  40. package/src/__tests__/whoami.test.tsx +26 -7
  41. package/src/bundle.ts +43 -7
  42. package/src/cfetch/internal.ts +9 -5
  43. package/src/cli.ts +5 -11
  44. package/src/config/README.md +7 -7
  45. package/src/config/config.ts +69 -105
  46. package/src/config/environment.ts +93 -4
  47. package/src/config/index.ts +15 -4
  48. package/src/config/validation-helpers.ts +228 -23
  49. package/src/config/validation.ts +559 -154
  50. package/src/config-cache.ts +45 -0
  51. package/src/{api/preview.ts → create-worker-preview.ts} +41 -13
  52. package/src/{api/form_data.ts → create-worker-upload-form.ts} +33 -10
  53. package/src/dev/dev-vars.ts +36 -0
  54. package/src/dev/dev.tsx +418 -0
  55. package/src/dev/local.tsx +312 -0
  56. package/src/dev/remote.tsx +213 -0
  57. package/src/dev/use-esbuild.ts +118 -0
  58. package/src/dialogs.tsx +16 -6
  59. package/src/entry.ts +222 -12
  60. package/src/environment-variables.ts +3 -1
  61. package/src/errors.ts +11 -0
  62. package/src/https-options.ts +123 -0
  63. package/src/index.tsx +878 -482
  64. package/src/inspect.ts +25 -11
  65. package/src/intl-polyfill.d.ts +139 -0
  66. package/src/{kv.tsx → kv.ts} +7 -27
  67. package/src/logger.ts +66 -0
  68. package/src/miniflare-cli/README.md +30 -0
  69. package/src/miniflare-cli/enum-keys.ts +17 -0
  70. package/src/miniflare-cli/index.ts +41 -0
  71. package/src/miniflare-cli/request-context.ts +40 -0
  72. package/src/module-collection.ts +94 -6
  73. package/src/open-in-browser.ts +18 -5
  74. package/src/package-manager.ts +9 -8
  75. package/src/pages.tsx +892 -62
  76. package/src/parse.ts +4 -2
  77. package/src/proxy.ts +128 -55
  78. package/src/publish.ts +305 -199
  79. package/src/selfsigned.d.ts +29 -0
  80. package/src/sites.tsx +88 -33
  81. package/src/tail/index.ts +2 -2
  82. package/src/tail/printing.ts +13 -8
  83. package/src/update-check.ts +19 -0
  84. package/src/user.tsx +244 -104
  85. package/src/whoami.tsx +2 -1
  86. package/src/{api/worker.ts → worker.ts} +15 -29
  87. package/templates/gitignore +171 -0
  88. package/templates/static-asset-facade.js +1 -1
  89. package/wrangler-dist/cli.js +23568 -50489
  90. package/src/__tests__/helpers/mock-user.ts +0 -27
  91. package/src/__tests__/logout.test.ts +0 -50
  92. package/src/__tests__/sentry.test.ts +0 -146
  93. package/src/dev.tsx +0 -960
  94. package/src/guess-worker-format.ts +0 -68
  95. package/src/reporting.ts +0 -115
  96. package/wrangler-dist/cli.js.map +0 -7
@@ -1,11 +1,5 @@
1
- import * as fs from "node:fs";
2
- import * as fsp from "node:fs/promises";
3
- import * as TOML from "@iarna/toml";
4
- import { parseConfigFileTextToJson } from "typescript";
5
- import { version as wranglerVersion } from "../../package.json";
6
1
  import { getPackageManager } from "../package-manager";
7
2
  import { mockConsoleMethods } from "./helpers/mock-console";
8
- import { mockConfirm } from "./helpers/mock-dialogs";
9
3
  import { runInTempDir } from "./helpers/run-in-tmp";
10
4
  import { runWrangler } from "./helpers/run-wrangler";
11
5
  import type { PackageManager } from "../package-manager";
@@ -36,7 +30,6 @@ describe("wrangler", () => {
36
30
 
37
31
  Commands:
38
32
  wrangler init [name] 📥 Create a wrangler.toml configuration file
39
- wrangler whoami 🕵️ Retrieve your user info and test your auth config
40
33
  wrangler dev [script] 👂 Start a local server for developing your worker
41
34
  wrangler publish [script] 🆙 Publish your Worker to Cloudflare.
42
35
  wrangler tail [name] 🦚 Starts a log tailing session for a published Worker.
@@ -46,12 +39,14 @@ describe("wrangler", () => {
46
39
  wrangler kv:bulk 💪 Interact with multiple Workers KV key-value pairs at once
47
40
  wrangler pages ⚡️ Configure Cloudflare Pages
48
41
  wrangler r2 📦 Interact with an R2 store
42
+ wrangler login 🔓 Login to Cloudflare
43
+ wrangler logout 🚪 Logout from Cloudflare
44
+ wrangler whoami 🕵️ Retrieve your user info and test your auth config
49
45
 
50
46
  Flags:
51
- -c, --config Path to .toml configuration file [string]
52
- -h, --help Show help [boolean]
53
- -v, --version Show version number [boolean]
54
- --legacy-env Use legacy environments [boolean]"
47
+ -c, --config Path to .toml configuration file [string]
48
+ -h, --help Show help [boolean]
49
+ -v, --version Show version number [boolean]"
55
50
  `);
56
51
 
57
52
  expect(std.err).toMatchInlineSnapshot(`""`);
@@ -63,16 +58,18 @@ describe("wrangler", () => {
63
58
  await expect(
64
59
  runWrangler("invalid-command")
65
60
  ).rejects.toThrowErrorMatchingInlineSnapshot(
66
- `"Unknown command: invalid-command."`
61
+ `"Unknown argument: invalid-command"`
67
62
  );
68
63
 
69
- expect(std.out).toMatchInlineSnapshot(`""`);
64
+ expect(std.out).toMatchInlineSnapshot(`
65
+ "
66
+ "
67
+ `);
70
68
  expect(std.err).toMatchInlineSnapshot(`
71
69
  "wrangler
72
70
 
73
71
  Commands:
74
72
  wrangler init [name] 📥 Create a wrangler.toml configuration file
75
- wrangler whoami 🕵️ Retrieve your user info and test your auth config
76
73
  wrangler dev [script] 👂 Start a local server for developing your worker
77
74
  wrangler publish [script] 🆙 Publish your Worker to Cloudflare.
78
75
  wrangler tail [name] 🦚 Starts a log tailing session for a published Worker.
@@ -82,785 +79,164 @@ describe("wrangler", () => {
82
79
  wrangler kv:bulk 💪 Interact with multiple Workers KV key-value pairs at once
83
80
  wrangler pages ⚡️ Configure Cloudflare Pages
84
81
  wrangler r2 📦 Interact with an R2 store
82
+ wrangler login 🔓 Login to Cloudflare
83
+ wrangler logout 🚪 Logout from Cloudflare
84
+ wrangler whoami 🕵️ Retrieve your user info and test your auth config
85
85
 
86
86
  Flags:
87
- -c, --config Path to .toml configuration file [string]
88
- -h, --help Show help [boolean]
89
- -v, --version Show version number [boolean]
90
- --legacy-env Use legacy environments [boolean]
87
+ -c, --config Path to .toml configuration file [string]
88
+ -h, --help Show help [boolean]
89
+ -v, --version Show version number [boolean]
90
+ X [ERROR] Unknown argument: invalid-command
91
91
 
92
- Unknown command: invalid-command."
92
+ "
93
93
  `);
94
94
  });
95
95
  });
96
96
 
97
- describe("init", () => {
98
- it("should create a wrangler.toml", async () => {
99
- mockConfirm({
100
- text: "No package.json found. Would you like to create one?",
101
- result: false,
102
- });
103
- await runWrangler("init");
104
- const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
105
- expect(typeof parsed.compatibility_date).toBe("string");
106
- expect(parsed.name).toContain("wrangler-tests");
107
- expect(fs.existsSync("./package.json")).toBe(false);
108
- expect(fs.existsSync("./tsconfig.json")).toBe(false);
109
- });
110
-
111
- it("should create a wrangler.toml and a directory for a named Worker ", async () => {
112
- mockConfirm({
113
- text: "No package.json found. Would you like to create one?",
114
- result: false,
115
- });
116
- await runWrangler("init my-worker");
117
- const parsed = TOML.parse(
118
- await fsp.readFile("./my-worker/wrangler.toml", "utf-8")
119
- );
120
- expect(typeof parsed.compatibility_date).toBe("string");
121
- expect(parsed.name).toBe("my-worker");
122
- expect(fs.existsSync("./my-worker/package.json")).toBe(false);
123
- expect(fs.existsSync("./my-worker/tsconfig.json")).toBe(false);
124
- });
125
-
126
- it("should display warning when wrangler.toml already exists, and exit if user does not want to carry on", async () => {
127
- fs.writeFileSync(
128
- "./wrangler.toml",
129
- 'compatibility_date="something-else"', // use a fake value to make sure the file is not overwritten
130
- "utf-8"
131
- );
132
- mockConfirm({
133
- text: "Do you want to continue initializing this project?",
134
- result: false,
135
- });
136
- await runWrangler("init");
137
- expect(std.warn).toContain("wrangler.toml file already exists!");
138
- const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
139
- expect(parsed.compatibility_date).toBe("something-else");
140
- });
141
-
142
- it("should not overwrite an existing wrangler.toml, after agreeing to other prompts", async () => {
143
- fs.writeFileSync(
144
- "./wrangler.toml",
145
- 'compatibility_date="something-else"', // use a fake value to make sure the file is not overwritten
146
- "utf-8"
147
- );
148
- mockConfirm(
149
- {
150
- text: "Do you want to continue initializing this project?",
151
- result: true,
152
- },
153
- {
154
- text: "No package.json found. Would you like to create one?",
155
- result: true,
156
- },
157
- {
158
- text: "Would you like to use TypeScript?",
159
- result: true,
160
- },
161
- {
162
- text: "Would you like to create a Worker at src/index.ts?",
163
- result: true,
164
- }
165
- );
166
-
167
- await runWrangler("init");
168
- expect(fs.readFileSync("./wrangler.toml", "utf-8")).toMatchInlineSnapshot(
169
- `"compatibility_date=\\"something-else\\""`
170
- );
171
- });
172
-
173
- it("should display warning when wrangler.toml already exists, but continue if user does want to carry on", async () => {
174
- fs.writeFileSync(
175
- "./wrangler.toml",
176
- `compatibility_date="something-else"`,
177
- "utf-8"
178
- );
179
- mockConfirm(
180
- {
181
- text: "Do you want to continue initializing this project?",
182
- result: true,
183
- },
184
- {
185
- text: "No package.json found. Would you like to create one?",
186
- result: false,
187
- }
188
- );
189
- await runWrangler("init");
190
- expect(std.warn).toContain("wrangler.toml file already exists!");
191
- const parsed = TOML.parse(await fsp.readFile("./wrangler.toml", "utf-8"));
192
- expect(parsed.compatibility_date).toBe("something-else");
193
- });
194
-
195
- it("should create a package.json if none is found and user confirms", async () => {
196
- mockConfirm(
197
- {
198
- text: "No package.json found. Would you like to create one?",
199
- result: true,
200
- },
201
- {
202
- text: "Would you like to use TypeScript?",
203
- result: false,
204
- },
205
- {
206
- text: "Would you like to create a Worker at src/index.js?",
207
- result: false,
208
- }
209
- );
210
- await runWrangler("init");
211
- expect(fs.existsSync("./package.json")).toBe(true);
212
- const packageJson = JSON.parse(
213
- fs.readFileSync("./package.json", "utf-8")
214
- );
215
- expect(packageJson.name).toContain("wrangler-tests");
216
- expect(packageJson.version).toEqual("0.0.0");
217
- expect(packageJson.devDependencies).toEqual({
218
- wrangler: expect.any(String),
219
- });
220
- expect(fs.existsSync("./tsconfig.json")).toBe(false);
221
- expect(mockPackageManager.install).toHaveBeenCalled();
222
- });
223
-
224
- it("should create a package.json, with the specified name, if none is found and user confirms", async () => {
225
- mockConfirm(
226
- {
227
- text: "No package.json found. Would you like to create one?",
228
- result: true,
229
- },
230
- {
231
- text: "Would you like to use TypeScript?",
232
- result: false,
233
- },
234
- {
235
- text: "Would you like to create a Worker at src/index.js?",
236
- result: false,
237
- }
238
- );
239
- await runWrangler("init my-worker");
240
- const packageJson = JSON.parse(
241
- fs.readFileSync("./my-worker/package.json", "utf-8")
242
- );
243
- expect(packageJson.name).toBe("my-worker");
244
- });
245
-
246
- it("should not touch an existing package.json in the same directory", async () => {
247
- mockConfirm(
248
- {
249
- text: "Would you like to install wrangler into your package.json?",
250
- result: false,
251
- },
252
- {
253
- text: "Would you like to use TypeScript?",
254
- result: false,
255
- },
256
- {
257
- text: "Would you like to create a Worker at src/index.js?",
258
- result: false,
259
- }
260
- );
261
-
262
- fs.writeFileSync(
263
- "./package.json",
264
- JSON.stringify({ name: "test", version: "1.0.0" }),
265
- "utf-8"
266
- );
267
-
268
- await runWrangler("init");
269
- const packageJson = JSON.parse(
270
- fs.readFileSync("./package.json", "utf-8")
271
- );
272
- expect(packageJson.name).toEqual("test");
273
- expect(packageJson.version).toEqual("1.0.0");
274
- });
275
-
276
- it("should offer to install wrangler into an existing package.json", async () => {
277
- mockConfirm(
278
- {
279
- text: "Would you like to install wrangler into your package.json?",
280
- result: true,
281
- },
282
- {
283
- text: "Would you like to use TypeScript?",
284
- result: false,
285
- },
286
- {
287
- text: "Would you like to create a Worker at src/index.js?",
288
- result: false,
289
- }
290
- );
291
-
292
- fs.writeFileSync(
293
- "./package.json",
294
- JSON.stringify({ name: "test", version: "1.0.0" }),
295
- "utf-8"
296
- );
297
-
298
- await runWrangler("init");
299
- const packageJson = JSON.parse(
300
- fs.readFileSync("./package.json", "utf-8")
301
- );
302
- expect(packageJson.name).toEqual("test");
303
- expect(packageJson.version).toEqual("1.0.0");
304
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
305
- `wrangler@${wranglerVersion}`
306
- );
97
+ describe("preview", () => {
98
+ it("should throw an error if the deprecated command is used with positional arguments", async () => {
99
+ await expect(runWrangler("preview GET")).rejects
100
+ .toThrowErrorMatchingInlineSnapshot(`
101
+ "Deprecation:
102
+ The \`wrangler preview\` command has been deprecated.
103
+ Try using \`wrangler dev\` to to try out a worker during development.
104
+ "
105
+ `);
106
+ await expect(runWrangler(`preview GET "SomeBody"`)).rejects
107
+ .toThrowErrorMatchingInlineSnapshot(`
108
+ "Deprecation:
109
+ The \`wrangler preview\` command has been deprecated.
110
+ Try using \`wrangler dev\` to to try out a worker during development.
111
+ "
112
+ `);
307
113
  });
114
+ });
308
115
 
309
- it("should not touch an existing package.json in an ancestor directory", async () => {
310
- mockConfirm(
311
- {
312
- text: "Would you like to install wrangler into your package.json?",
313
- result: false,
314
- },
315
- {
316
- text: "Would you like to use TypeScript?",
317
- result: false,
318
- },
319
- {
320
- text: "Would you like to create a Worker at src/index.js?",
321
- result: false,
322
- }
323
- );
324
-
325
- fs.writeFileSync(
326
- "./package.json",
327
- JSON.stringify({ name: "test", version: "1.0.0" }),
328
- "utf-8"
329
- );
116
+ describe("subcommand implicit help ran on incomplete command execution", () => {
117
+ function endEventLoop() {
118
+ return new Promise((resolve) => setImmediate(resolve));
119
+ }
120
+ it("no subcommand for 'secret' should display a list of available subcommands", async () => {
121
+ await runWrangler("secret");
122
+ await endEventLoop();
123
+ expect(std.out).toMatchInlineSnapshot(`
124
+ "wrangler secret
330
125
 
331
- fs.mkdirSync("./sub-1/sub-2", { recursive: true });
332
- process.chdir("./sub-1/sub-2");
126
+ 🤫 Generate a secret that can be referenced in the worker script
333
127
 
334
- await runWrangler("init");
335
- expect(fs.existsSync("./package.json")).toBe(false);
336
- expect(fs.existsSync("../../package.json")).toBe(true);
128
+ Commands:
129
+ wrangler secret put <key> Create or update a secret variable for a script
130
+ wrangler secret delete <key> Delete a secret variable from a script
131
+ wrangler secret list List all secrets for a script
337
132
 
338
- const packageJson = JSON.parse(
339
- fs.readFileSync("../../package.json", "utf-8")
340
- );
341
- expect(packageJson).toMatchInlineSnapshot(`
342
- Object {
343
- "name": "test",
344
- "version": "1.0.0",
345
- }
133
+ Flags:
134
+ -c, --config Path to .toml configuration file [string]
135
+ -h, --help Show help [boolean]
136
+ -v, --version Show version number [boolean]"
346
137
  `);
347
138
  });
348
139
 
349
- it("should offer to create a worker in a non-typescript project", async () => {
350
- mockConfirm(
351
- {
352
- text: "Would you like to install wrangler into your package.json?",
353
- result: false,
354
- },
355
- {
356
- text: "Would you like to use TypeScript?",
357
- result: false,
358
- },
359
- {
360
- text: "Would you like to create a Worker at src/index.js?",
361
- result: true,
362
- }
363
- );
364
-
365
- fs.writeFileSync(
366
- "./package.json",
367
- JSON.stringify({ name: "test", version: "1.0.0" }),
368
- "utf-8"
369
- );
370
-
371
- await runWrangler("init");
372
- expect(fs.existsSync("./src/index.js")).toBe(true);
373
- expect(fs.existsSync("./src/index.ts")).toBe(false);
374
- });
375
-
376
- it("should offer to create a worker in a typescript project", async () => {
377
- mockConfirm(
378
- {
379
- text: "Would you like to install wrangler into your package.json?",
380
- result: false,
381
- },
382
- {
383
- text: "Would you like to use TypeScript?",
384
- result: true,
385
- },
386
- {
387
- text: "Would you like to create a Worker at src/index.ts?",
388
- result: true,
389
- }
390
- );
391
-
392
- fs.writeFileSync(
393
- "./package.json",
394
- JSON.stringify({ name: "test", version: "1.0.0" }),
395
- "utf-8"
396
- );
397
-
398
- await runWrangler("init");
399
- expect(fs.existsSync("./src/index.js")).toBe(false);
400
- expect(fs.existsSync("./src/index.ts")).toBe(true);
401
- });
402
-
403
- it("should add scripts for a typescript project with .ts extension", async () => {
404
- mockConfirm(
405
- {
406
- text: "No package.json found. Would you like to create one?",
407
- result: true,
408
- },
409
- {
410
- text: "Would you like to install wrangler into your package.json?",
411
- result: false,
412
- },
413
- {
414
- text: "Would you like to use TypeScript?",
415
- result: true,
416
- },
417
- {
418
- text: "Would you like to create a Worker at src/index.ts?",
419
- result: true,
420
- }
421
- );
422
- await runWrangler("init");
423
-
424
- expect(fs.existsSync("./package.json")).toBe(true);
425
- const packageJson = JSON.parse(
426
- fs.readFileSync("./package.json", "utf-8")
427
- );
428
-
429
- expect(fs.existsSync("./src/index.js")).toBe(false);
430
- expect(fs.existsSync("./src/index.ts")).toBe(true);
431
-
432
- expect(packageJson.scripts.start).toBe("wrangler dev");
433
- expect(packageJson.scripts.publish).toBe("wrangler publish");
434
- expect(packageJson.name).toContain("wrangler-tests");
435
- expect(packageJson.version).toEqual("0.0.0");
140
+ it("no subcommand 'kv:namespace' should display a list of available subcommands", async () => {
141
+ await runWrangler("kv:namespace");
142
+ await endEventLoop();
436
143
  expect(std.out).toMatchInlineSnapshot(`
437
- "✨ Successfully created wrangler.toml
438
- ✨ Created package.json
439
- ✨ Created tsconfig.json, installed @cloudflare/workers-types into devDependencies
440
- ✨ Created src/index.ts
144
+ "wrangler kv:namespace
441
145
 
442
- To start developing your Worker, run \`npm start\`
443
- To publish your Worker to the Internet, run \`npm run publish\`"
444
- `);
445
- });
446
-
447
- it("should not overwrite package.json scripts for a typescript project", async () => {
448
- mockConfirm(
449
- {
450
- text: "Would you like to install wrangler into your package.json?",
451
- result: false,
452
- },
453
- {
454
- text: "Would you like to use TypeScript?",
455
- result: true,
456
- },
457
- {
458
- text: "Would you like to create a Worker at src/index.ts?",
459
- result: true,
460
- }
461
- );
462
- await fsp.writeFile(
463
- "./package.json",
464
- JSON.stringify({
465
- scripts: {
466
- start: "test-start",
467
- publish: "test-publish",
468
- },
469
- })
470
- );
471
- const packageJson = JSON.parse(
472
- fs.readFileSync("./package.json", "utf-8")
473
- );
474
- await runWrangler("init");
475
-
476
- expect(fs.existsSync("./src/index.js")).toBe(false);
477
- expect(fs.existsSync("./src/index.ts")).toBe(true);
146
+ 🗂️ Interact with your Workers KV Namespaces
478
147
 
479
- expect(packageJson.scripts.start).toBe("test-start");
480
- expect(packageJson.scripts.publish).toBe("test-publish");
481
- expect(std.out).toMatchInlineSnapshot(`
482
- "✨ Successfully created wrangler.toml
483
- ✨ Created tsconfig.json, installed @cloudflare/workers-types into devDependencies
484
- ✨ Created src/index.ts
148
+ Commands:
149
+ wrangler kv:namespace create <namespace> Create a new namespace
150
+ wrangler kv:namespace list Outputs a list of all KV namespaces associated with your account id.
151
+ wrangler kv:namespace delete Deletes a given namespace.
485
152
 
486
- To start developing your Worker, run \`npx wrangler dev\`
487
- To publish your Worker to the Internet, run \`npx wrangler publish\`"
153
+ Flags:
154
+ -c, --config Path to .toml configuration file [string]
155
+ -h, --help Show help [boolean]
156
+ -v, --version Show version number [boolean]"
488
157
  `);
489
158
  });
490
159
 
491
- it("should add missing scripts for a non-ts project with .js extension", async () => {
492
- mockConfirm(
493
- {
494
- text: "No package.json found. Would you like to create one?",
495
- result: true,
496
- },
497
- {
498
- text: "Would you like to install wrangler into your package.json?",
499
- result: false,
500
- },
501
- {
502
- text: "Would you like to use TypeScript?",
503
- result: false,
504
- },
505
- {
506
- text: "Would you like to create a Worker at src/index.js?",
507
- result: true,
508
- }
509
- );
510
- await runWrangler("init");
511
-
512
- expect(fs.existsSync("./package.json")).toBe(true);
513
- const packageJson = JSON.parse(
514
- fs.readFileSync("./package.json", "utf-8")
515
- );
516
-
517
- expect(fs.existsSync("./src/index.js")).toBe(true);
518
- expect(fs.existsSync("./src/index.ts")).toBe(false);
519
-
520
- expect(packageJson.scripts.start).toBe("wrangler dev");
521
- expect(packageJson.scripts.publish).toBe("wrangler publish");
522
- expect(packageJson.name).toContain("wrangler-tests");
523
- expect(packageJson.version).toEqual("0.0.0");
160
+ it("no subcommand 'kv:key' should display a list of available subcommands", async () => {
161
+ await runWrangler("kv:key");
162
+ await endEventLoop();
524
163
  expect(std.out).toMatchInlineSnapshot(`
525
- "✨ Successfully created wrangler.toml
526
- ✨ Created package.json
527
- ✨ Created src/index.js
164
+ "wrangler kv:key
528
165
 
529
- To start developing your Worker, run \`npm start\`
530
- To publish your Worker to the Internet, run \`npm run publish\`"
531
- `);
532
- });
166
+ 🔑 Individually manage Workers KV key-value pairs
533
167
 
534
- it("should not overwrite package.json scripts for a non-ts project with .js extension", async () => {
535
- mockConfirm(
536
- {
537
- text: "Would you like to install wrangler into your package.json?",
538
- result: false,
539
- },
540
- {
541
- text: "Would you like to use TypeScript?",
542
- result: false,
543
- },
544
- {
545
- text: "Would you like to create a Worker at src/index.js?",
546
- result: true,
547
- }
548
- );
549
- await fsp.writeFile(
550
- "./package.json",
551
- JSON.stringify({
552
- scripts: {
553
- start: "test-start",
554
- publish: "test-publish",
555
- },
556
- })
557
- );
558
- const packageJson = JSON.parse(
559
- fs.readFileSync("./package.json", "utf-8")
560
- );
561
- await runWrangler("init");
562
-
563
- expect(fs.existsSync("./src/index.js")).toBe(true);
564
- expect(fs.existsSync("./src/index.ts")).toBe(false);
565
-
566
- expect(packageJson.scripts.start).toBe("test-start");
567
- expect(packageJson.scripts.publish).toBe("test-publish");
568
- expect(std.out).toMatchInlineSnapshot(`
569
- "✨ Successfully created wrangler.toml
570
- ✨ Created src/index.js
168
+ Commands:
169
+ wrangler kv:key put <key> [value] Writes a single key/value pair to the given namespace.
170
+ wrangler kv:key list Outputs a list of all keys in a given namespace.
171
+ wrangler kv:key get <key> Reads a single value by key from the given namespace.
172
+ wrangler kv:key delete <key> Removes a single key value pair from the given namespace.
571
173
 
572
- To start developing your Worker, run \`npx wrangler dev\`
573
- To publish your Worker to the Internet, run \`npx wrangler publish\`"
174
+ Flags:
175
+ -c, --config Path to .toml configuration file [string]
176
+ -h, --help Show help [boolean]
177
+ -v, --version Show version number [boolean]"
574
178
  `);
575
179
  });
576
180
 
577
- it("should not offer to create a worker in a non-ts project if a file already exists at the location", async () => {
578
- mockConfirm(
579
- {
580
- text: "Would you like to install wrangler into your package.json?",
581
- result: false,
582
- },
583
- {
584
- text: "Would you like to use TypeScript?",
585
- result: false,
586
- }
587
- );
588
-
589
- fs.writeFileSync(
590
- "./package.json",
591
- JSON.stringify({ name: "test", version: "1.0.0" }),
592
- "utf-8"
593
- );
594
- fs.mkdirSync("./src", { recursive: true });
595
- const PLACEHOLDER = "/* placeholder text */";
596
- fs.writeFileSync("./src/index.js", PLACEHOLDER, "utf-8");
597
-
598
- await runWrangler("init");
599
- expect(fs.readFileSync("./src/index.js", "utf-8")).toBe(PLACEHOLDER);
600
- expect(fs.existsSync("./src/index.ts")).toBe(false);
601
- });
602
-
603
- it("should not offer to create a worker in a ts project if a file already exists at the location", async () => {
604
- mockConfirm(
605
- {
606
- text: "Would you like to install wrangler into your package.json?",
607
- result: false,
608
- },
609
- {
610
- text: "Would you like to use TypeScript?",
611
- result: true,
612
- }
613
- );
614
-
615
- fs.writeFileSync(
616
- "./package.json",
617
- JSON.stringify({ name: "test", version: "1.0.0" }),
618
- "utf-8"
619
- );
620
- fs.mkdirSync("./src", { recursive: true });
621
- const PLACEHOLDER = "/* placeholder text */";
622
- fs.writeFileSync("./src/index.ts", PLACEHOLDER, "utf-8");
623
-
624
- await runWrangler("init");
625
- expect(fs.existsSync("./src/index.js")).toBe(false);
626
- expect(fs.readFileSync("./src/index.ts", "utf-8")).toBe(PLACEHOLDER);
627
- });
628
-
629
- it("should create a tsconfig.json and install `workers-types` if none is found and user confirms", async () => {
630
- mockConfirm(
631
- {
632
- text: "No package.json found. Would you like to create one?",
633
- result: true,
634
- },
635
- {
636
- text: "Would you like to use TypeScript?",
637
- result: true,
638
- },
639
- {
640
- text: "Would you like to create a Worker at src/index.ts?",
641
- result: false,
642
- }
643
- );
644
- await runWrangler("init");
645
- expect(fs.existsSync("./tsconfig.json")).toBe(true);
646
- const { config: tsconfigJson, error: tsConfigParseError } =
647
- parseConfigFileTextToJson(
648
- "./tsconfig.json",
649
- fs.readFileSync("./tsconfig.json", "utf-8")
650
- );
651
- expect(tsConfigParseError).toBeUndefined();
652
- expect(tsconfigJson.compilerOptions.types).toEqual([
653
- "@cloudflare/workers-types",
654
- ]);
655
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
656
- "@cloudflare/workers-types",
657
- "typescript"
658
- );
659
- });
660
-
661
- it("should not touch an existing tsconfig.json in the same directory", async () => {
662
- fs.writeFileSync(
663
- "./package.json",
664
- JSON.stringify({
665
- name: "test",
666
- version: "1.0.0",
667
- devDependencies: {
668
- wrangler: "0.0.0",
669
- "@cloudflare/workers-types": "0.0.0",
670
- },
671
- }),
672
- "utf-8"
673
- );
674
- fs.writeFileSync(
675
- "./tsconfig.json",
676
- JSON.stringify({ compilerOptions: {} }),
677
- "utf-8"
678
- );
679
-
680
- await runWrangler("init");
681
- const tsconfigJson = JSON.parse(
682
- fs.readFileSync("./tsconfig.json", "utf-8")
683
- );
684
- expect(tsconfigJson.compilerOptions).toEqual({});
685
- });
686
-
687
- it("should offer to install type definitions in an existing typescript project", async () => {
688
- mockConfirm(
689
- {
690
- text: "Would you like to install wrangler into your package.json?",
691
- result: false,
692
- },
693
- {
694
- text: "Would you like to install the type definitions for Workers into your package.json?",
695
- result: true,
696
- },
697
- {
698
- text: "Would you like to create a Worker at src/index.ts?",
699
- result: false,
700
- }
701
- );
702
- fs.writeFileSync(
703
- "./package.json",
704
- JSON.stringify({
705
- name: "test",
706
- version: "1.0.0",
707
- }),
708
- "utf-8"
709
- );
710
- fs.writeFileSync(
711
- "./tsconfig.json",
712
- JSON.stringify({ compilerOptions: {} }),
713
- "utf-8"
714
- );
715
-
716
- await runWrangler("init");
717
- const tsconfigJson = JSON.parse(
718
- fs.readFileSync("./tsconfig.json", "utf-8")
719
- );
720
- // unchanged tsconfig
721
- expect(tsconfigJson.compilerOptions).toEqual({});
722
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
723
- "@cloudflare/workers-types"
724
- );
725
- });
726
-
727
- it("should not touch an existing tsconfig.json in an ancestor directory", async () => {
728
- fs.writeFileSync(
729
- "./package.json",
730
- JSON.stringify({
731
- name: "test",
732
- version: "1.0.0",
733
- devDependencies: {
734
- wrangler: "0.0.0",
735
- "@cloudflare/workers-types": "0.0.0",
736
- },
737
- }),
738
- "utf-8"
739
- );
740
- fs.writeFileSync(
741
- "./tsconfig.json",
742
- JSON.stringify({ compilerOptions: {} }),
743
- "utf-8"
744
- );
745
-
746
- fs.mkdirSync("./sub-1/sub-2", { recursive: true });
747
- process.chdir("./sub-1/sub-2");
748
-
749
- await runWrangler("init");
750
- expect(fs.existsSync("./tsconfig.json")).toBe(false);
751
- expect(fs.existsSync("../../tsconfig.json")).toBe(true);
752
-
753
- const tsconfigJson = JSON.parse(
754
- fs.readFileSync("../../tsconfig.json", "utf-8")
755
- );
756
- expect(tsconfigJson.compilerOptions).toEqual({});
757
- });
758
-
759
- it("should initialize with no interactive prompts if `--yes` is used", async () => {
760
- await runWrangler("init --yes");
761
-
762
- expect(fs.existsSync("./src/index.js")).toBe(false);
763
- expect(fs.existsSync("./src/index.ts")).toBe(true);
764
- expect(fs.existsSync("./tsconfig.json")).toBe(true);
765
- expect(fs.existsSync("./package.json")).toBe(true);
766
- expect(fs.existsSync("./wrangler.toml")).toBe(true);
181
+ it("no subcommand 'kv:bulk' should display a list of available subcommands", async () => {
182
+ await runWrangler("kv:bulk");
183
+ await endEventLoop();
767
184
  expect(std.out).toMatchInlineSnapshot(`
768
- "✨ Successfully created wrangler.toml
769
- ✨ Created package.json
770
- ✨ Created tsconfig.json, installed @cloudflare/workers-types into devDependencies
771
- ✨ Created src/index.ts
185
+ "wrangler kv:bulk
772
186
 
773
- To start developing your Worker, run \`npm start\`
774
- To publish your Worker to the Internet, run \`npm run publish\`"
775
- `);
776
- expect(std.err).toMatchInlineSnapshot(`""`);
777
- expect(std.warn).toMatchInlineSnapshot(`""`);
778
- });
187
+ 💪 Interact with multiple Workers KV key-value pairs at once
779
188
 
780
- it("should initialize with no interactive prompts if `--yes` is used (named worker)", async () => {
781
- await runWrangler("init my-worker --yes");
782
-
783
- expect(fs.existsSync("./my-worker/src/index.js")).toBe(false);
784
- expect(fs.existsSync("./my-worker/src/index.ts")).toBe(true);
785
- expect(fs.existsSync("./my-worker/tsconfig.json")).toBe(true);
786
- expect(fs.existsSync("./my-worker/package.json")).toBe(true);
787
- expect(fs.existsSync("./my-worker/wrangler.toml")).toBe(true);
788
- const parsedWranglerToml = TOML.parse(
789
- fs.readFileSync("./my-worker/wrangler.toml", "utf-8")
790
- );
791
- expect(parsedWranglerToml.main).toEqual("src/index.ts");
792
- expect(std.out).toMatchInlineSnapshot(`
793
- "✨ Successfully created wrangler.toml
794
- ✨ Created package.json
795
- ✨ Created tsconfig.json, installed @cloudflare/workers-types into devDependencies
796
- ✨ Created src/index.ts
189
+ Commands:
190
+ wrangler kv:bulk put <filename> Upload multiple key-value pairs to a namespace
191
+ wrangler kv:bulk delete <filename> Delete multiple key-value pairs from a namespace
797
192
 
798
- To start developing your Worker, run \`cd my-worker && npm start\`
799
- To publish your Worker to the Internet, run \`npm run publish\`"
193
+ Flags:
194
+ -c, --config Path to .toml configuration file [string]
195
+ -h, --help Show help [boolean]
196
+ -v, --version Show version number [boolean]"
800
197
  `);
801
- expect(std.err).toMatchInlineSnapshot(`""`);
802
- expect(std.warn).toMatchInlineSnapshot(`""`);
803
- });
804
-
805
- it("should initialize with no interactive prompts if `-y` is used", async () => {
806
- await runWrangler("init -y");
807
-
808
- expect(fs.existsSync("./src/index.js")).toBe(false);
809
- expect(fs.existsSync("./src/index.ts")).toBe(true);
810
- expect(fs.existsSync("./tsconfig.json")).toBe(true);
811
- expect(fs.existsSync("./package.json")).toBe(true);
812
- expect(fs.existsSync("./wrangler.toml")).toBe(true);
813
- });
814
-
815
- it("should error if `--type` is used", async () => {
816
- await expect(
817
- runWrangler("init --type")
818
- ).rejects.toThrowErrorMatchingInlineSnapshot(
819
- `"The --type option is no longer supported."`
820
- );
821
198
  });
199
+ it("no subcommand 'r2' should display a list of available subcommands", async () => {
200
+ await runWrangler("r2");
201
+ await endEventLoop();
202
+ expect(std.out).toMatchInlineSnapshot(`
203
+ "wrangler r2
822
204
 
823
- it("should error if `--type javascript` is used", async () => {
824
- await expect(
825
- runWrangler("init --type javascript")
826
- ).rejects.toThrowErrorMatchingInlineSnapshot(
827
- `"The --type option is no longer supported."`
828
- );
829
- });
205
+ 📦 Interact with an R2 store
830
206
 
831
- it("should error if `--type rust` is used", async () => {
832
- await expect(
833
- runWrangler("init --type rust")
834
- ).rejects.toThrowErrorMatchingInlineSnapshot(
835
- `"The --type option is no longer supported."`
836
- );
837
- });
207
+ Commands:
208
+ wrangler r2 bucket Manage R2 buckets
838
209
 
839
- it("should error if `--type webpack` is used", async () => {
840
- await expect(runWrangler("init --type webpack")).rejects
841
- .toThrowErrorMatchingInlineSnapshot(`
842
- "The --type option is no longer supported.
843
- If you wish to use webpack then you will need to create a custom build."
844
- `);
210
+ Flags:
211
+ -c, --config Path to .toml configuration file [string]
212
+ -h, --help Show help [boolean]
213
+ -v, --version Show version number [boolean]"
214
+ `);
845
215
  });
846
216
  });
847
-
848
- describe("preview", () => {
849
- it("should throw an error if the deprecated command is used with positional arguments", async () => {
850
- await expect(runWrangler("preview GET")).rejects
851
- .toThrowErrorMatchingInlineSnapshot(`
852
- "DEPRECATION WARNING:
853
- The \`wrangler preview\` command has been deprecated.
854
- Try using \`wrangler dev\` to to try out a worker during development.
855
- "
856
- `);
857
- await expect(runWrangler("preview GET 'Some Body'")).rejects
858
- .toThrowErrorMatchingInlineSnapshot(`
859
- "DEPRECATION WARNING:
860
- The \`wrangler preview\` command has been deprecated.
861
- Try using \`wrangler dev\` to to try out a worker during development.
862
- "
863
- `);
217
+ describe("Deprecated commands", () => {
218
+ it("should print a deprecation message for 'generate'", async () => {
219
+ await runWrangler("generate").catch((err) => {
220
+ expect(err.message).toMatchInlineSnapshot(`
221
+ "Deprecation:
222
+ \`wrangler generate\` has been deprecated.
223
+ Try running \`wrangler init\` to generate a basic Worker, or cloning the template repository instead:
224
+
225
+ \`\`\`
226
+ git clone https://github.com/cloudflare/worker-template
227
+ \`\`\`
228
+
229
+ Please refer to https://developers.cloudflare.com/workers/wrangler/deprecations/#generate for more information."
230
+ `);
231
+ });
232
+ });
233
+ it("should print a deprecation message for 'build'", async () => {
234
+ await runWrangler("build").catch((err) => {
235
+ expect(err.message).toMatchInlineSnapshot(`
236
+ "Deprecation:
237
+ \`wrangler build\` has been deprecated, please refer to https://github.com/cloudflare/wrangler2/blob/main/docs/deprecations.md#build for alternatives"
238
+ `);
239
+ });
864
240
  });
865
241
  });
866
242
  });