wrangler 0.0.0-d3ae16cf → 0.0.0-d422c8ecb

package/README.md

@@ -1,70 +1,70 @@
 <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/wrangler2?style=flat-square">
-<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/wrangler2/main?style=flat-square">
-<a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&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>
 
-> 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.
-
 `wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
 
+> [!WARNING]
+>
+> Wrangler v2 is **only receiving critical security updates.** We recommend you [migrate to Wrangler v3](https://developers.cloudflare.com/workers/wrangler/migration/update-v2-to-v3/) if you can.
+
 ## 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 dev index.js
-# and then publish it
-npx wrangler publish index.js --name my-worker
-# visit https://my-worker.<your workers subdomain>.workers.dev
+npx wrangler init my-worker -y
 ```
 
-## Create a Project
+For more info, visit our [Getting Started](https://developers.cloudflare.com/workers/get-started/guide/) guide.
 
-```bash
-# Generate a new project
-npx wrangler init my-worker
-# try it out
-cd my-worker && npm run start
-# and then publish it
-npm run deploy
-```
+## Documentation
 
-## Installation:
+For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).
 
-```bash
-$ npm install wrangler --save-dev
+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 Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
+### Workers
 
-### `wrangler dev`
+#### `wrangler dev`
 
 Start a local development server, with live reloading and devtools.
 
-### `wrangler publish`
+#### `wrangler deploy`
 
-Publish the given script to the worldwide Cloudflare network.
+Publish the given script to Cloudflare's global network.
 
-For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).
 
-## Pages
+### 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.
 
 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`.
-
-## Documentation
-
-For the latest Wrangler documentation, [click here](https://6b05b6e1.cloudflare-docs-7ou.pages.dev/workers/wrangler/).

package/bin/wrangler.js

@@ -1,14 +1,8 @@
 #!/usr/bin/env node
 const { spawn } = require("child_process");
 const path = require("path");
-const fs = require("fs");
-const os = require("os");
 
-const MIN_NODE_VERSION = "16.7.0";
-const debug =
-	process.env["WRANGLER_LOG"] === "debug"
-		? (...args) => console.log(...args)
-		: () => {};
+const MIN_NODE_VERSION = "16.13.0";
 
 let wranglerProcess;
 
@@ -20,7 +14,7 @@ function runWrangler() {
 		// 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.
+			`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.`
 		);
@@ -28,30 +22,6 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
 		return;
 	}
 
-	let pathToCACerts = process.env.NODE_EXTRA_CA_CERTS;
-	if (pathToCACerts) {
-		// TODO:
-		// - should we log a warning here?
-		// - maybe we can generate a certificate that concatenates with ours?
-		//
-		//  I do think it'll be rare that someone wants to add a cert AND
-		//  use cloudflare WARP, but let's wait till the situation actually
-		//  arises before we do anything about it
-	} else {
-		const osTempDir = os.tmpdir();
-		const certDir = path.join(osTempDir, "wrangler-cert");
-		const certPath = path.join(certDir, "Cloudflare_CA.pem");
-		// copy cert to the system temp dir if needed
-		if (!fs.existsSync(certPath)) {
-			fs.mkdirSync(certDir, { recursive: true });
-			fs.writeFileSync(
-				certPath,
-				fs.readFileSync(path.join(__dirname, "../Cloudflare_CA.pem"), "utf-8")
-			);
-		}
-		pathToCACerts = certPath;
-	}
-
 	return spawn(
 		process.execPath,
 		[
@@ -62,77 +32,24 @@ Consider using a Node.js version manager such as https://volta.sh/ or https://gi
 			...process.argv.slice(2),
 		],
 		{
-			stdio: "inherit",
-			env: {
-				...process.env,
-				NODE_EXTRA_CA_CERTS: pathToCACerts,
-			},
+			stdio: ["inherit", "inherit", "inherit", "ipc"],
 		}
-	).on("exit", (code) =>
-		process.exit(code === undefined || code === null ? 0 : code)
-	);
-}
-
-/**
- * Runs a locally-installed version of wrangler, delegating from this version.
- * @throws {MODULE_NOT_FOUND} if there isn't a locally installed version of wrangler.
- */
-function runDelegatedWrangler() {
-	const packageJsonPath = require.resolve("wrangler/package.json", {
-		paths: [process.cwd()],
-	});
-	const {
-		bin: { wrangler: binaryPath },
-		version,
-	} = JSON.parse(fs.readFileSync(packageJsonPath));
-	const resolvedBinaryPath = path.resolve(packageJsonPath, "..", binaryPath);
-
-	debug(`Delegating to locally-installed version of wrangler @ v${version}`);
-
-	// this call to `spawn` is simpler because the delegated version will do all
-	// of the other work.
-	return spawn(
-		process.execPath,
-		[resolvedBinaryPath, ...process.argv.slice(2)],
-		{
-			stdio: "inherit",
-		}
-	).on("exit", (code) =>
-		process.exit(code === undefined || code === null ? 0 : code)
-	);
-}
-
-/**
- * Indicates if this invocation of `wrangler` should delegate
- * to a locally-installed version.
- */
-function shouldDelegate() {
-	try {
-		// `require.resolve` will throw if it can't find
-		// a locally-installed version of `wrangler`
-		const delegatedPackageJson = require.resolve("wrangler/package.json", {
-			paths: [process.cwd()],
+	)
+		.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();
+			}
 		});
-		const thisPackageJson = path.resolve(__dirname, "..", "package.json");
-		// if it's the same path, then we're already a local install -- no need to delegate
-		return thisPackageJson !== delegatedPackageJson;
-	} catch (e) {
-		// there's no local version to delegate to -- `require.resolve` threw
-		return false;
-	}
 }
 
-async function main() {
-	wranglerProcess = shouldDelegate() ? runDelegatedWrangler() : runWrangler();
-}
-
-process.on("SIGINT", () => {
-	wranglerProcess && wranglerProcess.kill();
-});
-process.on("SIGTERM", () => {
-	wranglerProcess && wranglerProcess.kill();
-});
-
 // semiver implementation via https://github.com/lukeed/semiver/blob/ae7eebe6053c96be63032b14fb0b68e2553fcac4/src/index.js
 
 /**
@@ -165,4 +82,12 @@ function semiver(a, b, bool) {
 
 // end semiver implementation
 
-void main();
+if (module === require.main) {
+	wranglerProcess = runWrangler();
+	process.on("SIGINT", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+	process.on("SIGTERM", () => {
+		wranglerProcess && wranglerProcess.kill();
+	});
+}