wrangler 0.0.0-e9307365 → 0.0.0-e94b46ff7

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 (199) hide show
  1. package/README.md +35 -49
  2. package/bin/wrangler.js +25 -100
  3. package/config-schema.json +2277 -0
  4. package/package.json +182 -172
  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-patch-console-prefix.d.ts +3 -0
  22. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  23. package/templates/middleware/middleware-pretty-error.ts +40 -0
  24. package/templates/middleware/middleware-scheduled.ts +29 -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 +33 -0
  30. package/templates/pages-dev-util.ts +55 -0
  31. package/templates/pages-shim.ts +1 -1
  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 +12 -102
  39. package/templates/tsconfig.tsbuildinfo +1 -0
  40. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +238 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +26533 -167
  45. package/wrangler-dist/cli.js +146609 -141820
  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 -5416
  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 -4022
  55. package/src/__tests__/dev.test.tsx +0 -1294
  56. package/src/__tests__/generate.test.ts +0 -93
  57. package/src/__tests__/guess-worker-format.test.ts +0 -85
  58. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  59. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  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 -263
  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 -38
  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 -163
  77. package/src/__tests__/index.test.ts +0 -245
  78. package/src/__tests__/init.test.ts +0 -1992
  79. package/src/__tests__/jest.setup.ts +0 -150
  80. package/src/__tests__/kv.test.ts +0 -1671
  81. package/src/__tests__/logger.test.ts +0 -141
  82. package/src/__tests__/metrics.test.ts +0 -450
  83. package/src/__tests__/package-manager.test.ts +0 -353
  84. package/src/__tests__/pages.test.ts +0 -1261
  85. package/src/__tests__/parse.test.ts +0 -330
  86. package/src/__tests__/publish.test.ts +0 -6914
  87. package/src/__tests__/pubsub.test.ts +0 -367
  88. package/src/__tests__/r2.test.ts +0 -317
  89. package/src/__tests__/route.test.ts +0 -45
  90. package/src/__tests__/secret.test.ts +0 -492
  91. package/src/__tests__/tail.test.ts +0 -698
  92. package/src/__tests__/test-old-node-version.js +0 -31
  93. package/src/__tests__/user.test.ts +0 -144
  94. package/src/__tests__/validate-dev-props.test.ts +0 -56
  95. package/src/__tests__/version.test.ts +0 -35
  96. package/src/__tests__/whoami.test.tsx +0 -289
  97. package/src/__tests__/worker-namespace.test.ts +0 -327
  98. package/src/abort.d.ts +0 -3
  99. package/src/api/dev.ts +0 -86
  100. package/src/api/index.ts +0 -1
  101. package/src/bundle-reporter.tsx +0 -29
  102. package/src/bundle.ts +0 -472
  103. package/src/cfetch/index.ts +0 -121
  104. package/src/cfetch/internal.ts +0 -181
  105. package/src/cli.ts +0 -27
  106. package/src/config/README.md +0 -107
  107. package/src/config/config.ts +0 -263
  108. package/src/config/diagnostics.ts +0 -80
  109. package/src/config/environment.ts +0 -485
  110. package/src/config/index.ts +0 -251
  111. package/src/config/validation-helpers.ts +0 -584
  112. package/src/config/validation.ts +0 -1856
  113. package/src/config-cache.ts +0 -84
  114. package/src/create-worker-preview.ts +0 -257
  115. package/src/create-worker-upload-form.ts +0 -288
  116. package/src/dev/dev-vars.ts +0 -36
  117. package/src/dev/dev.tsx +0 -531
  118. package/src/dev/local.tsx +0 -385
  119. package/src/dev/remote.tsx +0 -413
  120. package/src/dev/use-esbuild.ts +0 -175
  121. package/src/dev/validate-dev-props.ts +0 -31
  122. package/src/dev-registry.tsx +0 -157
  123. package/src/dev.tsx +0 -616
  124. package/src/dialogs.tsx +0 -135
  125. package/src/durable.ts +0 -102
  126. package/src/entry.ts +0 -328
  127. package/src/environment-variables.ts +0 -35
  128. package/src/errors.ts +0 -11
  129. package/src/faye-websocket.d.ts +0 -6
  130. package/src/generate.ts +0 -131
  131. package/src/git-client.ts +0 -42
  132. package/src/global-wrangler-config-path.ts +0 -26
  133. package/src/https-options.ts +0 -127
  134. package/src/index.tsx +0 -2184
  135. package/src/init.ts +0 -549
  136. package/src/inspect.ts +0 -750
  137. package/src/intl-polyfill.d.ts +0 -139
  138. package/src/is-interactive.ts +0 -12
  139. package/src/kv.ts +0 -430
  140. package/src/logger.ts +0 -73
  141. package/src/metrics/index.ts +0 -5
  142. package/src/metrics/is-ci.ts +0 -14
  143. package/src/metrics/metrics-config.ts +0 -239
  144. package/src/metrics/metrics-dispatcher.ts +0 -96
  145. package/src/metrics/metrics-usage-headers.ts +0 -24
  146. package/src/metrics/send-event.ts +0 -92
  147. package/src/miniflare-cli/README.md +0 -30
  148. package/src/miniflare-cli/assets.ts +0 -543
  149. package/src/miniflare-cli/enum-keys.ts +0 -17
  150. package/src/miniflare-cli/index.ts +0 -85
  151. package/src/miniflare-cli/request-context.ts +0 -40
  152. package/src/module-collection.ts +0 -258
  153. package/src/open-in-browser.ts +0 -17
  154. package/src/package-manager.ts +0 -219
  155. package/src/pages/build.tsx +0 -204
  156. package/src/pages/constants.ts +0 -8
  157. package/src/pages/deployments.tsx +0 -106
  158. package/src/pages/dev.tsx +0 -414
  159. package/src/pages/functions/buildPlugin.ts +0 -105
  160. package/src/pages/functions/buildWorker.ts +0 -151
  161. package/src/pages/functions/filepath-routing.test.ts +0 -234
  162. package/src/pages/functions/filepath-routing.ts +0 -189
  163. package/src/pages/functions/identifiers.ts +0 -78
  164. package/src/pages/functions/routes.ts +0 -151
  165. package/src/pages/index.tsx +0 -84
  166. package/src/pages/projects.tsx +0 -163
  167. package/src/pages/publish.tsx +0 -338
  168. package/src/pages/types.ts +0 -40
  169. package/src/pages/upload.tsx +0 -415
  170. package/src/pages/utils.ts +0 -12
  171. package/src/parse.ts +0 -286
  172. package/src/paths.ts +0 -26
  173. package/src/preview.ts +0 -31
  174. package/src/proxy.ts +0 -476
  175. package/src/publish.ts +0 -807
  176. package/src/pubsub/index.ts +0 -286
  177. package/src/pubsub/pubsub-commands.tsx +0 -623
  178. package/src/r2.ts +0 -118
  179. package/src/selfsigned.d.ts +0 -29
  180. package/src/sites.tsx +0 -372
  181. package/src/tail/filters.ts +0 -279
  182. package/src/tail/index.ts +0 -299
  183. package/src/tail/printing.ts +0 -67
  184. package/src/update-check.ts +0 -19
  185. package/src/user/choose-account.tsx +0 -69
  186. package/src/user/env-vars.ts +0 -46
  187. package/src/user/generate-auth-url.ts +0 -33
  188. package/src/user/generate-random-state.ts +0 -16
  189. package/src/user/index.ts +0 -3
  190. package/src/user/user.tsx +0 -1189
  191. package/src/whoami.tsx +0 -169
  192. package/src/worker-namespace.ts +0 -206
  193. package/src/worker.ts +0 -203
  194. package/src/zones.ts +0 -76
  195. package/templates/first-party-worker-module-facade.ts +0 -18
  196. package/templates/format-dev-errors.ts +0 -32
  197. package/templates/serve-static-assets.ts +0 -63
  198. package/templates/service-bindings-module-facade.js +0 -51
  199. package/templates/service-bindings-sw-facade.js +0 -39
