wrangler 0.0.0-e5182f6 → 0.0.0-e51a43c7

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 (85) hide show
  1. package/README.md +82 -0
  2. package/bin/wrangler.js +99 -2
  3. package/config-schema.json +2939 -0
  4. package/kv-asset-handler.js +1 -0
  5. package/package.json +151 -43
  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 +167 -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 +15 -0
  28. package/templates/new-worker.ts +33 -0
  29. package/templates/no-op-worker.js +10 -0
  30. package/templates/pages-dev-pipeline.ts +32 -0
  31. package/templates/pages-dev-util.ts +55 -0
  32. package/templates/pages-shim.ts +9 -0
  33. package/templates/pages-template-plugin.ts +190 -0
  34. package/templates/pages-template-worker.ts +198 -0
  35. package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
  36. package/templates/startDevWorker/ProxyWorker.ts +334 -0
  37. package/templates/tsconfig-sanity.ts +11 -0
  38. package/templates/tsconfig.init.json +105 -0
  39. package/templates/tsconfig.json +8 -0
  40. package/wrangler-dist/InspectorProxyWorker.js +464 -0
  41. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  42. package/wrangler-dist/ProxyWorker.js +240 -0
  43. package/wrangler-dist/ProxyWorker.js.map +6 -0
  44. package/wrangler-dist/cli.d.ts +24056 -0
  45. package/wrangler-dist/cli.js +208077 -0
  46. package/wrangler-dist/wasm-sync.wasm +0 -0
  47. package/miniflare-config-stubs/.env.empty +0 -0
  48. package/miniflare-config-stubs/package.empty.json +0 -1
  49. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  50. package/static-asset-facade.js +0 -47
  51. package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
  52. package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
  53. package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
  54. package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
  55. package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
  56. package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
  57. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
  58. package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
  59. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
  60. package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
  61. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
  62. package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
  63. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
  64. package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
  65. package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
  66. package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
  67. package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
  68. package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
  69. package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
  70. package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
  71. package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
  72. package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
  73. package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
  74. package/vendor/wrangler-mime/CHANGELOG.md +0 -289
  75. package/vendor/wrangler-mime/LICENSE +0 -21
  76. package/vendor/wrangler-mime/Mime.js +0 -97
  77. package/vendor/wrangler-mime/README.md +0 -187
  78. package/vendor/wrangler-mime/cli.js +0 -46
  79. package/vendor/wrangler-mime/index.js +0 -4
  80. package/vendor/wrangler-mime/lite.js +0 -4
  81. package/vendor/wrangler-mime/package.json +0 -52
  82. package/vendor/wrangler-mime/types/other.js +0 -1
  83. package/vendor/wrangler-mime/types/standard.js +0 -1
  84. package/wrangler-dist/index_node.js +0 -102145
  85. package/wrangler-dist/index_node.js.map +0 -7
package/README.md ADDED
@@ -0,0 +1,82 @@
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>
8
+
9
+ `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
10
+
11
+ ## Quick Start
12
+
13
+ ```bash
14
+ # Make a javascript file
15
+ echo "export default { fetch() { return new Response('hello world') } }" > index.js
16
+ # try it out
17
+ npx wrangler dev index.js
18
+ # and then deploy it
19
+ npx wrangler deploy index.js --name my-worker
20
+ # visit https://my-worker.<your workers subdomain>.workers.dev
21
+ ```
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
+
34
+ ## Installation:
35
+
36
+ ```bash
37
+ $ npm install wrangler --save-dev
38
+ ```
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
+
54
+ ## Commands
55
+
56
+ ### `wrangler init [name]`
57
+
58
+ Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).
59
+
60
+ ### `wrangler dev`
61
+
62
+ Start a local development server, with live reloading and devtools.
63
+
64
+ ### `wrangler deploy`
65
+
66
+ Publish the given script to the worldwide Cloudflare network.
67
+
68
+ For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
69
+
70
+ ## Pages
71
+
72
+ ### `wrangler pages dev [directory] [-- command]`
73
+
74
+ Either serves a static build asset directory, or proxies itself in front of a command.
75
+
76
+ Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.
77
+
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,2 +1,99 @@
1
- #!/usr/bin/env node --no-warnings --experimental-vm-modules
2
- require("../wrangler-dist/index_node.js");
1
+ #!/usr/bin/env node
2
+ const { spawn } = require("child_process");
3
+ const path = require("path");
4
+ const fs = require("fs");
5
+ const os = require("os");
6
+
7
+ const MIN_NODE_VERSION = "16.13.0";
8
+ const debug =
9
+ process.env["WRANGLER_LOG"] === "debug"
10
+ ? (...args) => console.log(...args)
11
+ : () => {};
12
+
13
+ let wranglerProcess;
14
+
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
+
25
+ Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
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
+ );
87
+ }
88
+
89
+ // end semiver implementation
90
+
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
+ }