wrangler 0.0.0-bcd066d → 0.0.0-bd0a4224

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 (160) hide show
  1. package/README.md +28 -8
  2. package/bin/wrangler.js +99 -114
  3. package/package.json +190 -155
  4. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  5. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  6. package/templates/__tests__/tsconfig.json +8 -0
  7. package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
  8. package/templates/checked-fetch.js +23 -0
  9. package/templates/d1-beta-facade.js +244 -0
  10. package/templates/facade.d.ts +14 -0
  11. package/templates/first-party-worker-module-facade.ts +19 -0
  12. package/templates/format-dev-errors.ts +34 -0
  13. package/templates/gitignore +1 -0
  14. package/templates/init-tests/test-jest-new-worker.js +23 -0
  15. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  16. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  17. package/templates/middleware/common.ts +67 -0
  18. package/templates/middleware/loader-modules.ts +84 -0
  19. package/templates/middleware/loader-sw.ts +228 -0
  20. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  21. package/templates/middleware/middleware-pretty-error.ts +40 -0
  22. package/templates/middleware/middleware-scheduled.ts +15 -0
  23. package/templates/new-worker-scheduled.js +3 -3
  24. package/templates/new-worker-scheduled.ts +16 -16
  25. package/templates/new-worker.js +3 -3
  26. package/templates/new-worker.ts +19 -16
  27. package/templates/no-op-worker.js +8 -8
  28. package/templates/pages-dev-pipeline.ts +31 -0
  29. package/templates/pages-dev-util.ts +55 -0
  30. package/templates/pages-shim.ts +9 -0
  31. package/templates/pages-template-plugin.ts +149 -124
  32. package/templates/pages-template-worker.ts +152 -124
  33. package/templates/serve-static-assets.ts +66 -0
  34. package/templates/service-bindings-module-facade.js +55 -0
  35. package/templates/service-bindings-sw-facade.js +42 -0
  36. package/templates/tsconfig-sanity.ts +11 -0
  37. package/templates/tsconfig.init.json +105 -0
  38. package/templates/tsconfig.json +6 -103
  39. package/templates/tsconfig.tsbuildinfo +1 -0
  40. package/wrangler-dist/cli.d.ts +1726 -0
  41. package/wrangler-dist/cli.js +112761 -90111
  42. package/wrangler-dist/wasm-sync.wasm +0 -0
  43. package/import_meta_url.js +0 -3
  44. package/miniflare-config-stubs/.env.empty +0 -0
  45. package/miniflare-config-stubs/package.empty.json +0 -1
  46. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  47. package/miniflare-dist/index.mjs +0 -4886
  48. package/src/__tests__/config-cache.test.ts +0 -36
  49. package/src/__tests__/configuration.test.ts +0 -3548
  50. package/src/__tests__/dev.test.tsx +0 -1055
  51. package/src/__tests__/guess-worker-format.test.ts +0 -85
  52. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  53. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  54. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  55. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  56. package/src/__tests__/helpers/mock-bin.ts +0 -36
  57. package/src/__tests__/helpers/mock-cfetch.ts +0 -211
  58. package/src/__tests__/helpers/mock-console.ts +0 -97
  59. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  60. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  61. package/src/__tests__/helpers/mock-istty.ts +0 -27
  62. package/src/__tests__/helpers/mock-kv.ts +0 -33
  63. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -255
  64. package/src/__tests__/helpers/mock-process.ts +0 -24
  65. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  66. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  67. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  68. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  69. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  70. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  71. package/src/__tests__/https-options.test.ts +0 -130
  72. package/src/__tests__/index.test.ts +0 -258
  73. package/src/__tests__/init.test.ts +0 -1992
  74. package/src/__tests__/jest.setup.ts +0 -107
  75. package/src/__tests__/kv.test.ts +0 -1564
  76. package/src/__tests__/logger.test.ts +0 -141
  77. package/src/__tests__/package-manager.test.ts +0 -353
  78. package/src/__tests__/pages.test.ts +0 -1242
  79. package/src/__tests__/parse.test.ts +0 -330
  80. package/src/__tests__/publish.test.ts +0 -6198
  81. package/src/__tests__/r2.test.ts +0 -233
  82. package/src/__tests__/route.test.ts +0 -45
  83. package/src/__tests__/secret.test.ts +0 -481
  84. package/src/__tests__/tail.test.ts +0 -690
  85. package/src/__tests__/user.test.ts +0 -132
  86. package/src/__tests__/whoami.test.tsx +0 -139
  87. package/src/abort.d.ts +0 -3
  88. package/src/bundle-reporter.tsx +0 -29
  89. package/src/bundle.ts +0 -204
  90. package/src/cfetch/index.ts +0 -121
  91. package/src/cfetch/internal.ts +0 -142
  92. package/src/cli.ts +0 -13
  93. package/src/config/README.md +0 -107
  94. package/src/config/config.ts +0 -243
  95. package/src/config/diagnostics.ts +0 -80
  96. package/src/config/environment.ts +0 -420
  97. package/src/config/index.ts +0 -225
  98. package/src/config/validation-helpers.ts +0 -584
  99. package/src/config/validation.ts +0 -1580
  100. package/src/config-cache.ts +0 -45
  101. package/src/create-worker-preview.ts +0 -185
  102. package/src/create-worker-upload-form.ts +0 -254
  103. package/src/dev/dev-vars.ts +0 -36
  104. package/src/dev/dev.tsx +0 -399
  105. package/src/dev/local.tsx +0 -321
  106. package/src/dev/remote.tsx +0 -249
  107. package/src/dev/use-esbuild.ts +0 -112
  108. package/src/dialogs.tsx +0 -135
  109. package/src/durable.ts +0 -102
  110. package/src/entry.ts +0 -328
  111. package/src/environment-variables.ts +0 -35
  112. package/src/errors.ts +0 -11
  113. package/src/generate-auth-url.ts +0 -33
  114. package/src/generate-random-state.ts +0 -16
  115. package/src/git-client.ts +0 -42
  116. package/src/https-options.ts +0 -123
  117. package/src/index.tsx +0 -2908
  118. package/src/inspect.ts +0 -662
  119. package/src/intl-polyfill.d.ts +0 -139
  120. package/src/kv.ts +0 -408
  121. package/src/logger.ts +0 -73
  122. package/src/miniflare-cli/README.md +0 -30
  123. package/src/miniflare-cli/enum-keys.ts +0 -17
  124. package/src/miniflare-cli/index.ts +0 -41
  125. package/src/miniflare-cli/request-context.ts +0 -40
  126. package/src/module-collection.ts +0 -258
  127. package/src/open-in-browser.ts +0 -17
  128. package/src/package-manager.ts +0 -174
  129. package/src/pages/build.tsx +0 -202
  130. package/src/pages/constants.ts +0 -7
  131. package/src/pages/deployments.tsx +0 -101
  132. package/src/pages/dev.tsx +0 -948
  133. package/src/pages/functions/buildPlugin.ts +0 -105
  134. package/src/pages/functions/buildWorker.ts +0 -151
  135. package/src/pages/functions/filepath-routing.test.ts +0 -234
  136. package/src/pages/functions/filepath-routing.ts +0 -189
  137. package/src/pages/functions/identifiers.ts +0 -78
  138. package/src/pages/functions/routes.ts +0 -151
  139. package/src/pages/index.tsx +0 -84
  140. package/src/pages/projects.tsx +0 -157
  141. package/src/pages/publish.tsx +0 -325
  142. package/src/pages/types.ts +0 -40
  143. package/src/pages/upload.tsx +0 -363
  144. package/src/pages/utils.ts +0 -12
  145. package/src/parse.ts +0 -222
  146. package/src/paths.ts +0 -26
  147. package/src/proxy.ts +0 -476
  148. package/src/publish.ts +0 -739
  149. package/src/r2.ts +0 -50
  150. package/src/selfsigned.d.ts +0 -29
  151. package/src/sites.tsx +0 -372
  152. package/src/tail/filters.ts +0 -279
  153. package/src/tail/index.ts +0 -299
  154. package/src/tail/printing.ts +0 -67
  155. package/src/update-check.ts +0 -19
  156. package/src/user.tsx +0 -1202
  157. package/src/whoami.tsx +0 -71
  158. package/src/worker.ts +0 -181
  159. package/src/zones.ts +0 -73
  160. package/templates/static-asset-facade.js +0 -43