@@ -1,1992 +0,0 @@
1
- import * as fs from "node:fs";
2
- import path from "node:path";
3
- import * as TOML from "@iarna/toml";
4
- import { execa, execaSync } from "execa";
5
- import { parseConfigFileTextToJson } from "typescript";
6
- import { version as wranglerVersion } from "../../package.json";
7
- import { getPackageManager } from "../package-manager";
8
- import { mockConsoleMethods } from "./helpers/mock-console";
9
- import {
10
- mockConfirm,
11
- clearConfirmMocks,
12
- mockSelect,
13
- clearSelectMocks,
14
- } from "./helpers/mock-dialogs";
15
- import { runInTempDir } from "./helpers/run-in-tmp";
16
- import { runWrangler } from "./helpers/run-wrangler";
17
- import type { PackageManager } from "../package-manager";
18
-
19
- /**
20
- * An expectation matcher for the minimal generated wrangler.toml.
21
- */
22
- const MINIMAL_WRANGLER_TOML = {
23
- compatibility_date: expect.any(String),
24
- name: expect.stringContaining("wrangler-tests"),
25
- main: "src/index.ts",
26
- };
27
-
28
- describe("init", () => {
29
- let mockPackageManager: PackageManager;
30
- runInTempDir();
31
-
32
- beforeEach(() => {
33
- mockPackageManager = {
34
- cwd: process.cwd(),
35
- // @ts-expect-error we're making a fake package manager here
36
- type: "mockpm",
37
- addDevDeps: jest.fn(),
38
- install: jest.fn(),
39
- };
40
- (getPackageManager as jest.Mock).mockResolvedValue(mockPackageManager);
41
- });
42
-
43
- afterEach(() => {
44
- clearConfirmMocks();
45
- clearSelectMocks();
46
- });
47
-
48
- const std = mockConsoleMethods();
49
-
50
- describe("options", () => {
51
- it("should initialize with no interactive prompts if `--yes` is used", async () => {
52
- await runWrangler("init --yes");
53
-
54
- checkFiles({
55
- items: {
56
- "./src/index.js": false,
57
- "./src/index.ts": true,
58
- "./tsconfig.json": true,
59
- "./package.json": true,
60
- "./wrangler.toml": true,
61
- },
62
- });
63
-
64
- expect(std.out).toMatchInlineSnapshot(`
65
- "✨ Created wrangler.toml
66
- ✨ Initialized git repository
67
- ✨ Created package.json
68
- ✨ Created tsconfig.json
69
- ✨ Created src/index.ts
70
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
71
-
72
- To start developing your Worker, run \`npm start\`
73
- To publish your Worker to the Internet, run \`npm run deploy\`"
74
- `);
75
- expect(std.err).toMatchInlineSnapshot(`""`);
76
- expect(std.warn).toMatchInlineSnapshot(`""`);
77
- });
78
-
79
- it("should initialize with no interactive prompts if `--yes` is used (named worker)", async () => {
80
- await runWrangler("init my-worker --yes");
81
-
82
- checkFiles({
83
- items: {
84
- "./my-worker/src/index.js": false,
85
- "./my-worker/src/index.ts": true,
86
- "./my-worker/tsconfig.json": true,
87
- "./my-worker/package.json": true,
88
- "./my-worker/wrangler.toml": wranglerToml({
89
- ...MINIMAL_WRANGLER_TOML,
90
- name: "my-worker",
91
- }),
92
- },
93
- });
94
-
95
- expect(std.out).toMatchInlineSnapshot(`
96
- "✨ Created my-worker/wrangler.toml
97
- ✨ Initialized git repository at my-worker
98
- ✨ Created my-worker/package.json
99
- ✨ Created my-worker/tsconfig.json
100
- ✨ Created my-worker/src/index.ts
101
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
102
-
103
- To start developing your Worker, run \`cd my-worker && npm start\`
104
- To publish your Worker to the Internet, run \`npm run deploy\`"
105
- `);
106
- expect(std.err).toMatchInlineSnapshot(`""`);
107
- expect(std.warn).toMatchInlineSnapshot(`""`);
108
- });
109
-
110
- it("should initialize with no interactive prompts if `-y` is used", async () => {
111
- await runWrangler("init -y");
112
-
113
- checkFiles({
114
- items: {
115
- "./src/index.js": false,
116
- "./src/index.ts": true,
117
- "./tsconfig.json": true,
118
- "./package.json": true,
119
- "./wrangler.toml": true,
120
- },
121
- });
122
-
123
- expect(std).toMatchInlineSnapshot(`
124
- Object {
125
- "debug": "",
126
- "err": "",
127
- "out": "✨ Created wrangler.toml
128
- ✨ Initialized git repository
129
- ✨ Created package.json
130
- ✨ Created tsconfig.json
131
- ✨ Created src/index.ts
132
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
133
-
134
- To start developing your Worker, run \`npm start\`
135
- To publish your Worker to the Internet, run \`npm run deploy\`",
136
- "warn": "",
137
- }
138
- `);
139
- });
140
-
141
- it("should error if `--type javascript` is used", async () => {
142
- await expect(
143
- runWrangler("init --type javascript")
144
- ).rejects.toThrowErrorMatchingInlineSnapshot(
145
- `"The --type option is no longer supported."`
146
- );
147
- });
148
-
149
- it("should error if `--type rust` is used", async () => {
150
- await expect(
151
- runWrangler("init --type rust")
152
- ).rejects.toThrowErrorMatchingInlineSnapshot(
153
- `"The --type option is no longer supported."`
154
- );
155
- });
156
-
157
- it("should error if `--type webpack` is used", async () => {
158
- await expect(runWrangler("init --type webpack")).rejects
159
- .toThrowErrorMatchingInlineSnapshot(`
160
- "The --type option is no longer supported.
161
- If you wish to use webpack then you will need to create a custom build."
162
- `);
163
- });
164
-
165
- it("should error if `--site` is used", async () => {
166
- await expect(runWrangler("init --site")).rejects
167
- .toThrowErrorMatchingInlineSnapshot(`
168
- "The --site option is no longer supported.
169
- If you wish to create a brand new Worker Sites project then clone the \`worker-sites-template\` starter repository:
170
-
171
- \`\`\`
172
- git clone --depth=1 --branch=wrangler2 https://github.com/cloudflare/worker-sites-template my-site
173
- cd my-site
174
- \`\`\`
175
-
176
- Find out more about how to create and maintain Sites projects at https://developers.cloudflare.com/workers/platform/sites.
177
- Have you considered using Cloudflare Pages instead? See https://pages.cloudflare.com/."
178
- `);
179
- });
180
- });
181
-
182
- describe("wrangler.toml", () => {
183
- it("should create a wrangler.toml", async () => {
184
- mockConfirm(
185
- {
186
- text: "Would you like to use git to manage this Worker?",
187
- result: false,
188
- },
189
- {
190
- text: "No package.json found. Would you like to create one?",
191
- result: false,
192
- }
193
- );
194
- await runWrangler("init");
195
- checkFiles({
196
- items: {
197
- "wrangler.toml": wranglerToml({
198
- compatibility_date: expect.any(String),
199
- name: expect.stringContaining("wrangler-tests"),
200
- }),
201
- "package.json": false,
202
- "tsconfig.json": false,
203
- },
204
- });
205
-
206
- expect(std).toMatchInlineSnapshot(`
207
- Object {
208
- "debug": "",
209
- "err": "",
210
- "out": "✨ Created wrangler.toml",
211
- "warn": "",
212
- }
213
- `);
214
- });
215
-
216
- it("should create a wrangler.toml and a directory for a named Worker ", async () => {
217
- mockConfirm(
218
- {
219
- text: "Would you like to use git to manage this Worker?",
220
- result: false,
221
- },
222
- {
223
- text: "No package.json found. Would you like to create one?",
224
- result: false,
225
- }
226
- );
227
- await runWrangler("init my-worker");
228
-
229
- checkFiles({
230
- items: {
231
- "my-worker/wrangler.toml": wranglerToml({
232
- compatibility_date: expect.any(String),
233
- name: "my-worker",
234
- }),
235
- "my-worker/package.json": false,
236
- "my-worker/tsconfig.json": false,
237
- },
238
- });
239
-
240
- expect(std).toMatchInlineSnapshot(`
241
- Object {
242
- "debug": "",
243
- "err": "",
244
- "out": "✨ Created my-worker/wrangler.toml",
245
- "warn": "",
246
- }
247
- `);
248
- });
249
-
250
- it("should display warning when wrangler.toml already exists, and exit if user does not want to carry on", async () => {
251
- writeFiles({
252
- items: {
253
- "wrangler.toml": wranglerToml({
254
- // use a fake value to make sure the file is not overwritten
255
- compatibility_date: "something-else",
256
- }),
257
- },
258
- });
259
-
260
- mockConfirm({
261
- text: "Do you want to continue initializing this project?",
262
- result: false,
263
- });
264
-
265
- await runWrangler("init");
266
- expect(std.warn).toContain("wrangler.toml already exists!");
267
-
268
- checkFiles({
269
- items: {
270
- "wrangler.toml": wranglerToml({
271
- compatibility_date: "something-else",
272
- }),
273
- "package.json": false,
274
- "tsconfig.json": false,
275
- },
276
- });
277
-
278
- expect(std).toMatchInlineSnapshot(`
279
- Object {
280
- "debug": "",
281
- "err": "",
282
- "out": "",
283
- "warn": "▲ [WARNING] wrangler.toml already exists!
284
-
285
- ",
286
- }
287
- `);
288
- });
289
-
290
- it("should display warning when wrangler.toml already exists in the target directory, and exit if user does not want to carry on", async () => {
291
- writeFiles({
292
- items: {
293
- "path/to/worker/wrangler.toml": wranglerToml({
294
- compatibility_date: "something-else",
295
- }),
296
- },
297
- });
298
- mockConfirm({
299
- text: "Do you want to continue initializing this project?",
300
- result: false,
301
- });
302
-
303
- await runWrangler("init path/to/worker");
304
-
305
- expect(std.warn).toContain("wrangler.toml already exists!");
306
- checkFiles({
307
- items: {
308
- "path/to/worker/wrangler.toml": wranglerToml({
309
- compatibility_date: "something-else",
310
- }),
311
- "package.json": false,
312
- "tsconfig.json": false,
313
- },
314
- });
315
- expect(std).toMatchInlineSnapshot(`
316
- Object {
317
- "debug": "",
318
- "err": "",
319
- "out": "",
320
- "warn": "▲ [WARNING] path/to/worker/wrangler.toml already exists!
321
-
322
- ",
323
- }
324
- `);
325
- });
326
-
327
- it("should not overwrite an existing wrangler.toml, after agreeing to other prompts", async () => {
328
- writeFiles({
329
- items: {
330
- "wrangler.toml": wranglerToml({
331
- compatibility_date: "something-else",
332
- }),
333
- },
334
- });
335
- mockConfirm(
336
- {
337
- text: "Would you like to use git to manage this Worker?",
338
- result: true,
339
- },
340
- {
341
- text: "Do you want to continue initializing this project?",
342
- result: true,
343
- },
344
- {
345
- text: "No package.json found. Would you like to create one?",
346
- result: true,
347
- },
348
- {
349
- text: "Would you like to use TypeScript?",
350
- result: true,
351
- }
352
- );
353
-
354
- mockSelect({
355
- text: "Would you like to create a Worker at src/index.ts?",
356
- result: "fetch",
357
- });
358
-
359
- await runWrangler("init");
360
-
361
- checkFiles({
362
- items: {
363
- "wrangler.toml": wranglerToml({
364
- compatibility_date: "something-else",
365
- }),
366
- },
367
- });
368
- });
369
-
370
- it("should display warning when wrangler.toml already exists, but continue if user does want to carry on", async () => {
371
- writeFiles({
372
- items: {
373
- "wrangler.toml": wranglerToml({
374
- compatibility_date: "something-else",
375
- }),
376
- },
377
- });
378
- mockConfirm(
379
- {
380
- text: "Do you want to continue initializing this project?",
381
- result: true,
382
- },
383
- {
384
- text: "Would you like to use git to manage this Worker?",
385
- result: false,
386
- },
387
- {
388
- text: "No package.json found. Would you like to create one?",
389
- result: false,
390
- }
391
- );
392
-
393
- await runWrangler("init");
394
-
395
- expect(std.warn).toContain("wrangler.toml already exists!");
396
- checkFiles({
397
- items: {
398
- "wrangler.toml": wranglerToml({
399
- compatibility_date: "something-else",
400
- }),
401
- },
402
- });
403
- expect(std).toMatchInlineSnapshot(`
404
- Object {
405
- "debug": "",
406
- "err": "",
407
- "out": "",
408
- "warn": "▲ [WARNING] wrangler.toml already exists!
409
-
410
- ",
411
- }
412
- `);
413
- });
414
-
415
- it("should not add a Cron Trigger to wrangler.toml when creating a Scheduled Worker if wrangler.toml already exists", async () => {
416
- writeFiles({
417
- items: {
418
- "wrangler.toml": wranglerToml({
419
- compatibility_date: "something-else",
420
- }),
421
- },
422
- });
423
- mockConfirm(
424
- {
425
- text: "Would you like to use git to manage this Worker?",
426
- result: true,
427
- },
428
- {
429
- text: "Do you want to continue initializing this project?",
430
- result: true,
431
- },
432
- {
433
- text: "No package.json found. Would you like to create one?",
434
- result: true,
435
- },
436
- {
437
- text: "Would you like to use TypeScript?",
438
- result: true,
439
- }
440
- );
441
- mockSelect({
442
- text: "Would you like to create a Worker at src/index.ts?",
443
- result: "scheduled",
444
- });
445
-
446
- await runWrangler("init");
447
-
448
- checkFiles({
449
- items: {
450
- "wrangler.toml": wranglerToml({
451
- compatibility_date: "something-else",
452
- }),
453
- },
454
- });
455
- });
456
-
457
- it("should add a Cron Trigger to wrangler.toml when creating a Scheduled Worker, but only if wrangler.toml is being created during init", async () => {
458
- mockConfirm(
459
- {
460
- text: "Would you like to use git to manage this Worker?",
461
- result: true,
462
- },
463
- {
464
- text: "No package.json found. Would you like to create one?",
465
- result: true,
466
- },
467
- {
468
- text: "Would you like to use TypeScript?",
469
- result: true,
470
- }
471
- );
472
- mockSelect({
473
- text: "Would you like to create a Worker at src/index.ts?",
474
- result: "scheduled",
475
- });
476
-
477
- await runWrangler("init");
478
-
479
- checkFiles({
480
- items: {
481
- "wrangler.toml": wranglerToml({
482
- ...MINIMAL_WRANGLER_TOML,
483
- triggers: { crons: ["1 * * * *"] },
484
- }),
485
- },
486
- });
487
- });
488
- });
489
-
490
- describe("git init", () => {
491
- it("should offer to initialize a git repository", async () => {
492
- mockConfirm(
493
- {
494
- text: "Would you like to use git to manage this Worker?",
495
- result: true,
496
- },
497
- {
498
- text: "No package.json found. Would you like to create one?",
499
- result: false,
500
- }
501
- );
502
-
503
- await runWrangler("init");
504
-
505
- checkFiles({
506
- items: {
507
- "wrangler.toml": wranglerToml({
508
- compatibility_date: expect.any(String),
509
- name: expect.stringContaining("wrangler-tests"),
510
- }),
511
- ".git": { items: {} },
512
- ".gitignore": true,
513
- },
514
- });
515
- expect(std).toMatchInlineSnapshot(`
516
- Object {
517
- "debug": "",
518
- "err": "",
519
- "out": "✨ Created wrangler.toml
520
- ✨ Initialized git repository",
521
- "warn": "",
522
- }
523
- `);
524
- expect((await execa("git", ["branch", "--show-current"])).stdout).toEqual(
525
- "main"
526
- );
527
- });
528
-
529
- it("should not offer to initialize a git repo if it's already inside one", async () => {
530
- await execa("git", ["init"]);
531
- setWorkingDirectory("some-folder");
532
-
533
- await runWrangler("init -y");
534
-
535
- checkFiles({
536
- items: {
537
- "wrangler.toml": wranglerToml({
538
- ...MINIMAL_WRANGLER_TOML,
539
- name: "some-folder",
540
- }),
541
- ".git": { items: {} },
542
- ".gitignore": false,
543
- },
544
- });
545
-
546
- // Note the lack of "✨ Initialized git repository" in the log
547
- expect(std).toMatchInlineSnapshot(`
548
- Object {
549
- "debug": "",
550
- "err": "",
551
- "out": "✨ Created wrangler.toml
552
- ✨ Created package.json
553
- ✨ Created tsconfig.json
554
- ✨ Created src/index.ts
555
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
556
-
557
- To start developing your Worker, run \`npm start\`
558
- To publish your Worker to the Internet, run \`npm run deploy\`",
559
- "warn": "",
560
- }
561
- `);
562
- });
563
-
564
- it("should not offer to initialize a git repo if it's already inside one (when using a path as name)", async () => {
565
- fs.mkdirSync("path/to/worker", { recursive: true });
566
- await execa("git", ["init"], { cwd: "path/to/worker" });
567
- expect(fs.lstatSync("path/to/worker/.git").isDirectory()).toBe(true);
568
-
569
- await runWrangler("init path/to/worker/my-worker -y");
570
-
571
- // Note the lack of "✨ Initialized git repository" in the log
572
- expect(std).toMatchInlineSnapshot(`
573
- Object {
574
- "debug": "",
575
- "err": "",
576
- "out": "✨ Created path/to/worker/my-worker/wrangler.toml
577
- ✨ Created path/to/worker/my-worker/package.json
578
- ✨ Created path/to/worker/my-worker/tsconfig.json
579
- ✨ Created path/to/worker/my-worker/src/index.ts
580
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
581
-
582
- To start developing your Worker, run \`cd path/to/worker/my-worker && npm start\`
583
- To publish your Worker to the Internet, run \`npm run deploy\`",
584
- "warn": "",
585
- }
586
- `);
587
- });
588
-
589
- // I... don't know how to test this lol
590
- it.todo(
591
- "should not offer to initialize a git repo if git is not installed"
592
- );
593
-
594
- it("should initialize git repo with `main` default branch", async () => {
595
- mockConfirm(
596
- {
597
- text: "Would you like to use git to manage this Worker?",
598
- result: true,
599
- },
600
- {
601
- text: "No package.json found. Would you like to create one?",
602
- result: false,
603
- }
604
- );
605
- await runWrangler("init");
606
- expect(std).toMatchInlineSnapshot(`
607
- Object {
608
- "debug": "",
609
- "err": "",
610
- "out": "✨ Created wrangler.toml
611
- ✨ Initialized git repository",
612
- "warn": "",
613
- }
614
- `);
615
-
616
- expect(execaSync("git", ["symbolic-ref", "HEAD"]).stdout).toEqual(
617
- "refs/heads/main"
618
- );
619
- });
620
- });
621
-
622
- describe("package.json", () => {
623
- it("should create a package.json if none is found and user confirms", async () => {
624
- mockConfirm(
625
- {
626
- text: "Would you like to use git to manage this Worker?",
627
- result: false,
628
- },
629
- {
630
- text: "No package.json found. Would you like to create one?",
631
- result: true,
632
- },
633
- {
634
- text: "Would you like to use TypeScript?",
635
- result: false,
636
- }
637
- );
638
- mockSelect({
639
- text: "Would you like to create a Worker at src/index.js?",
640
- result: "none",
641
- });
642
-
643
- await runWrangler("init");
644
-
645
- checkFiles({
646
- items: {
647
- "package.json": {
648
- contents: expect.objectContaining({
649
- name: expect.stringContaining("wrangler-tests"),
650
- version: "0.0.0",
651
- devDependencies: {
652
- wrangler: expect.any(String),
653
- },
654
- }),
655
- },
656
- "tsconfig.json": false,
657
- },
658
- });
659
- expect(mockPackageManager.install).toHaveBeenCalled();
660
- expect(std).toMatchInlineSnapshot(`
661
- Object {
662
- "debug": "",
663
- "err": "",
664
- "out": "✨ Created wrangler.toml
665
- ✨ Created package.json",
666
- "warn": "",
667
- }
668
- `);
669
- });
670
-
671
- it("should create a package.json, with the specified name, if none is found and user confirms", async () => {
672
- mockConfirm(
673
- {
674
- text: "Would you like to use git to manage this Worker?",
675
- result: false,
676
- },
677
- {
678
- text: "No package.json found. Would you like to create one?",
679
- result: true,
680
- },
681
- {
682
- text: "Would you like to use TypeScript?",
683
- result: false,
684
- }
685
- );
686
- mockSelect({
687
- text: "Would you like to create a Worker at my-worker/src/index.js?",
688
- result: "none",
689
- });
690
-
691
- await runWrangler("init my-worker");
692
-
693
- checkFiles({
694
- items: {
695
- "my-worker/package.json": {
696
- contents: expect.objectContaining({
697
- name: "my-worker",
698
- version: "0.0.0",
699
- devDependencies: {
700
- wrangler: expect.any(String),
701
- },
702
- }),
703
- },
704
- "my-worker/tsconfig.json": false,
705
- },
706
- });
707
- expect(std).toMatchInlineSnapshot(`
708
- Object {
709
- "debug": "",
710
- "err": "",
711
- "out": "✨ Created my-worker/wrangler.toml
712
- ✨ Created my-worker/package.json",
713
- "warn": "",
714
- }
715
- `);
716
- });
717
-
718
- it("should not touch an existing package.json in the same directory", async () => {
719
- mockConfirm(
720
- {
721
- text: "Would you like to use git to manage this Worker?",
722
- result: false,
723
- },
724
- {
725
- text: "Would you like to install wrangler into package.json?",
726
- result: false,
727
- },
728
- {
729
- text: "Would you like to use TypeScript?",
730
- result: false,
731
- }
732
- );
733
- mockSelect({
734
- text: "Would you like to create a Worker at src/index.js?",
735
- result: "none",
736
- });
737
- writeFiles({
738
- items: {
739
- "package.json": { contents: { name: "test", version: "1.0.0" } },
740
- },
741
- });
742
-
743
- await runWrangler("init");
744
-
745
- checkFiles({
746
- items: {
747
- "package.json": { contents: { name: "test", version: "1.0.0" } },
748
- },
749
- });
750
- expect(std).toMatchInlineSnapshot(`
751
- Object {
752
- "debug": "",
753
- "err": "",
754
- "out": "✨ Created wrangler.toml",
755
- "warn": "",
756
- }
757
- `);
758
- });
759
-
760
- it("should not touch an existing package.json in an ancestor directory, when a name is passed", async () => {
761
- mockConfirm(
762
- {
763
- text: "Would you like to use git to manage this Worker?",
764
- result: false,
765
- },
766
- {
767
- text: "No package.json found. Would you like to create one?",
768
- result: true,
769
- },
770
- {
771
- text: "Would you like to install wrangler into path/to/worker/my-worker/package.json?",
772
- result: false,
773
- },
774
- {
775
- text: "Would you like to use TypeScript?",
776
- result: false,
777
- }
778
- );
779
- mockSelect({
780
- text: "Would you like to create a Worker at path/to/worker/my-worker/src/index.js?",
781
- result: "none",
782
- });
783
- writeFiles({
784
- items: {
785
- "path/to/worker/package.json": {
786
- contents: { name: "test", version: "1.0.0" },
787
- },
788
- },
789
- });
790
-
791
- await runWrangler("init path/to/worker/my-worker");
792
-
793
- checkFiles({
794
- items: {
795
- "path/to/worker/package.json": {
796
- contents: { name: "test", version: "1.0.0" },
797
- },
798
- },
799
- });
800
- expect(std).toMatchInlineSnapshot(`
801
- Object {
802
- "debug": "",
803
- "err": "",
804
- "out": "✨ Created path/to/worker/my-worker/wrangler.toml
805
- ✨ Created path/to/worker/my-worker/package.json",
806
- "warn": "",
807
- }
808
- `);
809
- });
810
-
811
- it("should offer to install wrangler into an existing package.json", async () => {
812
- mockConfirm(
813
- {
814
- text: "Would you like to use git to manage this Worker?",
815
- result: false,
816
- },
817
- {
818
- text: "Would you like to install wrangler into package.json?",
819
- result: true,
820
- },
821
- {
822
- text: "Would you like to use TypeScript?",
823
- result: false,
824
- }
825
- );
826
- mockSelect({
827
- text: "Would you like to create a Worker at src/index.js?",
828
- result: "none",
829
- });
830
- writeFiles({
831
- items: {
832
- "package.json": {
833
- contents: { name: "test", version: "1.0.0" },
834
- },
835
- },
836
- });
837
-
838
- await runWrangler("init");
839
-
840
- checkFiles({
841
- items: {
842
- "package.json": {
843
- contents: { name: "test", version: "1.0.0" },
844
- },
845
- },
846
- });
847
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
848
- `wrangler@${wranglerVersion}`
849
- );
850
- expect(std).toMatchInlineSnapshot(`
851
- Object {
852
- "debug": "",
853
- "err": "",
854
- "out": "✨ Created wrangler.toml
855
- ✨ Installed wrangler into devDependencies",
856
- "warn": "",
857
- }
858
- `);
859
- });
860
-
861
- it("should offer to install wrangler into a package.json relative to the target directory, if no name is provided", async () => {
862
- mockConfirm(
863
- {
864
- text: "Would you like to use git to manage this Worker?",
865
- result: false,
866
- },
867
- {
868
- text: "Would you like to install wrangler into ../package.json?",
869
- result: true,
870
- },
871
- {
872
- text: "Would you like to use TypeScript?",
873
- result: false,
874
- }
875
- );
876
- mockSelect({
877
- text: "Would you like to create a Worker at src/index.js?",
878
- result: "none",
879
- });
880
- writeFiles({
881
- items: {
882
- "path/to/worker/package.json": {
883
- contents: { name: "test", version: "1.0.0" },
884
- },
885
- },
886
- });
887
- setWorkingDirectory("path/to/worker/my-worker");
888
-
889
- await runWrangler("init");
890
-
891
- setWorkingDirectory("../../../..");
892
- checkFiles({
893
- items: {
894
- "path/to/worker/package.json": {
895
- contents: { name: "test", version: "1.0.0" },
896
- },
897
- "path/to/worker/my-worker/package.json": false,
898
- },
899
- });
900
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
901
- `wrangler@${wranglerVersion}`
902
- );
903
- expect(mockPackageManager.cwd).toBe(process.cwd());
904
- expect(std).toMatchInlineSnapshot(`
905
- Object {
906
- "debug": "",
907
- "err": "",
908
- "out": "✨ Created wrangler.toml
909
- ✨ Installed wrangler into devDependencies",
910
- "warn": "",
911
- }
912
- `);
913
- });
914
-
915
- it("should not touch an existing package.json in an ancestor directory", async () => {
916
- mockConfirm(
917
- {
918
- text: "Would you like to use git to manage this Worker?",
919
- result: false,
920
- },
921
- {
922
- text: "Would you like to install wrangler into ../../package.json?",
923
- result: false,
924
- },
925
- {
926
- text: "Would you like to use TypeScript?",
927
- result: false,
928
- }
929
- );
930
- mockSelect({
931
- text: "Would you like to create a Worker at src/index.js?",
932
- result: "none",
933
- });
934
- writeFiles({
935
- items: {
936
- "package.json": {
937
- contents: { name: "test", version: "1.0.0" },
938
- },
939
- },
940
- });
941
- setWorkingDirectory("./sub-1/sub-2");
942
-
943
- await runWrangler("init");
944
-
945
- checkFiles({
946
- items: {
947
- "package.json": false,
948
- "../../package.json": {
949
- contents: { name: "test", version: "1.0.0" },
950
- },
951
- },
952
- });
953
- expect(std).toMatchInlineSnapshot(`
954
- Object {
955
- "debug": "",
956
- "err": "",
957
- "out": "✨ Created wrangler.toml",
958
- "warn": "",
959
- }
960
- `);
961
- });
962
- });
963
-
964
- describe("typescript", () => {
965
- it("should offer to create a worker in a non-typescript project", async () => {
966
- mockConfirm(
967
- {
968
- text: "Would you like to use git to manage this Worker?",
969
- result: false,
970
- },
971
- {
972
- text: "Would you like to install wrangler into package.json?",
973
- result: false,
974
- },
975
- {
976
- text: "Would you like to use TypeScript?",
977
- result: false,
978
- }
979
- );
980
- mockSelect({
981
- text: "Would you like to create a Worker at src/index.js?",
982
- result: "fetch",
983
- });
984
- writeFiles({
985
- items: {
986
- "package.json": {
987
- contents: { name: "test", version: "1.0.0" },
988
- },
989
- },
990
- });
991
-
992
- await runWrangler("init");
993
-
994
- checkFiles({
995
- items: {
996
- "wrangler.toml": wranglerToml({
997
- ...MINIMAL_WRANGLER_TOML,
998
- main: "src/index.js",
999
- }),
1000
- "src/index.js": true,
1001
- "src/index.ts": false,
1002
- },
1003
- });
1004
- expect(std).toMatchInlineSnapshot(`
1005
- Object {
1006
- "debug": "",
1007
- "err": "",
1008
- "out": "✨ Created wrangler.toml
1009
- ✨ Created src/index.js
1010
-
1011
- To start developing your Worker, run \`npx wrangler dev\`
1012
- To publish your Worker to the Internet, run \`npx wrangler publish\`",
1013
- "warn": "",
1014
- }
1015
- `);
1016
- });
1017
-
1018
- it("should offer to create a worker in a typescript project", async () => {
1019
- mockConfirm(
1020
- {
1021
- text: "Would you like to use git to manage this Worker?",
1022
- result: false,
1023
- },
1024
- {
1025
- text: "Would you like to install wrangler into package.json?",
1026
- result: false,
1027
- },
1028
- {
1029
- text: "Would you like to use TypeScript?",
1030
- result: true,
1031
- }
1032
- );
1033
- mockSelect({
1034
- text: "Would you like to create a Worker at src/index.ts?",
1035
- result: "fetch",
1036
- });
1037
- writeFiles({
1038
- items: {
1039
- "package.json": {
1040
- contents: { name: "test", version: "1.0.0" },
1041
- },
1042
- },
1043
- });
1044
-
1045
- await runWrangler("init");
1046
-
1047
- checkFiles({
1048
- items: {
1049
- "src/index.js": false,
1050
- "src/index.ts": true,
1051
- },
1052
- });
1053
- expect(std).toMatchInlineSnapshot(`
1054
- Object {
1055
- "debug": "",
1056
- "err": "",
1057
- "out": "✨ Created wrangler.toml
1058
- ✨ Created tsconfig.json
1059
- ✨ Created src/index.ts
1060
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1061
-
1062
- To start developing your Worker, run \`npx wrangler dev\`
1063
- To publish your Worker to the Internet, run \`npx wrangler publish\`",
1064
- "warn": "",
1065
- }
1066
- `);
1067
- });
1068
-
1069
- it("should add scripts for a typescript project with .ts extension", async () => {
1070
- mockConfirm(
1071
- {
1072
- text: "Would you like to use git to manage this Worker?",
1073
- result: false,
1074
- },
1075
- {
1076
- text: "No package.json found. Would you like to create one?",
1077
- result: true,
1078
- },
1079
- {
1080
- text: "Would you like to install wrangler into package.json?",
1081
- result: false,
1082
- },
1083
- {
1084
- text: "Would you like to use TypeScript?",
1085
- result: true,
1086
- }
1087
- );
1088
- mockSelect({
1089
- text: "Would you like to create a Worker at src/index.ts?",
1090
- result: "fetch",
1091
- });
1092
-
1093
- await runWrangler("init");
1094
-
1095
- checkFiles({
1096
- items: {
1097
- "package.json": {
1098
- contents: expect.objectContaining({
1099
- name: expect.stringContaining("wrangler-tests"),
1100
- version: "0.0.0",
1101
- scripts: {
1102
- start: "wrangler dev",
1103
- deploy: "wrangler publish",
1104
- },
1105
- }),
1106
- },
1107
- "src/index.js": false,
1108
- "src/index.ts": true,
1109
- },
1110
- });
1111
- expect(std.out).toMatchInlineSnapshot(`
1112
- "✨ Created wrangler.toml
1113
- ✨ Created package.json
1114
- ✨ Created tsconfig.json
1115
- ✨ Created src/index.ts
1116
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1117
-
1118
- To start developing your Worker, run \`npm start\`
1119
- To publish your Worker to the Internet, run \`npm run deploy\`"
1120
- `);
1121
- });
1122
-
1123
- it("should not overwrite package.json scripts for a typescript project", async () => {
1124
- mockConfirm(
1125
- {
1126
- text: "Would you like to use git to manage this Worker?",
1127
- result: false,
1128
- },
1129
- {
1130
- text: "Would you like to install wrangler into package.json?",
1131
- result: false,
1132
- },
1133
- {
1134
- text: "Would you like to use TypeScript?",
1135
- result: true,
1136
- }
1137
- );
1138
- mockSelect({
1139
- text: "Would you like to create a Worker at src/index.ts?",
1140
- result: "fetch",
1141
- });
1142
- writeFiles({
1143
- items: {
1144
- "package.json": {
1145
- contents: {
1146
- scripts: {
1147
- start: "test-start",
1148
- deploy: "test-publish",
1149
- },
1150
- },
1151
- },
1152
- },
1153
- });
1154
-
1155
- await runWrangler("init");
1156
-
1157
- checkFiles({
1158
- items: {
1159
- "package.json": {
1160
- contents: {
1161
- scripts: {
1162
- start: "test-start",
1163
- deploy: "test-publish",
1164
- },
1165
- },
1166
- },
1167
- "src/index.js": false,
1168
- "src/index.ts": true,
1169
- },
1170
- });
1171
- expect(std.out).toMatchInlineSnapshot(`
1172
- "✨ Created wrangler.toml
1173
- ✨ Created tsconfig.json
1174
- ✨ Created src/index.ts
1175
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1176
-
1177
- To start developing your Worker, run \`npx wrangler dev\`
1178
- To publish your Worker to the Internet, run \`npx wrangler publish\`"
1179
- `);
1180
- });
1181
-
1182
- it("should not offer to create a worker in a ts project if a file already exists at the location", async () => {
1183
- mockConfirm(
1184
- {
1185
- text: "Would you like to use git to manage this Worker?",
1186
- result: false,
1187
- },
1188
- {
1189
- text: "Would you like to install wrangler into package.json?",
1190
- result: false,
1191
- },
1192
- {
1193
- text: "Would you like to use TypeScript?",
1194
- result: true,
1195
- }
1196
- );
1197
- const PLACEHOLDER = "/* placeholder text */";
1198
- writeFiles({
1199
- items: {
1200
- "package.json": { contents: { name: "test", version: "1.0.0" } },
1201
- "src/index.ts": { contents: PLACEHOLDER },
1202
- },
1203
- });
1204
-
1205
- await runWrangler("init");
1206
-
1207
- checkFiles({
1208
- items: {
1209
- "src/index.js": false,
1210
- "src/index.ts": { contents: PLACEHOLDER },
1211
- },
1212
- });
1213
- expect(std).toMatchInlineSnapshot(`
1214
- Object {
1215
- "debug": "",
1216
- "err": "",
1217
- "out": "✨ Created wrangler.toml
1218
- ✨ Created tsconfig.json
1219
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies",
1220
- "warn": "",
1221
- }
1222
- `);
1223
- });
1224
-
1225
- it("should not offer to create a worker in a ts project for a named worker if a file already exists at the location", async () => {
1226
- mockConfirm(
1227
- {
1228
- text: "Would you like to use git to manage this Worker?",
1229
- result: false,
1230
- },
1231
- {
1232
- text: "No package.json found. Would you like to create one?",
1233
- result: true,
1234
- },
1235
- {
1236
- text: "Would you like to install wrangler into package.json?",
1237
- result: false,
1238
- },
1239
- {
1240
- text: "Would you like to use TypeScript?",
1241
- result: true,
1242
- }
1243
- );
1244
- const PLACEHOLDER = "/* placeholder text */";
1245
- writeFiles({
1246
- items: {
1247
- "package.json": { contents: { name: "test", version: "1.0.0" } },
1248
- "my-worker/src/index.ts": { contents: PLACEHOLDER },
1249
- },
1250
- });
1251
-
1252
- await runWrangler("init my-worker");
1253
-
1254
- checkFiles({
1255
- items: {
1256
- "my-worker/src/index.js": false,
1257
- "my-worker/src/index.ts": { contents: PLACEHOLDER },
1258
- },
1259
- });
1260
- expect(std).toMatchInlineSnapshot(`
1261
- Object {
1262
- "debug": "",
1263
- "err": "",
1264
- "out": "✨ Created my-worker/wrangler.toml
1265
- ✨ Created my-worker/package.json
1266
- ✨ Created my-worker/tsconfig.json
1267
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies",
1268
- "warn": "",
1269
- }
1270
- `);
1271
- });
1272
-
1273
- it("should create a tsconfig.json and install `workers-types` if none is found and user confirms", async () => {
1274
- mockConfirm(
1275
- {
1276
- text: "Would you like to use git to manage this Worker?",
1277
- result: false,
1278
- },
1279
- {
1280
- text: "No package.json found. Would you like to create one?",
1281
- result: true,
1282
- },
1283
- {
1284
- text: "Would you like to use TypeScript?",
1285
- result: true,
1286
- }
1287
- );
1288
- mockSelect({
1289
- text: "Would you like to create a Worker at src/index.ts?",
1290
- result: "none",
1291
- });
1292
-
1293
- await runWrangler("init");
1294
-
1295
- checkFiles({
1296
- items: {
1297
- "tsconfig.json": {
1298
- contents: {
1299
- config: {
1300
- compilerOptions: expect.objectContaining({
1301
- types: ["@cloudflare/workers-types"],
1302
- }),
1303
- },
1304
- error: undefined,
1305
- },
1306
- },
1307
- },
1308
- });
1309
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
1310
- "@cloudflare/workers-types",
1311
- "typescript"
1312
- );
1313
- expect(std).toMatchInlineSnapshot(`
1314
- Object {
1315
- "debug": "",
1316
- "err": "",
1317
- "out": "✨ Created wrangler.toml
1318
- ✨ Created package.json
1319
- ✨ Created tsconfig.json
1320
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies",
1321
- "warn": "",
1322
- }
1323
- `);
1324
- });
1325
-
1326
- it("should not touch an existing tsconfig.json in the same directory", async () => {
1327
- mockConfirm({
1328
- text: "Would you like to use git to manage this Worker?",
1329
- result: false,
1330
- });
1331
- mockSelect({
1332
- text: "Would you like to create a Worker at src/index.ts?",
1333
- result: "fetch",
1334
- });
1335
- writeFiles({
1336
- items: {
1337
- "package.json": {
1338
- contents: {
1339
- name: "test",
1340
- version: "1.0.0",
1341
- devDependencies: {
1342
- wrangler: "0.0.0",
1343
- "@cloudflare/workers-types": "0.0.0",
1344
- },
1345
- },
1346
- },
1347
- "tsconfig.json": { contents: { compilerOptions: {} } },
1348
- },
1349
- });
1350
-
1351
- await runWrangler("init");
1352
-
1353
- checkFiles({
1354
- items: {
1355
- "tsconfig.json": {
1356
- contents: { config: { compilerOptions: {} }, error: undefined },
1357
- },
1358
- },
1359
- });
1360
- expect(std).toMatchInlineSnapshot(`
1361
- Object {
1362
- "debug": "",
1363
- "err": "",
1364
- "out": "✨ Created wrangler.toml
1365
- ✨ Created src/index.ts
1366
-
1367
- To start developing your Worker, run \`npx wrangler dev\`
1368
- To publish your Worker to the Internet, run \`npx wrangler publish\`",
1369
- "warn": "",
1370
- }
1371
- `);
1372
- });
1373
-
1374
- it("should not touch an existing tsconfig.json in the ancestor of a target directory, if a name is passed", async () => {
1375
- mockConfirm(
1376
- {
1377
- text: "Would you like to use git to manage this Worker?",
1378
- result: false,
1379
- },
1380
- {
1381
- text: "No package.json found. Would you like to create one?",
1382
- result: true,
1383
- },
1384
- {
1385
- text: "Would you like to use TypeScript?",
1386
- result: true,
1387
- }
1388
- );
1389
- mockSelect({
1390
- text: "Would you like to create a Worker at path/to/worker/my-worker/src/index.ts?",
1391
- result: "fetch",
1392
- });
1393
- writeFiles({
1394
- items: {
1395
- "path/to/worker/package.json": {
1396
- contents: {
1397
- name: "test",
1398
- version: "1.0.0",
1399
- devDependencies: {
1400
- wrangler: "0.0.0",
1401
- "@cloudflare/workers-types": "0.0.0",
1402
- },
1403
- },
1404
- },
1405
- "path/to/worker/tsconfig.json": { contents: { compilerOptions: {} } },
1406
- },
1407
- });
1408
-
1409
- await runWrangler("init path/to/worker/my-worker");
1410
-
1411
- checkFiles({
1412
- items: {
1413
- "path/to/worker/tsconfig.json": {
1414
- contents: { config: { compilerOptions: {}, error: undefined } },
1415
- },
1416
- },
1417
- });
1418
- expect(std).toMatchInlineSnapshot(`
1419
- Object {
1420
- "debug": "",
1421
- "err": "",
1422
- "out": "✨ Created path/to/worker/my-worker/wrangler.toml
1423
- ✨ Created path/to/worker/my-worker/package.json
1424
- ✨ Created path/to/worker/my-worker/tsconfig.json
1425
- ✨ Created path/to/worker/my-worker/src/index.ts
1426
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1427
-
1428
- To start developing your Worker, run \`cd path/to/worker/my-worker && npm start\`
1429
- To publish your Worker to the Internet, run \`npm run deploy\`",
1430
- "warn": "",
1431
- }
1432
- `);
1433
- });
1434
-
1435
- it("should offer to install type definitions in an existing typescript project", async () => {
1436
- mockConfirm(
1437
- {
1438
- text: "Would you like to use git to manage this Worker?",
1439
- result: false,
1440
- },
1441
- {
1442
- text: "Would you like to install wrangler into package.json?",
1443
- result: false,
1444
- },
1445
- {
1446
- text: "Would you like to install the type definitions for Workers into your package.json?",
1447
- result: true,
1448
- }
1449
- );
1450
- mockSelect({
1451
- text: "Would you like to create a Worker at src/index.ts?",
1452
- result: "none",
1453
- });
1454
- writeFiles({
1455
- items: {
1456
- "./package.json": {
1457
- contents: {
1458
- name: "test",
1459
- version: "1.0.0",
1460
- },
1461
- },
1462
- "./tsconfig.json": { contents: { compilerOptions: {} } },
1463
- },
1464
- });
1465
-
1466
- await runWrangler("init");
1467
-
1468
- checkFiles({
1469
- items: {
1470
- // unchanged tsconfig
1471
- "tsconfig.json": { contents: { config: { compilerOptions: {} } } },
1472
- },
1473
- });
1474
- expect(mockPackageManager.addDevDeps).toHaveBeenCalledWith(
1475
- "@cloudflare/workers-types"
1476
- );
1477
- expect(std).toMatchInlineSnapshot(`
1478
- Object {
1479
- "debug": "",
1480
- "err": "",
1481
- "out": "✨ Created wrangler.toml
1482
- ✨ Installed @cloudflare/workers-types into devDependencies
1483
- 🚨 Please add \\"@cloudflare/workers-types\\" to compilerOptions.types in tsconfig.json",
1484
- "warn": "",
1485
- }
1486
- `);
1487
- });
1488
-
1489
- it("should not touch an existing tsconfig.json in an ancestor directory", async () => {
1490
- mockConfirm({
1491
- text: "Would you like to use git to manage this Worker?",
1492
- result: false,
1493
- });
1494
- mockSelect({
1495
- text: "Would you like to create a Worker at src/index.ts?",
1496
- result: "fetch",
1497
- });
1498
- writeFiles({
1499
- items: {
1500
- "package.json": {
1501
- contents: {
1502
- name: "test",
1503
- version: "1.0.0",
1504
- devDependencies: {
1505
- wrangler: "0.0.0",
1506
- "@cloudflare/workers-types": "0.0.0",
1507
- },
1508
- },
1509
- },
1510
- "tsconfig.json": { contents: { compilerOptions: {} } },
1511
- },
1512
- });
1513
- setWorkingDirectory("./sub-1/sub-2");
1514
-
1515
- await runWrangler("init");
1516
-
1517
- checkFiles({
1518
- items: {
1519
- "tsconfig.json": false,
1520
- "../../tsconfig.json": {
1521
- contents: { config: { compilerOptions: {} } },
1522
- },
1523
- },
1524
- });
1525
- expect(std).toMatchInlineSnapshot(`
1526
- Object {
1527
- "debug": "",
1528
- "err": "",
1529
- "out": "✨ Created wrangler.toml
1530
- ✨ Created src/index.ts
1531
-
1532
- To start developing your Worker, run \`npx wrangler dev\`
1533
- To publish your Worker to the Internet, run \`npx wrangler publish\`",
1534
- "warn": "",
1535
- }
1536
- `);
1537
- });
1538
- });
1539
-
1540
- describe("javascript", () => {
1541
- it("should add missing scripts for a non-ts project with .js extension", async () => {
1542
- mockConfirm(
1543
- {
1544
- text: "Would you like to use git to manage this Worker?",
1545
- result: false,
1546
- },
1547
- {
1548
- text: "No package.json found. Would you like to create one?",
1549
- result: true,
1550
- },
1551
- {
1552
- text: "Would you like to install wrangler into package.json?",
1553
- result: false,
1554
- },
1555
- {
1556
- text: "Would you like to use TypeScript?",
1557
- result: false,
1558
- }
1559
- );
1560
- mockSelect({
1561
- text: "Would you like to create a Worker at src/index.js?",
1562
- result: "fetch",
1563
- });
1564
-
1565
- await runWrangler("init");
1566
-
1567
- checkFiles({
1568
- items: {
1569
- "src/index.js": true,
1570
- "src/index.ts": false,
1571
- "package.json": {
1572
- contents: expect.objectContaining({
1573
- name: expect.stringContaining("wrangler-tests"),
1574
- version: "0.0.0",
1575
- scripts: {
1576
- start: "wrangler dev",
1577
- deploy: "wrangler publish",
1578
- },
1579
- }),
1580
- },
1581
- },
1582
- });
1583
- expect(std.out).toMatchInlineSnapshot(`
1584
- "✨ Created wrangler.toml
1585
- ✨ Created package.json
1586
- ✨ Created src/index.js
1587
-
1588
- To start developing your Worker, run \`npm start\`
1589
- To publish your Worker to the Internet, run \`npm run deploy\`"
1590
- `);
1591
- });
1592
-
1593
- it("should not overwrite package.json scripts for a non-ts project with .js extension", async () => {
1594
- mockConfirm(
1595
- {
1596
- text: "Would you like to use git to manage this Worker?",
1597
- result: false,
1598
- },
1599
- {
1600
- text: "Would you like to install wrangler into package.json?",
1601
- result: false,
1602
- },
1603
- {
1604
- text: "Would you like to use TypeScript?",
1605
- result: false,
1606
- }
1607
- );
1608
- mockSelect({
1609
- text: "Would you like to create a Worker at src/index.js?",
1610
- result: "fetch",
1611
- });
1612
- writeFiles({
1613
- items: {
1614
- "package.json": {
1615
- contents: {
1616
- scripts: {
1617
- start: "test-start",
1618
- deploy: "test-publish",
1619
- },
1620
- },
1621
- },
1622
- },
1623
- });
1624
-
1625
- await runWrangler("init");
1626
-
1627
- checkFiles({
1628
- items: {
1629
- "src/index.js": true,
1630
- "src/index.ts": false,
1631
- "package.json": {
1632
- contents: expect.objectContaining({
1633
- scripts: {
1634
- start: "test-start",
1635
- deploy: "test-publish",
1636
- },
1637
- }),
1638
- },
1639
- },
1640
- });
1641
- expect(std.out).toMatchInlineSnapshot(`
1642
- "✨ Created wrangler.toml
1643
- ✨ Created src/index.js
1644
-
1645
- To start developing your Worker, run \`npx wrangler dev\`
1646
- To publish your Worker to the Internet, run \`npx wrangler publish\`"
1647
- `);
1648
- });
1649
-
1650
- it("should not offer to create a worker in a non-ts project if a file already exists at the location", async () => {
1651
- mockConfirm(
1652
- {
1653
- text: "Would you like to use git to manage this Worker?",
1654
- result: false,
1655
- },
1656
- {
1657
- text: "Would you like to install wrangler into package.json?",
1658
- result: false,
1659
- },
1660
- {
1661
- text: "Would you like to use TypeScript?",
1662
- result: false,
1663
- }
1664
- );
1665
- const PLACEHOLDER = "/* placeholder text */";
1666
- writeFiles({
1667
- items: {
1668
- "package.json": { contents: { name: "test", version: "1.0.0" } },
1669
- "src/index.js": { contents: PLACEHOLDER },
1670
- },
1671
- });
1672
-
1673
- await runWrangler("init");
1674
-
1675
- checkFiles({
1676
- items: {
1677
- "src/index.js": { contents: PLACEHOLDER },
1678
- "src/index.ts": false,
1679
- },
1680
- });
1681
- expect(std).toMatchInlineSnapshot(`
1682
- Object {
1683
- "debug": "",
1684
- "err": "",
1685
- "out": "✨ Created wrangler.toml",
1686
- "warn": "",
1687
- }
1688
- `);
1689
- });
1690
-
1691
- it("should not offer to create a worker in a non-ts named worker project if a file already exists at the location", async () => {
1692
- mockConfirm(
1693
- {
1694
- text: "Would you like to use git to manage this Worker?",
1695
- result: false,
1696
- },
1697
- {
1698
- text: "Would you like to install wrangler into my-worker/package.json?",
1699
- result: false,
1700
- },
1701
- {
1702
- text: "Would you like to use TypeScript?",
1703
- result: false,
1704
- }
1705
- );
1706
- const PLACEHOLDER = "/* placeholder text */";
1707
- writeFiles({
1708
- items: {
1709
- "my-worker/package.json": {
1710
- contents: { name: "test", version: "1.0.0" },
1711
- },
1712
- "my-worker/src/index.js": { contents: PLACEHOLDER },
1713
- },
1714
- });
1715
-
1716
- await runWrangler("init my-worker");
1717
-
1718
- checkFiles({
1719
- items: {
1720
- "my-worker/src/index.js": { contents: PLACEHOLDER },
1721
- "my-worker/src/index.ts": false,
1722
- },
1723
- });
1724
- expect(std).toMatchInlineSnapshot(`
1725
- Object {
1726
- "debug": "",
1727
- "err": "",
1728
- "out": "✨ Created my-worker/wrangler.toml",
1729
- "warn": "",
1730
- }
1731
- `);
1732
- });
1733
- });
1734
-
1735
- describe("worker names", () => {
1736
- it("should create a worker with a given name", async () => {
1737
- await runWrangler("init my-worker -y");
1738
-
1739
- checkFiles({
1740
- items: {
1741
- "my-worker/wrangler.toml": wranglerToml({
1742
- ...MINIMAL_WRANGLER_TOML,
1743
- name: "my-worker",
1744
- }),
1745
- },
1746
- });
1747
- });
1748
-
1749
- it('should create a worker with the name of the current directory if "name" is .', async () => {
1750
- await runWrangler("init . -y");
1751
-
1752
- const workerName = path.basename(process.cwd()).toLowerCase();
1753
- checkFiles({
1754
- items: {
1755
- "wrangler.toml": wranglerToml({
1756
- ...MINIMAL_WRANGLER_TOML,
1757
- name: workerName,
1758
- }),
1759
- },
1760
- });
1761
- expect(std).toMatchInlineSnapshot(`
1762
- Object {
1763
- "debug": "",
1764
- "err": "",
1765
- "out": "✨ Created wrangler.toml
1766
- ✨ Initialized git repository
1767
- ✨ Created package.json
1768
- ✨ Created tsconfig.json
1769
- ✨ Created src/index.ts
1770
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1771
-
1772
- To start developing your Worker, run \`npm start\`
1773
- To publish your Worker to the Internet, run \`npm run deploy\`",
1774
- "warn": "",
1775
- }
1776
- `);
1777
- });
1778
-
1779
- it('should create a worker in a nested directory if "name" is path/to/worker', async () => {
1780
- await runWrangler("init path/to/worker -y");
1781
-
1782
- checkFiles({
1783
- items: {
1784
- "path/to/worker/wrangler.toml": wranglerToml({
1785
- ...MINIMAL_WRANGLER_TOML,
1786
- name: "worker",
1787
- }),
1788
- },
1789
- });
1790
- expect(std).toMatchInlineSnapshot(`
1791
- Object {
1792
- "debug": "",
1793
- "err": "",
1794
- "out": "✨ Created path/to/worker/wrangler.toml
1795
- ✨ Initialized git repository at path/to/worker
1796
- ✨ Created path/to/worker/package.json
1797
- ✨ Created path/to/worker/tsconfig.json
1798
- ✨ Created path/to/worker/src/index.ts
1799
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1800
-
1801
- To start developing your Worker, run \`cd path/to/worker && npm start\`
1802
- To publish your Worker to the Internet, run \`npm run deploy\`",
1803
- "warn": "",
1804
- }
1805
- `);
1806
- });
1807
-
1808
- it("should normalize characters that aren't lowercase alphanumeric, underscores, or dashes", async () => {
1809
- await runWrangler("init WEIRD_w0rkr_N4m3.js.tsx.tar.gz -y");
1810
-
1811
- checkFiles({
1812
- items: {
1813
- "WEIRD_w0rkr_N4m3.js.tsx.tar.gz/wrangler.toml": wranglerToml({
1814
- ...MINIMAL_WRANGLER_TOML,
1815
- name: "weird_w0rkr_n4m3-js-tsx-tar-gz",
1816
- }),
1817
- },
1818
- });
1819
- expect(std).toMatchInlineSnapshot(`
1820
- Object {
1821
- "debug": "",
1822
- "err": "",
1823
- "out": "✨ Created WEIRD_w0rkr_N4m3.js.tsx.tar.gz/wrangler.toml
1824
- ✨ Initialized git repository at WEIRD_w0rkr_N4m3.js.tsx.tar.gz
1825
- ✨ Created WEIRD_w0rkr_N4m3.js.tsx.tar.gz/package.json
1826
- ✨ Created WEIRD_w0rkr_N4m3.js.tsx.tar.gz/tsconfig.json
1827
- ✨ Created WEIRD_w0rkr_N4m3.js.tsx.tar.gz/src/index.ts
1828
- ✨ Installed @cloudflare/workers-types and typescript into devDependencies
1829
-
1830
- To start developing your Worker, run \`cd WEIRD_w0rkr_N4m3.js.tsx.tar.gz && npm start\`
1831
- To publish your Worker to the Internet, run \`npm run deploy\`",
1832
- "warn": "",
1833
- }
1834
- `);
1835
- });
1836
-
1837
- it("should ignore ancestor files (such as wrangler.toml, package.json and tsconfig.json) if a name/path is given", async () => {
1838
- mockConfirm(
1839
- {
1840
- text: "Would you like to use git to manage this Worker?",
1841
- result: false,
1842
- },
1843
- {
1844
- text: "Would you like to use TypeScript?",
1845
- result: true,
1846
- },
1847
- {
1848
- text: "No package.json found. Would you like to create one?",
1849
- result: true,
1850
- },
1851
- {
1852
- text: "Would you like to install the type definitions for Workers into your package.json?",
1853
- result: true,
1854
- }
1855
- );
1856
- mockSelect({
1857
- text: "Would you like to create a Worker at sub/folder/worker/src/index.ts?",
1858
- result: "fetch",
1859
- });
1860
- writeFiles({
1861
- items: {
1862
- "package.json": { contents: { name: "top-level" } },
1863
- "tsconfig.json": { contents: { compilerOptions: {} } },
1864
- "wrangler.toml": wranglerToml({
1865
- name: "top-level",
1866
- compatibility_date: "some-date",
1867
- }),
1868
- },
1869
- });
1870
-
1871
- await runWrangler("init sub/folder/worker");
1872
-
1873
- // Ancestor files are untouched.
1874
- checkFiles({
1875
- items: {
1876
- "package.json": { contents: { name: "top-level" } },
1877
- "tsconfig.json": {
1878
- contents: { config: { compilerOptions: {} }, error: undefined },
1879
- },
1880
- "wrangler.toml": wranglerToml({
1881
- name: "top-level",
1882
- compatibility_date: "some-date",
1883
- }),
1884
- },
1885
- });
1886
- // New initialized Worker has its own files.
1887
- checkFiles({
1888
- items: {
1889
- "sub/folder/worker/package.json": {
1890
- contents: expect.objectContaining({
1891
- name: "worker",
1892
- }),
1893
- },
1894
- "sub/folder/worker/tsconfig.json": true,
1895
- "sub/folder/worker/wrangler.toml": wranglerToml({
1896
- ...MINIMAL_WRANGLER_TOML,
1897
- name: "worker",
1898
- }),
1899
- },
1900
- });
1901
- });
1902
- });
1903
- });
1904
-
1905
- /**
1906
- * Change the current working directory, ensuring that this exists.
1907
- */
1908
- function setWorkingDirectory(directory: string) {
1909
- fs.mkdirSync(directory, { recursive: true });
1910
- process.chdir(directory);
1911
- }
1912
-
1913
- /**
1914
- * Write the given folder/files to disk at the given `cwd`.
1915
- */
1916
- function writeFiles(folder: TestFolder, cwd = process.cwd()) {
1917
- for (const name in folder.items) {
1918
- const item = folder.items[name];
1919
- const itemPath = path.resolve(cwd, name);
1920
- if (typeof item !== "boolean") {
1921
- if ("contents" in item) {
1922
- fs.mkdirSync(path.dirname(itemPath), { recursive: true });
1923
- fs.writeFileSync(itemPath, stringify(name, item.contents));
1924
- } else {
1925
- fs.mkdirSync(itemPath, { recursive: true });
1926
- writeFiles(item, itemPath);
1927
- }
1928
- } else {
1929
- throw new Error("Cannot write boolean flags to disk: " + itemPath);
1930
- }
1931
- }
1932
- }
1933
-
1934
- /**
1935
- * Check that the given test folders/files match what is in on disk.
1936
- */
1937
- function checkFiles(folder: TestFolder, cwd = process.cwd()) {
1938
- for (const name in folder.items) {
1939
- const item = folder.items[name];
1940
- const itemPath = path.resolve(cwd, name);
1941
- if (typeof item === "boolean") {
1942
- if (fs.existsSync(itemPath) !== item) {
1943
- throw new Error(`Expected ${itemPath} ${item ? "" : "not "}to exist.`);
1944
- }
1945
- } else if ("contents" in item) {
1946
- const actualContents = parse(name, fs.readFileSync(itemPath, "utf-8"));
1947
- expect(actualContents).toEqual(item.contents);
1948
- } else if ("items" in item) {
1949
- checkFiles(item, itemPath);
1950
- } else {
1951
- throw new Error("Unexpected TestFile object.");
1952
- }
1953
- }
1954
- }
1955
-
1956
- function stringify(name: string, value: unknown) {
1957
- if (name.endsWith(".toml")) {
1958
- return TOML.stringify(value as TOML.JsonMap);
1959
- }
1960
- if (name.endsWith(".json")) {
1961
- return JSON.stringify(value);
1962
- }
1963
- return `${value}`;
1964
- }
1965
-
1966
- function parse(name: string, value: string): unknown {
1967
- if (name.endsWith(".toml")) {
1968
- return TOML.parse(value);
1969
- }
1970
- if (name.endsWith("tsconfig.json")) {
1971
- return parseConfigFileTextToJson(name, value);
1972
- }
1973
- if (name.endsWith(".json")) {
1974
- return JSON.parse(value);
1975
- }
1976
- return value;
1977
- }
1978
-
1979
- function wranglerToml(options: TOML.JsonMap = {}): TestFile {
1980
- return {
1981
- contents: options,
1982
- };
1983
- }
1984
-
1985
- interface TestFile {
1986
- contents: unknown;
1987
- }
1988
- interface TestFolder {
1989
- items: {
1990
- [id: string]: TestFile | TestFolder | boolean;
1991
- };
1992
- }