wrangler 0.0.0-e30d1013 → 0.0.0-e3136f935

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