package/README.md CHANGED
@@ -1,6 +1,12 @@
1
- ## ⛅️ wrangler
1
+ <h1 align="center"> ⛅️ wrangler </h1>
2
+ <section align="center" id="shieldio-badges">
3
+ <a href="https://www.npmjs.com/package/wrangler"><img alt="npm" src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
4
+ <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/workers-sdk?style=flat-square">
5
+ <img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/workers-sdk/main?style=flat-square">
6
+ <a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
7
+ </section>
2
8
 
3
- > This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler.
9
+ > This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the `@cloudflare/wrangler` package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler-legacy.
4
10
 
5
11
  `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
6
12
 
@@ -11,8 +17,8 @@
11
17
  echo "export default { fetch() { return new Response('hello world') } }" > index.js
12
18
  # try it out
13
19
  npx wrangler dev index.js
14
- # and then publish it
15
- npx wrangler publish index.js --name my-worker
20
+ # and then deploy it
21
+ npx wrangler deploy index.js --name my-worker
16
22
  # visit https://my-worker.<your workers subdomain>.workers.dev
17
23
  ```
18
24
 
@@ -23,7 +29,7 @@ npx wrangler publish index.js --name my-worker
23
29
  npx wrangler init my-worker
24
30
  # try it out
25
31
  cd my-worker && npm run start
