wrangler 0.0.0-feecc18 → 0.0.0-ff049092

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 (178) hide show
  1. package/README.md +47 -16
  2. package/bin/wrangler.js +90 -36
  3. package/config-schema.json +3058 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +139 -86
  6. package/templates/__tests__/pages-dev-util.test.ts +128 -0
  7. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  8. package/templates/__tests__/tsconfig.json +8 -0
  9. package/templates/checked-fetch.js +30 -0
  10. package/templates/facade.d.ts +19 -0
  11. package/templates/gitignore +170 -0
  12. package/templates/init-tests/test-jest-new-worker.js +23 -0
  13. package/templates/init-tests/test-vitest-new-worker.js +24 -0
  14. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  15. package/templates/middleware/common.ts +67 -0
  16. package/templates/middleware/loader-modules.ts +134 -0
  17. package/templates/middleware/loader-sw.ts +229 -0
  18. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  19. package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
  20. package/templates/middleware/middleware-pretty-error.ts +40 -0
  21. package/templates/middleware/middleware-scheduled.ts +15 -0
  22. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  23. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  24. package/templates/modules-watch-stub.js +4 -0
  25. package/templates/new-worker-scheduled.js +17 -0
  26. package/templates/new-worker-scheduled.ts +32 -0
  27. package/templates/new-worker.js +3 -3
  28. package/templates/new-worker.ts +22 -4
  29. package/templates/no-op-assets-worker.ts +33 -0
  30. package/templates/no-op-worker.js +10 -0
  31. package/templates/pages-dev-pipeline.ts +32 -0
  32. package/templates/pages-dev-util.ts +55 -0
  33. package/templates/pages-shim.ts +9 -0
  34. package/templates/pages-template-plugin.ts +190 -0
  35. package/templates/pages-template-worker.ts +198 -0
  36. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  37. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  38. package/templates/tsconfig-sanity.ts +11 -0
  39. package/templates/tsconfig.init.json +22 -0
  40. package/templates/tsconfig.json +6 -103
  41. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  42. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  43. package/wrangler-dist/ProxyWorker.js +242 -0
  44. package/wrangler-dist/ProxyWorker.js.map +6 -0
  45. package/wrangler-dist/cli.d.ts +26389 -0
  46. package/wrangler-dist/cli.js +201592 -133781
  47. package/wrangler-dist/wasm-sync.wasm +0 -0
  48. package/import_meta_url.js +0 -3
  49. package/miniflare-config-stubs/.env.empty +0 -0
  50. package/miniflare-config-stubs/package.empty.json +0 -1
  51. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  52. package/miniflare-dist/index.mjs +0 -79
  53. package/miniflare-dist/index.mjs.map +0 -7
  54. package/pages/functions/buildWorker.ts +0 -62
  55. package/pages/functions/filepath-routing.test.ts +0 -223
  56. package/pages/functions/filepath-routing.ts +0 -181
  57. package/pages/functions/identifiers.ts +0 -78
  58. package/pages/functions/routes.ts +0 -151
  59. package/pages/functions/template-worker.ts +0 -134
  60. package/src/__tests__/configuration.test.ts +0 -2992
  61. package/src/__tests__/dev.test.tsx +0 -620
  62. package/src/__tests__/guess-worker-format.test.ts +0 -83
  63. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  64. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  65. package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
  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 -211
  69. package/src/__tests__/helpers/mock-console.ts +0 -70
  70. package/src/__tests__/helpers/mock-dialogs.ts +0 -65
  71. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  72. package/src/__tests__/helpers/mock-istty.ts +0 -23
  73. package/src/__tests__/helpers/mock-kv.ts +0 -33
  74. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -186
  75. package/src/__tests__/helpers/mock-stdin.ts +0 -103
  76. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  77. package/src/__tests__/helpers/run-in-tmp.ts +0 -39
  78. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  79. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  80. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  81. package/src/__tests__/https-options.test.ts +0 -127
  82. package/src/__tests__/index.test.ts +0 -987
  83. package/src/__tests__/jest.setup.ts +0 -73
  84. package/src/__tests__/kv.test.ts +0 -1380
  85. package/src/__tests__/package-manager.test.ts +0 -206
  86. package/src/__tests__/pages.test.ts +0 -250
  87. package/src/__tests__/parse.test.ts +0 -322
  88. package/src/__tests__/publish.test.ts +0 -4166
  89. package/src/__tests__/r2.test.ts +0 -198
  90. package/src/__tests__/route.test.ts +0 -45
  91. package/src/__tests__/secret.test.ts +0 -425
  92. package/src/__tests__/sentry.test.ts +0 -146
  93. package/src/__tests__/tail.test.ts +0 -656
  94. package/src/__tests__/user.test.ts +0 -85
  95. package/src/__tests__/whoami.test.tsx +0 -95
  96. package/src/bundle.ts +0 -159
  97. package/src/cfetch/index.ts +0 -104
  98. package/src/cfetch/internal.ts +0 -139
  99. package/src/cli.ts +0 -21
  100. package/src/config/README.md +0 -107
  101. package/src/config/config.ts +0 -234
  102. package/src/config/diagnostics.ts +0 -80
  103. package/src/config/environment.ts +0 -389
  104. package/src/config/index.ts +0 -62
  105. package/src/config/validation-helpers.ts +0 -554
  106. package/src/config/validation.ts +0 -1352
  107. package/src/create-worker-preview.ts +0 -173
  108. package/src/create-worker-upload-form.ts +0 -240
  109. package/src/dev/dev.tsx +0 -415
  110. package/src/dev/local.tsx +0 -299
  111. package/src/dev/remote.tsx +0 -209
  112. package/src/dev/use-esbuild.ts +0 -113
  113. package/src/dialogs.tsx +0 -77
  114. package/src/entry.ts +0 -257
  115. package/src/environment-variables.ts +0 -33
  116. package/src/errors.ts +0 -11
  117. package/src/https-options.ts +0 -122
  118. package/src/index.tsx +0 -2420
  119. package/src/inspect.ts +0 -624
  120. package/src/intl-polyfill.d.ts +0 -139
  121. package/src/kv.ts +0 -319
  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 -38
  125. package/src/module-collection.ts +0 -257
  126. package/src/open-in-browser.ts +0 -25
  127. package/src/package-manager.ts +0 -126
  128. package/src/pages.tsx +0 -1265
  129. package/src/parse.ts +0 -183
  130. package/src/paths.ts +0 -26
  131. package/src/proxy.ts +0 -455
  132. package/src/publish.ts +0 -401
  133. package/src/r2.ts +0 -50
  134. package/src/reporting.ts +0 -146
  135. package/src/selfsigned.d.ts +0 -29
  136. package/src/sites.tsx +0 -280
  137. package/src/tail/filters.ts +0 -279
  138. package/src/tail/index.ts +0 -299
  139. package/src/tail/printing.ts +0 -62
  140. package/src/update-check.ts +0 -19
  141. package/src/user.tsx +0 -1154
  142. package/src/whoami.tsx +0 -69
  143. package/src/worker.ts +0 -172
  144. package/templates/static-asset-facade.js +0 -47
  145. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  146. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  147. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  148. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  149. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  150. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  151. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  152. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  153. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  154. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  155. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  156. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  157. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  158. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  159. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  160. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  161. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  162. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  163. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  164. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  165. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  166. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  167. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  168. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  169. package/vendor/wrangler-mime/LICENSE +0 -21
  170. package/vendor/wrangler-mime/Mime.js +0 -97
  171. package/vendor/wrangler-mime/README.md +0 -187
  172. package/vendor/wrangler-mime/cli.js +0 -46
  173. package/vendor/wrangler-mime/index.js +0 -4
  174. package/vendor/wrangler-mime/lite.js +0 -4
  175. package/vendor/wrangler-mime/package.json +0 -52
  176. package/vendor/wrangler-mime/types/other.js +0 -1
  177. package/vendor/wrangler-mime/types/standard.js +0 -1
  178. package/wrangler-dist/cli.js.map +0 -7
