wrangler 0.0.0-e33bea9b → 0.0.0-e34d19867

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 (314) hide show
  1. package/README.md +33 -43
  2. package/bin/wrangler.js +16 -111
  3. package/config-schema.json +2422 -0
  4. package/package.json +182 -194
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +11 -4
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +2 -4
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +3 -3
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  16. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  17. package/templates/middleware/middleware-scheduled.ts +15 -1
  18. package/templates/mixedMode/proxyServerWorker/index.ts +40 -0
  19. package/templates/mixedMode/proxyServerWorker/wrangler.jsonc +4 -0
  20. package/templates/modules-watch-stub.js +4 -0
  21. package/templates/new-worker-scheduled.ts +1 -1
  22. package/templates/new-worker.ts +1 -1
  23. package/templates/pages-dev-pipeline.ts +5 -3
  24. package/templates/pages-dev-util.ts +4 -1
  25. package/templates/pages-shim.ts +0 -3
  26. package/templates/pages-template-plugin.ts +14 -4
  27. package/templates/pages-template-worker.ts +12 -3
  28. package/templates/startDevWorker/InspectorProxyWorker.ts +679 -0
  29. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  30. package/templates/strip-cf-connecting-ip-header.js +13 -0
  31. package/templates/tsconfig.init.json +4 -87
  32. package/templates/tsconfig.json +9 -2
  33. package/templates/tsconfig.tsbuildinfo +1 -1
  34. package/wrangler-dist/InspectorProxyWorker.js +471 -0
  35. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  36. package/wrangler-dist/ProxyWorker.js +238 -0
  37. package/wrangler-dist/ProxyWorker.js.map +6 -0
  38. package/wrangler-dist/cli.d.ts +25620 -367
  39. package/wrangler-dist/cli.js +171822 -147792
  40. package/wrangler-dist/cli.js.map +7 -0
  41. package/Cloudflare_CA.pem +0 -18
  42. package/import_meta_url.js +0 -3
  43. package/miniflare-config-stubs/.env.empty +0 -0
  44. package/miniflare-config-stubs/package.empty.json +0 -1
  45. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  46. package/miniflare-dist/index.mjs +0 -6368
  47. package/src/__tests__/access.test.ts +0 -25
  48. package/src/__tests__/api-dev.test.ts +0 -238
  49. package/src/__tests__/api-devregistry.test.js +0 -64
  50. package/src/__tests__/api.test.ts +0 -80
  51. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  52. package/src/__tests__/config-cache.test.ts +0 -42
  53. package/src/__tests__/configuration.test.ts +0 -4462
  54. package/src/__tests__/d1/d1.test.ts +0 -82
  55. package/src/__tests__/d1/execute.test.ts +0 -64
  56. package/src/__tests__/d1/migrate.test.ts +0 -155
  57. package/src/__tests__/d1/splitter.test.ts +0 -255
  58. package/src/__tests__/delete.test.ts +0 -266
  59. package/src/__tests__/deployments.test.ts +0 -129
  60. package/src/__tests__/dev.test.tsx +0 -1602
  61. package/src/__tests__/generate.test.ts +0 -238
  62. package/src/__tests__/get-host-from-url.test.ts +0 -16
  63. package/src/__tests__/guess-worker-format.test.ts +0 -120
  64. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  65. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  66. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  67. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  68. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  69. package/src/__tests__/helpers/mock-bin.ts +0 -36
  70. package/src/__tests__/helpers/mock-console.ts +0 -106
  71. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  72. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  73. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  74. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  75. package/src/__tests__/helpers/mock-istty.ts +0 -74
  76. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  77. package/src/__tests__/helpers/mock-kv.ts +0 -46
  78. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  79. package/src/__tests__/helpers/mock-process.ts +0 -34
  80. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  81. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  82. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  83. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  84. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  85. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -93
  86. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  87. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  88. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  89. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  90. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  91. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  92. package/src/__tests__/helpers/msw/index.ts +0 -50
  93. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  94. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  95. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  96. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  97. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  98. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  99. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  100. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  101. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  102. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  103. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  104. package/src/__tests__/https-options.test.ts +0 -163
  105. package/src/__tests__/index.test.ts +0 -274
  106. package/src/__tests__/init.test.ts +0 -3165
  107. package/src/__tests__/jest.setup.ts +0 -175
  108. package/src/__tests__/kv.test.ts +0 -1799
  109. package/src/__tests__/logger.test.ts +0 -141
  110. package/src/__tests__/logout.test.ts +0 -47
  111. package/src/__tests__/metrics.test.ts +0 -493
  112. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  113. package/src/__tests__/middleware.test.ts +0 -816
  114. package/src/__tests__/mtls-certificates.test.ts +0 -585
  115. package/src/__tests__/package-manager.test.ts +0 -353
  116. package/src/__tests__/pages/deployment-list.test.ts +0 -78
  117. package/src/__tests__/pages/functions-build.test.ts +0 -452
  118. package/src/__tests__/pages/pages.test.ts +0 -81
  119. package/src/__tests__/pages/project-create.test.ts +0 -63
  120. package/src/__tests__/pages/project-list.test.ts +0 -108
  121. package/src/__tests__/pages/project-upload.test.ts +0 -481
  122. package/src/__tests__/pages/publish.test.ts +0 -2820
  123. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  124. package/src/__tests__/parse.test.ts +0 -436
  125. package/src/__tests__/paths.test.ts +0 -39
  126. package/src/__tests__/publish.test.ts +0 -8303
  127. package/src/__tests__/pubsub.test.ts +0 -493
  128. package/src/__tests__/queues.test.ts +0 -529
  129. package/src/__tests__/r2.test.ts +0 -374
  130. package/src/__tests__/route.test.ts +0 -45
  131. package/src/__tests__/secret.test.ts +0 -693
  132. package/src/__tests__/tail.test.ts +0 -958
  133. package/src/__tests__/test-old-node-version.js +0 -31
  134. package/src/__tests__/tsconfig-sanity.ts +0 -12
  135. package/src/__tests__/tsconfig.json +0 -8
  136. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  137. package/src/__tests__/type-generation.test.ts +0 -234
  138. package/src/__tests__/user.test.ts +0 -118
  139. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  140. package/src/__tests__/validate-dev-props.test.ts +0 -56
  141. package/src/__tests__/version.test.ts +0 -35
  142. package/src/__tests__/whoami.test.tsx +0 -172
  143. package/src/__tests__/worker-namespace.test.ts +0 -339
  144. package/src/abort.d.ts +0 -3
  145. package/src/api/dev.ts +0 -327
  146. package/src/api/index.ts +0 -11
  147. package/src/api/mtls-certificate.ts +0 -148
  148. package/src/api/pages/create-worker-bundle-contents.ts +0 -75
  149. package/src/api/pages/index.ts +0 -5
  150. package/src/api/pages/publish.tsx +0 -355
  151. package/src/bundle-reporter.ts +0 -68
  152. package/src/bundle.ts +0 -894
  153. package/src/cfetch/index.ts +0 -158
  154. package/src/cfetch/internal.ts +0 -258
  155. package/src/cli.ts +0 -28
  156. package/src/config/README.md +0 -107
  157. package/src/config/config.ts +0 -282
  158. package/src/config/diagnostics.ts +0 -80
  159. package/src/config/environment.ts +0 -591
  160. package/src/config/index.ts +0 -385
  161. package/src/config/validation-helpers.ts +0 -597
  162. package/src/config/validation.ts +0 -2252
  163. package/src/config-cache.ts +0 -85
  164. package/src/create-worker-preview.ts +0 -293
  165. package/src/create-worker-upload-form.ts +0 -342
  166. package/src/d1/backups.tsx +0 -215
  167. package/src/d1/constants.ts +0 -2
  168. package/src/d1/create.tsx +0 -64
  169. package/src/d1/delete.ts +0 -53
  170. package/src/d1/execute.tsx +0 -354
  171. package/src/d1/formatTimeAgo.ts +0 -14
  172. package/src/d1/index.ts +0 -100
  173. package/src/d1/list.tsx +0 -60
  174. package/src/d1/migrations/apply.tsx +0 -206
  175. package/src/d1/migrations/create.tsx +0 -76
  176. package/src/d1/migrations/helpers.ts +0 -172
  177. package/src/d1/migrations/index.ts +0 -3
  178. package/src/d1/migrations/list.tsx +0 -92
  179. package/src/d1/migrations/options.ts +0 -23
  180. package/src/d1/options.ts +0 -22
  181. package/src/d1/splitter.ts +0 -161
  182. package/src/d1/types.ts +0 -25
  183. package/src/d1/utils.ts +0 -49
  184. package/src/delete.ts +0 -100
  185. package/src/deployments.ts +0 -116
  186. package/src/deprecated/index.ts +0 -144
  187. package/src/dev/dev-vars.ts +0 -39
  188. package/src/dev/dev.tsx +0 -600
  189. package/src/dev/get-local-persistence-path.ts +0 -31
  190. package/src/dev/local.tsx +0 -920
  191. package/src/dev/remote.tsx +0 -632
  192. package/src/dev/start-server.ts +0 -540
  193. package/src/dev/use-esbuild.ts +0 -209
  194. package/src/dev/validate-dev-props.ts +0 -40
  195. package/src/dev-registry.ts +0 -201
  196. package/src/dev.tsx +0 -928
  197. package/src/dialogs.ts +0 -136
  198. package/src/dispatch-namespace.ts +0 -211
  199. package/src/docs/index.ts +0 -97
  200. package/src/durable.ts +0 -102
  201. package/src/entry.ts +0 -327
  202. package/src/environment-variables/factory.ts +0 -88
  203. package/src/environment-variables/misc-variables.ts +0 -30
  204. package/src/errors.ts +0 -11
  205. package/src/generate/index.ts +0 -298
  206. package/src/git-client.ts +0 -135
  207. package/src/global-wrangler-config-path.ts +0 -26
  208. package/src/https-options.ts +0 -127
  209. package/src/index.ts +0 -705
  210. package/src/init.ts +0 -1023
  211. package/src/inspect.ts +0 -782
  212. package/src/intl-polyfill.d.ts +0 -139
  213. package/src/is-ci.ts +0 -14
  214. package/src/is-interactive.ts +0 -16
  215. package/src/jest.d.ts +0 -4
  216. package/src/kv/helpers.ts +0 -430
  217. package/src/kv/index.ts +0 -594
  218. package/src/logger.ts +0 -104
  219. package/src/metrics/index.ts +0 -5
  220. package/src/metrics/metrics-config.ts +0 -239
  221. package/src/metrics/metrics-dispatcher.ts +0 -96
  222. package/src/metrics/metrics-usage-headers.ts +0 -24
  223. package/src/metrics/send-event.ts +0 -98
  224. package/src/miniflare-cli/README.md +0 -30
  225. package/src/miniflare-cli/assets.ts +0 -251
  226. package/src/miniflare-cli/index.ts +0 -210
  227. package/src/miniflare-cli/request-context.ts +0 -40
  228. package/src/miniflare-cli/tsconfig.json +0 -9
  229. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  230. package/src/miniflare-cli/types.ts +0 -11
  231. package/src/module-collection.ts +0 -267
  232. package/src/mtls-certificate/cli.ts +0 -155
  233. package/src/open-in-browser.ts +0 -17
  234. package/src/package-manager.ts +0 -219
  235. package/src/pages/build.ts +0 -410
  236. package/src/pages/buildFunctions.ts +0 -140
  237. package/src/pages/constants.ts +0 -18
  238. package/src/pages/deployment-tails.ts +0 -281
  239. package/src/pages/deployments.tsx +0 -86
  240. package/src/pages/dev.ts +0 -716
  241. package/src/pages/errors.ts +0 -67
  242. package/src/pages/functions/buildPlugin.ts +0 -112
  243. package/src/pages/functions/buildWorker.ts +0 -297
  244. package/src/pages/functions/filepath-routing.test.ts +0 -234
  245. package/src/pages/functions/filepath-routing.ts +0 -189
  246. package/src/pages/functions/identifiers.ts +0 -78
  247. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  248. package/src/pages/functions/routes-consolidation.ts +0 -73
  249. package/src/pages/functions/routes-transformation.test.ts +0 -282
  250. package/src/pages/functions/routes-transformation.ts +0 -115
  251. package/src/pages/functions/routes-validation.test.ts +0 -403
  252. package/src/pages/functions/routes-validation.ts +0 -202
  253. package/src/pages/functions/routes.ts +0 -151
  254. package/src/pages/functions/tsconfig.json +0 -8
  255. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  256. package/src/pages/functions.ts +0 -86
  257. package/src/pages/hash.ts +0 -13
  258. package/src/pages/index.ts +0 -102
  259. package/src/pages/projects.tsx +0 -162
  260. package/src/pages/prompt-select-project.tsx +0 -31
  261. package/src/pages/publish.tsx +0 -267
  262. package/src/pages/types.ts +0 -46
  263. package/src/pages/upload.tsx +0 -449
  264. package/src/pages/utils.ts +0 -23
  265. package/src/parse.ts +0 -308
  266. package/src/paths.ts +0 -71
  267. package/src/proxy.ts +0 -694
  268. package/src/publish/index.ts +0 -274
  269. package/src/publish/publish.ts +0 -1076
  270. package/src/pubsub/index.ts +0 -286
  271. package/src/pubsub/pubsub-commands.ts +0 -623
  272. package/src/queues/cli/commands/consumer/add.ts +0 -65
  273. package/src/queues/cli/commands/consumer/index.ts +0 -19
  274. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  275. package/src/queues/cli/commands/create.ts +0 -25
  276. package/src/queues/cli/commands/delete.ts +0 -26
  277. package/src/queues/cli/commands/index.ts +0 -35
  278. package/src/queues/cli/commands/list.ts +0 -25
  279. package/src/queues/client.ts +0 -135
  280. package/src/queues/utils.ts +0 -18
  281. package/src/r2/constants.ts +0 -4
  282. package/src/r2/helpers.ts +0 -132
  283. package/src/r2/index.ts +0 -289
  284. package/src/routes.ts +0 -140
  285. package/src/secret/index.ts +0 -375
  286. package/src/selfsigned.d.ts +0 -29
  287. package/src/sites.ts +0 -372
  288. package/src/tail/createTail.ts +0 -406
  289. package/src/tail/filters.ts +0 -277
  290. package/src/tail/index.ts +0 -211
  291. package/src/tail/printing.ts +0 -122
  292. package/src/tsconfig-sanity.ts +0 -16
  293. package/src/type-generation.ts +0 -181
  294. package/src/update-check.ts +0 -19
  295. package/src/user/access.ts +0 -68
  296. package/src/user/auth-variables.ts +0 -113
  297. package/src/user/choose-account.tsx +0 -39
  298. package/src/user/generate-auth-url.ts +0 -33
  299. package/src/user/generate-random-state.ts +0 -16
  300. package/src/user/index.ts +0 -2
  301. package/src/user/user.ts +0 -1233
  302. package/src/utils/collectKeyValues.ts +0 -14
  303. package/src/whoami.ts +0 -135
  304. package/src/worker.ts +0 -264
  305. package/src/yargs-types.ts +0 -37
  306. package/src/zones.ts +0 -191
  307. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  308. package/templates/d1-beta-facade.js +0 -244
  309. package/templates/first-party-worker-module-facade.ts +0 -19
  310. package/templates/format-dev-errors.ts +0 -34
  311. package/templates/serve-static-assets.ts +0 -66
  312. package/templates/service-bindings-module-facade.js +0 -55
  313. package/templates/service-bindings-sw-facade.js +0 -42
  314. package/wrangler-dist/wasm-sync.wasm +0 -0