26
- # and then publish it
32
+ # and then deploy it
27
33
  npm run deploy
28
34
  ```
29
35
 
@@ -33,17 +39,31 @@ npm run deploy
33
39
  $ npm install wrangler --save-dev
34
40
  ```
35
41
 
42
+ ## Configuration:
43
+
44
+ Wrangler is configured via a `wrangler.toml` file in the project root. When utilizing the `wrangler init` command, a `wrangler.toml` file will be created for you.
45
+
46
+ example:
47
+
48
+ ```toml
49
+ main = "./src/index.ts" # init w/ TypeScript
50
+ name = "my-worker"
51
+ compatibility_date = "YYY-MM-DD"
52
+ ```
53
+
54
+ for more detailed information about configuration, see the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration)
55
+
36
56
  ## Commands
37
57
 
38
58
  ### `wrangler init [name]`
39
59
 
40
- Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
60
+ Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).
41
61
 
42
62
  ### `wrangler dev`
43
63
 
44
64
  Start a local development server, with live reloading and devtools.
45
65
 
46
- ### `wrangler publish`
66
+ ### `wrangler deploy`
47
67
 
48
68
  Publish the given script to the worldwide Cloudflare network.
49
69
 
@@ -61,4 +81,4 @@ For more commands and options, refer to the [documentation](https://developers.c
61
81
 
62
82
  ## Documentation
63
83
 
64
- For the latest Wrangler documentation, [click here](https://6b05b6e1.cloudflare-docs-7ou.pages.dev/workers/wrangler/).
84
+ For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
package/bin/wrangler.js CHANGED
@@ -3,9 +3,12 @@ const { spawn } = require("child_process");
3
3
  const path = require("path");
4
4
  const fs = require("fs");
5
5
  const os = require("os");
6
- const semiver = require("semiver");
7
6
 
8
- const MIN_NODE_VERSION = "16.7.0";
7
+ const MIN_NODE_VERSION = "16.13.0";
8
+ const debug =
9
+ process.env["WRANGLER_LOG"] === "debug"
10
+ ? (...args) => console.log(...args)
11
+ : () => {};
9
12
 
10
13
  let wranglerProcess;
11
14
 
@@ -13,125 +16,107 @@ let wranglerProcess;
13
16
  * Executes ../wrangler-dist/cli.js
14
17
  */
15
18
  function runWrangler() {
16
- if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
17
- // Note Volta and nvm are also recommended in the official docs:
18
- // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
19
- console.error(
20
- `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
21
- You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
19
+ if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
20
+ // Note Volta and nvm are also recommended in the official docs:
21
+ // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
22
+ console.error(
23
+ `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of Node.js.
24
+
22
25
  Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
23
- );
24
- process.exitCode = 1;
25
- return;
26
- }
27
-
28
- let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
29
- if (pathToCACerts) {
30
- // TODO:
31
- // - should we log a warning here?
32
- // - maybe we can generate a certificate that concatenates with ours?
33
- //
34
- // I do think it'll be rare that someone wants to add a cert AND
35
- // use cloudflare WARP, but let's wait till the situation actually
36
- // arises before we do anything about it
37
- } else {
38
- const osTempDir = os.tmpdir();
39
- const certDir = path.join(osTempDir, "wrangler-cert");
40
- const certPath = path.join(certDir, "Cloudflare_CA.pem");
41
- // copy cert to the system temp dir if needed
42
- if (!fs.existsSync(certPath)) {
43
- fs.mkdirSync(certDir, { recursive: true });
44
- fs.writeFileSync(
45
- certPath,
46
- fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
47
- );
48
- }
49
- pathToCACerts = certPath;
50
- }
51
-
52
- return spawn(
53
- process.execPath,
54
- [
55
- ...(semiver(process.versions.node, "18.0.0") >= 0
56
- ? ["--no-experimental-fetch"] // TODO: remove this when https://github.com/cloudflare/wrangler2/issues/834 is properly fixed
57
- : []),
58
- "--no-warnings",
59
- "--experimental-vm-modules",
60
- ...process.execArgv,
61
- path.join(__dirname, "../wrangler-dist/cli.js"),
62
- ...process.argv.slice(2),
63
- ],
64
- {
65
- stdio: "inherit",
66
- env: {
67
- ...process.env,
68
- NODE_EXTRA_CA_CERTS: pathToCACerts,
69
- },
70
- }
71
- ).on("exit", (code) =>
72
- process.exit(code === undefined || code === null ? 0 : code)
73
- );
74
- }
26
+ );
27
+ process.exitCode = 1;
28
+ return;
29
+ }
75
30
 