package/README.md CHANGED
@@ -1,46 +1,73 @@
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.cloudflare.com"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
7
+ </section>
2
8
 
3
9
  `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
4
10
 
5
- [(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/)
6
-
7
- **DISCLAIMER**: This is a work in progress, and is NOT recommended for use in production. We are opening this preview for feedback from the community, and to openly share our [roadmap](https://github.com/cloudflare/wrangler2/milestones) for the future. As such, expect APIs and documentation to change before the end of the preview.
8
-
9
- Further, we will NOT do a general release until we are both feature complete, and have a full backward compatibility and incremental migration plan in place. For more details, follow the [2.0 milestone](https://github.com/cloudflare/wrangler2/milestone/1).
10
-
11
11
  ## Quick Start
12
12
 
13
13
  ```bash
14
14
  # Make a javascript file
15
- $ echo "export default { fetch() { return new Response('hello world') } }" > index.js
15
+ echo "export default { fetch() { return new Response('hello world') } }" > index.js
16
16
  # try it out
17
- $ npx wrangler@beta dev index.js
18
- # and then publish it
19
- $ npx wrangler@beta publish index.js --name my-worker
17
+ npx wrangler dev index.js
18
+ # and then deploy it
19
+ npx wrangler deploy index.js --name my-worker
20
20
  # visit https://my-worker.<your workers subdomain>.workers.dev
21
21
  ```
22
22
 
23
+ ## Create a Project
24
+
25
+ ```bash
26
+ # Generate a new project
27
+ npx wrangler init my-worker --no-delegate-c3
28
+ # try it out
29
+ cd my-worker && npm run start
30
+ # and then deploy it
31
+ npm run deploy
32
+ ```
33
+
23
34
  ## Installation:
24
35
 
25
36
  ```bash
