wrangler 0.0.0-d504e34 → 0.0.0-d533f5ee7

package/README.md

@@ -1,50 +1,73 @@
-## 🤠 wrangler
+<h1 align="center"> ⛅️ wrangler </h1>
+<section align="center" id="shieldio-badges">
+<a href="https://www.npmjs.com/package/wrangler"><img alt="npm"  src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
+<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/workers-sdk?style=flat-square">
+<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/workers-sdk/main?style=flat-square">
+<a href="https://discord.cloudflare.com"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
+</section>
 
 `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
 
-[(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/)
-
-**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/issues/12) for the future. As such, expect APIs and documentation to change before the end of the preview.
-
-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 [parent roadmap issue](https://github.com/cloudflare/wrangler2/issues/12).
-
 ## Quick Start
 
+To get started quickly with a Hello World worker, run the command below:
+
 ```bash
-# Make a javascript file
-$ echo "export default { fetch() { return new Response('hello world') } }" > index.js
-# try it out
-$ npx wrangler@beta dev index.js
-# and then publish it
-$ npx wrangler@beta publish index.js --name my-worker
-# visit https://my-worker.<your workers subdomain>.workers.dev
+npx wrangler init my-worker -y
 ```
 
-## Installation:
+For more info, visit our [Getting Started](https://developers.cloudflare.com/workers/get-started/guide/) guide.
 
-```bash
-$ npm install wrangler@beta
+<details><summary>Wrangler System Requirements</summary>
+
+We support running the Wrangler CLI with the [Current, Active, and Maintenance](https://nodejs.org/en/about/previous-releases) versions of Node.js. Your Worker will always be executed in `workerd`, the open source Cloudflare Workers runtime.
+
+Wrangler is only supported on macOS 13.5+, Windows 11, and Linux distros that support glib 2.35. This follows [`workerd`'s OS support policy](https://github.com/cloudflare/workerd?tab=readme-ov-file#running-workerd).
+
+</details>
+
+## Documentation
+
+For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
+
+To read more about Workers in general:
+
+- [Getting Started](https://developers.cloudflare.com/workers/get-started/guide/)
+- [How Workers works](https://developers.cloudflare.com/workers/reference/how-workers-works/)
+- [Observability](https://developers.cloudflare.com/workers/observability/)
+- [Platform](https://developers.cloudflare.com/workers/platform/)
+
+## Configuration
+
+Wrangler is configured via a `wrangler.toml` or `wrangler.json` file in the project root. An example configuration generated by `npx wrangler init` or `npx create cloudflare` is as follows:
+
+```toml
+name = "my-worker"
+main = "./src/index.ts"
+compatibility_date = "YYYY-MM-DD"
 ```
 
-## Commands
+For more detailed information about configuration, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
 
-### `wrangler init [name]`
+## Commands
 
-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).
+### Workers
 
-### `wrangler dev [script]`
+#### `wrangler dev`
 
 Start a local development server, with live reloading and devtools.
 
-### `wrangler publish [script] --name [name]`
+#### `wrangler deploy`
+
+Publish the given script to Cloudflare's global network.
 
-Publish the given script to the worldwide Cloudflare network.
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
 
-For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
+### Pages
 
-### `wrangler pages dev [directory] [-- command]`
+#### `wrangler pages dev [directory]`
 
-Either serves a static build asset directory, or proxies itself in front of a command.
+Serves a static build asset directory.
 
 Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.
 

package/bin/wrangler.js

@@ -1,36 +1,93 @@
 #!/usr/bin/env node
-const { spawn } = require("node:child_process");
-const { join } = require("node:path");
-const semiver = require("semiver");
-
-const MIN_NODE_VERSION = "16.7.0";
-
-async function main() {
-  if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
-    // Note Volta and nvm are also recommended in the official docs:
-    // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
-    console.error(
-      `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
-You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
+const { spawn } = require("child_process");
+const path = require("path");
+
+const MIN_NODE_VERSION = "18.0.0";
+
+let wranglerProcess;
+
+/**
+ * Executes ../wrangler-dist/cli.js
+ */
+function runWrangler() {
+	if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
+		// Note Volta and nvm are also recommended in the official docs:
+		// https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
+		console.error(
+			`Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of Node.js.
+
 Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
-    );
-    process.exitCode = 1;
-    return;
-  }
-
-  spawn(
-    process.execPath,
-    [
-      "--no-warnings",
-      "--experimental-vm-modules",
-      ...process.execArgv,
-      join(__dirname, "../wrangler-dist/cli.js"),
-      ...process.argv.slice(2),
-    ],
-    { stdio: "inherit" }
-  ).on("exit", (code) =>
-    process.exit(code === undefined || code === null ? 0 : code)
-  );
+		);
+		process.exitCode = 1;
+		return;
+	}
+
+	return spawn(
+		process.execPath,
+		[
+			"--no-warnings",
+			"--experimental-vm-modules",
+			...process.execArgv,
+			path.join(__dirname, "../wrangler-dist/cli.js"),
+			...process.argv.slice(2),
+		],
+		{
+			stdio: ["inherit", "inherit", "inherit", "ipc"],
+		}
+	)
+		.on("exit", (code) =>
+			process.exit(code === undefined || code === null ? 0 : code)
+		)
+		.on("message", (message) => {
+			if (process.send) {
+				process.send(message);
+			}
+		})
+		.on("disconnect", () => {
+			if (process.disconnect) {
+				process.disconnect();
+			}
+		});
+}
+
+// semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
+
+/**
+MIT License
+
+Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.
+
+ */
+
+var fn = new Intl.Collator(0, { numeric: 1 }).compare;
+
+function semiver(a, b, bool) {
+	a = a.split(".");
+	b = b.split(".");
+
+	return (
+		fn(a[0], b[0]) ||
+		fn(a[1], b[1]) ||
+		((b[2] = b.slice(2).join(".")),
+		(bool = /[.-]/.test((a[2] = a.slice(2).join(".")))),
+		bool == /[.-]/.test(b[2]) ? fn(a[2], b[2]) : bool ? -1 : 1)
+	);
 }
 
-void main();
+// end semiver implementation
+
+if (module === require.main) {
+	wranglerProcess = runWrangler();
+	process.on("SIGINT", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+	process.on("SIGTERM", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+}