76
- /**
77
- * Runs a locally-installed version of wrangler, delegating from this version.
78
- * @throws {MODULE_NOT_FOUND} if there isn't a locally installed version of wrangler.
79
- */
80
- function runDelegatedWrangler() {
81
- const packageJsonPath = require.resolve("wrangler/package.json", {
82
- paths: [process.cwd()],
83
- });
84
- const {
85
- bin: { wrangler: binaryPath },
86
- version,
87
- } = JSON.parse(fs.readFileSync(packageJsonPath));
88
- const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
89
-
90
- console.log(
91
- `Delegating to locally-installed version of wrangler @ v${version}`
92
- );
93
- // this call to `spawn` is simpler because the delegated version will do all
94
- // of the other work.
95
- return spawn(
96
- process.execPath,
97
- [resolvedBinaryPath, ...process.argv.slice(2)],
98
- {
99
- stdio: "inherit",
100
- }
101
- ).on("exit", (code) =>
102
- process.exit(code === undefined || code === null ? 0 : code)
103
- );
31
+ let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
32
+ if (pathToCACerts) {
33
+ // TODO:
34
+ // - should we log a warning here?
35
+ // - maybe we can generate a certificate that concatenates with ours?
36
+ //
37
+ // I do think it'll be rare that someone wants to add a cert AND
38
+ // use Cloudflare WARP, but let's wait till the situation actually
39
+ // arises before we do anything about it
40
+ } else {
41
+ const osTempDir = os.tmpdir();
42
+ const certDir = path.join(osTempDir, "wrangler-cert");
43
+ const certPath = path.join(certDir, "Cloudflare_CA.pem");
44
+ // copy cert to the system temp dir if needed
45
+ if (!fs.existsSync(certPath)) {
46
+ fs.mkdirSync(certDir, { recursive: true });
47
+ fs.writeFileSync(
48
+ certPath,
49
+ fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
50
+ );
51
+ }
52
+ pathToCACerts = certPath;
53
+ }
54
+
55
+ return spawn(
56
+ process.execPath,
57
+ [
58
+ "--no-warnings",
59
+ "--experimental-vm-modules",
60
+ ...process.execArgv,
61
+ path.join(__dirname, "../wrangler-dist/cli.js"),
62
+ ...process.argv.slice(2),
63
+ ],
64
+ {
65
+ stdio: ["inherit", "inherit", "inherit", "ipc"],
66
+ env: {
67
+ ...process.env,
68
+ NODE_EXTRA_CA_CERTS: pathToCACerts,
69
+ },
70
+ }
71
+ )
72
+ .on("exit", (code) =>
73
+ process.exit(code === undefined || code === null ? 0 : code)
74
+ )
75
+ .on("message", (message) => {
76
+ if (process.send) {
77
+ process.send(message);
78
+ }
79
+ });
104
80
  }