package/src/index.ts DELETED
@@ -1,705 +0,0 @@
1
- import os from "node:os";
2
- import TOML from "@iarna/toml";
3
- import chalk from "chalk";
4
- import supportsColor from "supports-color";
5
- import { ProxyAgent, setGlobalDispatcher } from "undici";
6
- import makeCLI from "yargs";
7
- import { version as wranglerVersion } from "../package.json";
8
- import { isBuildFailure } from "./bundle";
9
- import { loadDotEnv, readConfig } from "./config";
10
- import { d1 } from "./d1";
11
- import { deleteHandler, deleteOptions } from "./delete";
12
- import { deployments } from "./deployments";
13
- import {
14
- buildHandler,
15
- buildOptions,
16
- configHandler,
17
- noOpOptions,
18
- previewHandler,
19
- previewOptions,
20
- route,
21
- routeHandler,
22
- subdomainHandler,
23
- subdomainOptions,
24
- } from "./deprecated";
25
- import { devHandler, devOptions } from "./dev";
26
- import { workerNamespaceCommands } from "./dispatch-namespace";
27
- import { docsHandler, docsOptions } from "./docs";
28
- import { generateHandler, generateOptions } from "./generate";
29
- import { initHandler, initOptions } from "./init";
30
- import { kvNamespace, kvKey, kvBulk } from "./kv";
31
- import { logBuildFailure, logger } from "./logger";
32
- import * as metrics from "./metrics";
33
- import { mTlsCertificateCommands } from "./mtls-certificate/cli";
34
- import { pages } from "./pages";
35
- import { formatMessage, ParseError } from "./parse";
36
- import { publishOptions, publishHandler } from "./publish";
37
- import { pubSubCommands } from "./pubsub/pubsub-commands";
38
- import { queues } from "./queues/cli/commands";
39
- import { r2 } from "./r2";
40
- import { secret, secretBulkHandler, secretBulkOptions } from "./secret";
41
- import { tailOptions, tailHandler } from "./tail";
42
- import { generateTypes } from "./type-generation";
43
- import { updateCheck } from "./update-check";
44
- import {
45
- listScopes,
46
- login,
47
- logout,
48
- requireAuth,
49
- validateScopeKeys,
50
- } from "./user";
51
- import { whoami } from "./whoami";
52
-
53
- import type { Config } from "./config";
54
- import type { CommonYargsArgv, CommonYargsOptions } from "./yargs-types";
55
- import type Yargs from "yargs";
56
-
57
- const resetColor = "\x1b[0m";
58
- const fgGreenColor = "\x1b[32m";
59
- export const DEFAULT_LOCAL_PORT = 8787;
60
- export const DEFAULT_INSPECTOR_PORT = 9229;
61
-
62
- const proxy =
63
- process.env.https_proxy ||
64
- process.env.HTTPS_PROXY ||
65
- process.env.http_proxy ||
66
- process.env.HTTP_PROXY ||
67
- undefined;
68
-
69
- if (proxy) {
70
- setGlobalDispatcher(new ProxyAgent(proxy));
71
- logger.log(
72
- `Proxy environment variables detected. We'll use your proxy for fetch requests.`
73
- );
74
- }
75
-
76
- export function getRules(config: Config): Config["rules"] {
77
- const rules = config.rules ?? config.build?.upload?.rules ?? [];
78
-
79
- if (config.rules && config.build?.upload?.rules) {
80
- throw new Error(
81
- `You cannot configure both [rules] and [build.upload.rules] in your wrangler.toml. Delete the \`build.upload\` section.`
82
- );
83
- }
84
-
85
- if (config.build?.upload?.rules) {
86
- logger.warn(
87
- `Deprecation: The \`build.upload.rules\` config field is no longer used, the rules should be specified via the \`rules\` config field. Delete the \`build.upload\` field from the configuration file, and add this:
88
-
89
- ${TOML.stringify({ rules: config.build.upload.rules })}`
90
- );
91
- }
92
- return rules;
93
- }
94
-
95
- export async function printWranglerBanner() {
96
- // Let's not print this in tests
97
- if (typeof jest !== "undefined") {
98
- return;
99
- }
100
-
101
- const text = ` ⛅️ wrangler ${wranglerVersion} ${await updateCheck()}`;
102
-
103
- logger.log(
104
- text +
105
- "\n" +
106
- (supportsColor.stdout
107
- ? chalk.hex("#FF8800")("-".repeat(text.length))
108
- : "-".repeat(text.length))
109
- );
110
- }
111
-
112
- export function isLegacyEnv(config: Config): boolean {
113
- // We only read from config here, because we've already accounted for
114
- // args["legacy-env"] in https://github.com/cloudflare/workers-sdk/blob/b24aeb5722370c2e04bce97a84a1fa1e55725d79/packages/wrangler/src/config/validation.ts#L94-L98
115
- return config.legacy_env;
116
- }
117
-
118
- export function getScriptName(
119
- args: { name: string | undefined; env: string | undefined },
120
- config: Config
121
- ): string | undefined {
122
- if (args.name && isLegacyEnv(config) && args.env) {
123
- throw new CommandLineArgsError(
124
- "In legacy environment mode you cannot use --name and --env together. If you want to specify a Worker name for a specific environment you can add the following to your wrangler.toml config:" +
125
- `
126
- [env.${args.env}]
127
- name = "${args.name}"
128
- `
129
- );
130
- }
131
-
132
- return args.name ?? config.name;
133
- }
134
-
135
- /**
136
- * Alternative to the getScriptName() because special Legacy cases allowed "name", and "env" together in Wrangler v1
137
- */
138
- export function getLegacyScriptName(
139
- args: { name: string | undefined; env: string | undefined },
140
- config: Config
141
- ) {
142
- return args.name && args.env && isLegacyEnv(config)
143
- ? `${args.name}-${args.env}`
144
- : args.name ?? config.name;
145
- }
146
-
147
- // a helper to demand one of a set of options
148
- // via https://github.com/yargs/yargs/issues/1093#issuecomment-491299261
149
- export function demandOneOfOption(...options: string[]) {
150
- return function (argv: Yargs.Arguments) {
151
- const count = options.filter((option) => argv[option]).length;
152
- const lastOption = options.pop();
153
-
154
- if (count === 0) {
155
- throw new CommandLineArgsError(
156
- `Exactly one of the arguments ${options.join(
157
- ", "
158
- )} and ${lastOption} is required`
159
- );
160
- } else if (count > 1) {
161
- throw new CommandLineArgsError(
162
- `Arguments ${options.join(
163
- ", "
164
- )} and ${lastOption} are mutually exclusive`
165
- );
166
- }
167
-
168
- return true;
169
- };
170
- }
171
-
172
- export class CommandLineArgsError extends Error {}
173
-
174
- export function createCLIParser(argv: string[]) {
175
- // Type check result against CommonYargsOptions to make sure we've included
176
- // all common options
177
- const wrangler: CommonYargsArgv = makeCLI(argv)
178
- .strict()
179
- // We handle errors ourselves in a try-catch around `yargs.parse`.
180
- // If you want the "help info" to be displayed then throw an instance of `CommandLineArgsError`.
181
- // Otherwise we just log the error that was thrown without any "help info".
182
- .showHelpOnFail(false)
183
- .fail((msg, error) => {
184
- if (!error || error.name === "YError") {
185
- // If there is no error or the error is a "YError", then this came from yargs own validation
186
- // Wrap it in a `CommandLineArgsError` so that we can handle it appropriately further up.
187
- error = new CommandLineArgsError(msg);
188
- }
189
- throw error;
190
- })
191
- .scriptName("wrangler")
192
- .wrap(null)
193
- // Define global options here, so they get included in the `Argv` type of
194
- // the `wrangler` variable
195
- .version(false)
196
- .option("v", {
197
- describe: "Show version number",
198
- alias: "version",
199
- type: "boolean",
200
- })
201
- .option("config", {
202
- alias: "c",
203
- describe: "Path to .toml configuration file",
204
- type: "string",
205
- requiresArg: true,
206
- })
207
- .option("env", {
208
- alias: "e",
209
- describe: "Environment to use for operations and .env files",
210
- type: "string",
211
- requiresArg: true,
212
- })
213
- .option("experimental-json-config", {
214
- alias: "j",
215
- describe: `Experimental: Support wrangler.json`,
216
- type: "boolean",
217
- })
218
- .check((args) => {
219
- // Grab locally specified env params from `.env` file
220
- const loaded = loadDotEnv(".env", args.env);
221
- for (const [key, value] of Object.entries(loaded?.parsed ?? {})) {
222
- if (!(key in process.env)) process.env[key] = value;
223
- }
224
- return true;
225
- });
226
-
227
- wrangler.group(
228
- ["experimental-json-config", "config", "env", "help", "version"],
229
- "Flags:"
230
- );
231
- wrangler.help().alias("h", "help");
232
-
233
- // Default help command that supports the subcommands
234
- const subHelp: Yargs.CommandModule<CommonYargsOptions, CommonYargsOptions> = {
235
- command: ["*"],
236
- handler: async (args) => {
237
- setImmediate(() =>
238
- wrangler.parse([...args._.map((a) => `${a}`), "--help"])
239
- );
240
- },
241
- };
242
- wrangler.command(
243
- ["*"],
244
- false,
245
- () => {},
246
- async (args) => {
247
- if (args._.length > 0) {
248
- throw new CommandLineArgsError(`Unknown command: ${args._}.`);
249
- } else {
250
- // args.v will exist and be true in the case that no command is called, and the -v
251
- // option is present. This is to allow for running asynchronous printWranglerBanner
252
- // in the version command.
253
- if (args.v) {
254
- if (process.stdout.isTTY) {
255
- await printWranglerBanner();
256
- } else {
257
- logger.log(wranglerVersion);
258
- }
259
- } else {
260
- wrangler.showHelp("log");
261
- }
262
- }
263
- }
264
- );
265
-
266
- // You will note that we use the form for all commands where we use the builder function
267
- // to define options and subcommands.
268
- // Further we return the result of this builder even though it's not completely necessary.
269
- // The reason is that it's required for type inference of the args in the handle function.
270
- // I wish we could enforce this pattern, but this comment will have to do for now.
271
- // (It's also annoying that choices[] doesn't get inferred as an enum. 🤷‍♂.)
272
-
273
- // docs
274
- wrangler.command(
275
- "docs [command]",
276
- "📚 Open wrangler's docs in your browser",
277
- docsOptions,
278
- docsHandler
279
- );
280
-
281
- // init
282
- wrangler.command(
283
- "init [name]",
284
- "📥 Initialize a basic Worker project, including a wrangler.toml file",
285
- initOptions,
286
- initHandler
287
- );
288
-
289
- // generate
290
- wrangler.command(
291
- "generate [name] [template]",
292
- "✨ Generate a new Worker project from an existing Worker template. See https://github.com/cloudflare/templates",
293
- generateOptions,
294
- generateHandler
295
- );
296
-
297
- // [DEPRECATED] build
298
- wrangler.command("build", false, buildOptions, buildHandler);
299
-
300
- // [DEPRECATED] config
301
- wrangler.command("config", false, noOpOptions, configHandler);
302
-
303
- // dev
304
- wrangler.command(
305
- "dev [script]",
306
- "👂 Start a local server for developing your worker",
307
- devOptions,
308
- devHandler
309
- );
310
-
311
- // publish
312
- wrangler.command(
313
- "publish [script]",
314
- "🆙 Publish your Worker to Cloudflare.",
315
- publishOptions,
316
- publishHandler
317
- );
318
-
319
- // delete
320
- wrangler.command(
321
- "delete [script]",
322
- "🗑 Delete your Worker from Cloudflare.",
323
- deleteOptions,
324
- deleteHandler
325
- );
326
-
327
- // tail
328
- wrangler.command(
329
- "tail [worker]",
330
- "🦚 Starts a log tailing session for a published Worker.",
331
- tailOptions,
332
- tailHandler
333
- );
334
-
335
- // [DEPRECATED] preview
336
- wrangler.command(
337
- "preview [method] [body]",
338
- false,
339
- previewOptions,
340
- previewHandler
341
- );
342
-
343
- // [DEPRECATED] route
344
- wrangler.command(
345
- "route",
346
- false, // I think we want to hide this command
347
- // "➡️ List or delete worker routes",
348
- (routeYargs) => {
349
- return route(routeYargs);
350
- },
351
- routeHandler
352
- );
353
-
354
- // [DEPRECATED] subdomain
355
- wrangler.command(
356
- "subdomain [name]",
357
- false,
358
- // "👷 Create or change your workers.dev subdomain.",
359
- subdomainOptions,
360
- subdomainHandler
361
- );
362
-
363
- // secret
364
- wrangler.command(
365
- "secret",
366
- "🤫 Generate a secret that can be referenced in a Worker",
367
- (secretYargs) => {
368
- return secret(secretYargs.command(subHelp));
369
- }
370
- );
371
-
372
- wrangler.command(
373
- "secret:bulk <json>",
374
- "🗄️ Bulk upload secrets for a Worker",
375
- secretBulkOptions,
376
- secretBulkHandler
377
- );
378
-
379
- // kv namespace
380
- wrangler.command(
381
- "kv:namespace",
382
- "🗂️ Interact with your Workers KV Namespaces",
383
- (namespaceYargs) => {
384
- return kvNamespace(namespaceYargs.command(subHelp));
385
- }
386
- );
387
-
388
- // kv key
389
- wrangler.command(
390
- "kv:key",
391
- "🔑 Individually manage Workers KV key-value pairs",
392
- (keyYargs) => {
393
- return kvKey(keyYargs.command(subHelp));
394
- }
395
- );
396
-
397
- // kv bulk
398
- wrangler.command(
399
- "kv:bulk",
400
- "💪 Interact with multiple Workers KV key-value pairs at once",
401
- (bulkYargs) => {
402
- return kvBulk(bulkYargs.command(subHelp));
403
- }
404
- );
405
-
406
- // pages
407
- wrangler.command("pages", "⚡️ Configure Cloudflare Pages", (pagesYargs) => {
408
- return pages(pagesYargs.command(subHelp));
409
- });
410
-
411
- // queues
412
- wrangler.command("queues", "🇶 Configure Workers Queues", (queuesYargs) => {
413
- return queues(queuesYargs.command(subHelp));
414
- });
415
-
416
- // r2
417
- wrangler.command("r2", "📦 Interact with an R2 store", (r2Yargs) => {
418
- return r2(r2Yargs.command(subHelp));
419
- });
420
-
421
- // dispatch-namespace
422
- wrangler.command(
423
- "dispatch-namespace",
424
- "📦 Interact with a dispatch namespace",
425
- (workerNamespaceYargs) => {
426
- return workerNamespaceCommands(workerNamespaceYargs, subHelp);
427
- }
428
- );
429
-
430
- // d1
431
- wrangler.command("d1", "🗄 Interact with a D1 database", (d1Yargs) => {
432
- return d1(d1Yargs.command(subHelp));
433
- });
434
-
435
- // pubsub
436
- wrangler.command(
437
- "pubsub",
438
- "📮 Interact and manage Pub/Sub Brokers",
439
- (pubsubYargs) => {
440
- return pubSubCommands(pubsubYargs, subHelp);
441
- }
442
- );
443
-
444
- // mtls-certificate
445
- wrangler.command(
446
- "mtls-certificate",
447
- "🪪 Manage certificates used for mTLS connections",
448
- (mtlsYargs) => {
449
- return mTlsCertificateCommands(mtlsYargs.command(subHelp));
450
- }
451
- );
452
-
453
- /**
454
- * User Group: login, logout, and whoami
455
- * TODO: group commands into User group similar to .group() for flags in yargs
456
- */
457
- // login
458
- wrangler.command(
459
- // this needs scopes as an option?
460
- "login",
461
- "🔓 Login to Cloudflare",
462
- (yargs) => {
463
- // TODO: This needs some copy editing
464
- // I mean, this entire app does, but this too.
465
- return yargs
466
- .option("scopes-list", {
467
- describe: "List all the available OAuth scopes with descriptions",
468
- })
469
- .option("browser", {
470
- default: true,
471
- type: "boolean",
472
- describe: "Automatically open the OAuth link in a browser",
473
- })
474
- .option("scopes", {
475
- describe: "Pick the set of applicable OAuth scopes when logging in",
476
- array: true,
477
- type: "string",
478
- requiresArg: true,
479
- });
480
-
481
- // TODO: scopes
482
- },
483
- async (args) => {
484
- await printWranglerBanner();
485
- if (args["scopes-list"]) {
486
- listScopes();
487
- return;
488
- }
489
- if (args.scopes) {
490
- if (args.scopes.length === 0) {
491
- // don't allow no scopes to be passed, that would be weird
492
- listScopes();
493
- return;
494
- }
495
- if (!validateScopeKeys(args.scopes)) {
496
- throw new CommandLineArgsError(
497
- `One of ${args.scopes} is not a valid authentication scope. Run "wrangler login --list-scopes" to see the valid scopes.`
498
- );
499
- }
500
- await login({ scopes: args.scopes, browser: args.browser });
501
- return;
502
- }
503
- await login({ browser: args.browser });
504
- const config = readConfig(args.config, args);
505
- await metrics.sendMetricsEvent("login user", {
506
- sendMetrics: config.send_metrics,
507
- });
508
-
509
- // TODO: would be nice if it optionally saved login
510
- // credentials inside node_modules/.cache or something
511
- // this way you could have multiple users on a single machine
512
- }
513
- );
514
-
515
- // logout
516
- wrangler.command(
517
- // this needs scopes as an option?
518
- "logout",
519
- "🚪 Logout from Cloudflare",
520
- () => {},
521
- async (args) => {
522
- await printWranglerBanner();
523
- await logout();
524
- const config = readConfig(undefined, args);
525
- await metrics.sendMetricsEvent("logout user", {
526
- sendMetrics: config.send_metrics,
527
- });
528
- }
529
- );
530
-
531
- // whoami
532
- wrangler.command(
533
- "whoami",
534
- "🕵️ Retrieve your user info and test your auth config",
535
- () => {},
536
- async (args) => {
537
- await printWranglerBanner();
538
- await whoami();
539
- const config = readConfig(undefined, args);
540
- await metrics.sendMetricsEvent("view accounts", {
541
- sendMetrics: config.send_metrics,
542
- });
543
- }
544
- );
545
-
546
- // type generation
547
- wrangler.command(
548
- "types",
549
- "📝 Generate types from bindings & module rules in config",
550
- () => {},
551
- async (args) => {
552
- await printWranglerBanner();
553
- const config = readConfig(undefined, args);
554
-
555
- const configBindings: Partial<Config> = {
556
- kv_namespaces: config.kv_namespaces ?? [],
557
- vars: { ...config.vars },
558
- wasm_modules: config.wasm_modules,
559
- text_blobs: {
560
- ...config.text_blobs,
561
- },
562
- data_blobs: config.data_blobs,
563
- durable_objects: config.durable_objects,
564
- r2_buckets: config.r2_buckets,
565
- d1_databases: config.d1_databases,
566
- services: config.services,
567
- analytics_engine_datasets: config.analytics_engine_datasets,
568
- dispatch_namespaces: config.dispatch_namespaces,
569
- logfwdr: config.logfwdr,
570
- unsafe: config.unsafe,
571
- rules: config.rules,
572
- queues: config.queues,
573
- };
574
-
575
- await generateTypes(configBindings, config);
576
- }
577
- );
578
-
579
- //deployments
580
- const deploymentsWarning =
581
- "🚧`wrangler deployments` is a beta command. Please report any issues to https://github.com/cloudflare/workers-sdk/issues/new/choose";
582
- wrangler.command(
583
- "deployments",
584
- "🚢 Displays the 10 most recent deployments for a worker",
585
- (yargs) =>
586
- yargs
587
- .option("name", {
588
- describe: "The name of your worker",
589
- type: "string",
590
- })
591
- .epilogue(deploymentsWarning),
592
- async (deploymentsYargs) => {
593
- await printWranglerBanner();
594
- const config = readConfig(deploymentsYargs.config, deploymentsYargs);
595
- const accountId = await requireAuth(config);
596
- const scriptName = getScriptName(
597
- { name: deploymentsYargs.name, env: undefined },
598
- config
599
- );
600
-
601
- logger.log(`${deploymentsWarning}\n`);
602
- await deployments(accountId, scriptName, config);
603
- }
604
- );
605
-
606
- // This set to false to allow overwrite of default behaviour
607
- wrangler.version(false);
608
-
609
- // version
610
- wrangler.command(
611
- "version",
612
- false,
613
- () => {},
614
- async () => {
615
- if (process.stdout.isTTY) {
616
- await printWranglerBanner();
617
- } else {
618
- logger.log(wranglerVersion);
619
- }
620
- }
621
- );
622
-
623
- wrangler.exitProcess(false);
624
-
625
- return wrangler;
626
- }
627
-
628
- export async function main(argv: string[]): Promise<void> {
629
- const wrangler = createCLIParser(argv);
630
- try {
631
- await wrangler.parse();
632
- } catch (e) {
633
- logger.log(""); // Just adds a bit of space
634
- if (e instanceof CommandLineArgsError) {
635
- logger.error(e.message);
636
- // We are not able to ask the `wrangler` CLI parser to show help for a subcommand programmatically.
637
- // The workaround is to re-run the parsing with an additional `--help` flag, which will result in the correct help message being displayed.
638
- // The `wrangler` object is "frozen"; we cannot reuse that with different args, so we must create a new CLI parser to generate the help message.
639
- await createCLIParser([...argv, "--help"]).parse();
640
- } else if (e instanceof ParseError) {
641
- e.notes.push({
642
- text: "\nIf you think this is a bug, please open an issue at: https://github.com/cloudflare/workers-sdk/issues/new/choose",
643
- });
644
- logger.log(formatMessage(e));
645
- } else if (
646
- e instanceof Error &&
647
- e.message.includes("Raw mode is not supported on")
648
- ) {
649
- // the current terminal doesn't support raw mode, which Ink needs to render
650
- // Ink doesn't throw a typed error or subclass or anything, so we just check the message content.
651
- // https://github.com/vadimdemedes/ink/blob/546fe16541fd05ad4e638d6842ca4cbe88b4092b/src/components/App.tsx#L138-L148
652
-
653
- const currentPlatform = os.platform();
654
-
655
- const thisTerminalIsUnsupported =
656
- "This terminal doesn't support raw mode.";
657
- const soWranglerWontWork =
658
- "Wrangler uses raw mode to read user input and write output to the terminal, and won't function correctly without it.";
659
- const tryRunningItIn =
660
- "Try running your previous command in a terminal that supports raw mode";
661
- const oneOfThese =
662
- currentPlatform === "win32"
663
- ? ", such as Command Prompt or Powershell."
664
- : currentPlatform === "darwin"
665
- ? ", such as Terminal.app or iTerm."
666
- : "."; // linux user detected, hand holding disengaged.
667
-
668
- logger.error(
669
- `${thisTerminalIsUnsupported}\n${soWranglerWontWork}\n${tryRunningItIn}${oneOfThese}`
670
- );
671
- } else if (isBuildFailure(e)) {
672
- logBuildFailure(e);
673
- logger.error(e.message);
674
- } else {
675
- logger.error(e instanceof Error ? e.message : e);
676
- logger.log(
677
- `${fgGreenColor}%s${resetColor}`,
678
- "If you think this is a bug then please create an issue at https://github.com/cloudflare/workers-sdk/issues/new/choose"
679
- );
680
- }
681
- throw e;
682
- }
683
- }
684
-
685
- export function getDevCompatibilityDate(
686
- config: Config,
687
- compatibilityDate = config.compatibility_date
688
- ) {
689
- const currentDate = new Date().toISOString().substring(0, 10);
690
- if (config.configPath !== undefined && compatibilityDate === undefined) {
691
- logger.warn(
692
- `No compatibility_date was specified. Using today's date: ${currentDate}.\n` +
693
- "Add one to your wrangler.toml file:\n" +
694
- "```\n" +
695
- `compatibility_date = "${currentDate}"\n` +
696
- "```\n" +
697
- "or pass it in your terminal:\n" +
698
- "```\n" +
699
- `--compatibility-date=${currentDate}\n` +
700
- "```\n" +
701
- "See https://developers.cloudflare.com/workers/platform/compatibility-dates/ for more information."
702
- );
703
- }
704
- return compatibilityDate ?? currentDate;
705
- }