26
- $ npm install wrangler@beta
37
+ $ npm install wrangler --save-dev
27
38
  ```
28
39
 
40
+ ## Configuration:
41
+
42
+ 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.
43
+
44
+ Example:
45
+
46
+ ```toml
47
+ name = "my-worker"
48
+ main = "./src/index.ts" # init w/ TypeScript
49
+ compatibility_date = "YYYY-MM-DD"
50
+ ```
51
+
52
+ For more detailed information about configuration, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
53
+
29
54
  ## Commands
30
55
 
31
56
  ### `wrangler init [name]`
32
57
 
33
- Creates a `wrangler.toml` configuration file. For more details on the configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
58
+ Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).
34
59
 
35
- ### `wrangler dev [script]`
60
+ ### `wrangler dev`
36
61
 
37
62
  Start a local development server, with live reloading and devtools.
38
63
 
39
- ### `wrangler publish [script] --name [name]`
64
+ ### `wrangler deploy`
40
65
 
41
66
  Publish the given script to the worldwide Cloudflare network.
42
67
 
43
- For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
68
+ For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
69
+
70
+ ## Pages
44
71
 
45
72
  ### `wrangler pages dev [directory] [-- command]`
46
73
 
@@ -49,3 +76,7 @@ Either serves a static build asset directory, or proxies itself in front of a co
49
76
  Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.
50
77
 
51
78
  For more commands and options, refer to the [documentation](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`.
79
+
80
+ ## Documentation
81
+
82
+ For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
package/bin/wrangler.js CHANGED
@@ -1,45 +1,99 @@
1
1
  #!/usr/bin/env node
2
- const { spawn } = require("node:child_process");
3
- const { join } = require("node:path");
4
- const semiver = require("semiver");
2
+ const { spawn } = require("child_process");
3
+ const path = require("path");
4
+ const fs = require("fs");
5
+ const os = require("os");
5
6
 
6
- 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
+ : () => {};
7
12
 
8
13
  let wranglerProcess;
9
14
 
10
- async function main() {
11
- if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
12
- // Note Volta and nvm are also recommended in the official docs:
13
- // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
14
- console.error(
15
- `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
16
- You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
15
+ /**
16
+ * Executes ../wrangler-dist/cli.js
17
+ */
18
+ function runWrangler() {
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
+
17
25
  Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
18
- );
19
- process.exitCode = 1;
20
- return;
21
- }
22
-
23
- wranglerProcess = spawn(
24
- process.execPath,
25
- [
26
- "--no-warnings",
27
- "--experimental-vm-modules",
28
- ...process.execArgv,
29
- join(__dirname, "../wrangler-dist/cli.js"),
30
- ...process.argv.slice(2),
31
- ],
32
- { stdio: "inherit" }
33
- ).on("exit", (code) =>
34
- process.exit(code === undefined || code === null ? 0 : code)
35
- );
26
+ );
27
+ process.exitCode = 1;
28
+ return;
29
+ }
30
+
31
+ return spawn(
32
+ process.execPath,
33
+ [
34
+ "--no-warnings",
35
+ "--experimental-vm-modules",
36
+ ...process.execArgv,
37
+ path.join(__dirname, "../wrangler-dist/cli.js"),
38
+ ...process.argv.slice(2),
39
+ ],
40
+ {
41
+ stdio: ["inherit", "inherit", "inherit", "ipc"],
42
+ }
43
+ )
44
+ .on("exit", (code) =>
45
+ process.exit(code === undefined || code === null ? 0 : code)
46
+ )
47
+ .on("message", (message) => {
48
+ if (process.send) {
49
+ process.send(message);
50
+ }
51
+ })
52
+ .on("disconnect", () => {
53
+ if (process.disconnect) {
54
+ process.disconnect();
55
+ }
56
+ });
57
+ }
58
+
59
+ // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
60
+
61
+ /**
62
+ MIT License
63
+
64
+ Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
65
+
66
+ 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:
67
+
68
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
69
+
70
+ 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.
71
+
72
+ */
73
+
74
+ var fn = new Intl.Collator(0, { numeric: 1 }).compare;
75
+
76
+ function semiver(a, b, bool) {
77
+ a = a.split(".");
78
+ b = b.split(".");
79
+
80
+ return (
81
+ fn(a[0], b[0]) ||
82
+ fn(a[1], b[1]) ||
83
+ ((b[2] = b.slice(2).join(".")),
84
+ (bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
85
+ bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
86
+ );
36
87
  }
37
88
 
38
- process.on("SIGINT", () => {
39
- wranglerProcess.kill();
40
- });
41
- process.on("SIGTERM", () => {
42
- wranglerProcess.kill();
43
- });
89
+ // end semiver implementation
44
90
 
45
- void main();
91
+ if (module === require.main) {
92
+ wranglerProcess = runWrangler();
93
+ process.on("SIGINT", () => {
94
+ wranglerProcess && wranglerProcess.kill();
95
+ });
96
+ process.on("SIGTERM", () => {
97
+ wranglerProcess && wranglerProcess.kill();
98
+ });
99
+ }