105
81
 
82
+ // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
83
+
106
84
  /**
107
- * Indicates if this invocation of `wrangler` should delegate
108
- * to a locally-installed version.
85
+ MIT License
86
+
87
+ Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
88
+
89
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
90
+
91
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
92
+
93
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
94
+
109
95
  */
110
- function shouldDelegate() {
111
- try {
112
- // `require.resolve` will throw if it can't find
113
- // a locally-installed version of `wrangler`
114
- const delegatedPackageJson = require.resolve("wrangler/package.json", {
115
- paths: [process.cwd()],
116
- });
117
- const thisPackageJson = path.resolve(__dirname, "..", "package.json");
118
- // if it's the same path, then we're already a local install -- no need to delegate
119
- return thisPackageJson !== delegatedPackageJson;
120
- } catch (e) {
121
- // there's no local version to delegate to -- `require.resolve` threw
122
- return false;
123
- }
124
- }
125
96
 
126
- async function main() {
127
- wranglerProcess = shouldDelegate() ? runDelegatedWrangler() : runWrangler();
97
+ var fn = new Intl.Collator(0, { numeric: 1 }).compare;
98
+
99
+ function semiver(a, b, bool) {
100
+ a = a.split(".");
101
+ b = b.split(".");
102
+
103
+ return (
104
+ fn(a[0], b[0]) ||
105
+ fn(a[1], b[1]) ||
106
+ ((b[2] = b.slice(2).join(".")),
107
+ (bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
108
+ bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
109
+ );
128
110
  }
129
111
 
130
- process.on("SIGINT", () => {
131
- wranglerProcess?.kill();
132
- });
133
- process.on("SIGTERM", () => {
134
- wranglerProcess?.kill();
135
- });
112
+ // end semiver implementation
136
113
 
137
- void main();
114
+ if (module === require.main) {
115
+ wranglerProcess = runWrangler();
116
+ process.on("SIGINT", () => {
117
+ wranglerProcess && wranglerProcess.kill();
118
+ });
119
+ process.on("SIGTERM", () => {
120
+ wranglerProcess && wranglerProcess.kill();
121
+ });
122
+ }