chore: refactor docs command (#2364)

* chore: refactor docs command * implement wrangler docs <comand> * Create kind-students-doubt.md * Update kind-students-doubt.md * Update index.test.ts
cloudflare · Dec 9, 2022 · 4bdb1f6 · 4bdb1f6
1 parent 8173bcc
commit 4bdb1f6
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 16 deletions.
diff --git a/.changeset/kind-students-doubt.md b/.changeset/kind-students-doubt.md
@@ -0,0 +1,7 @@
+---
+"wrangler": patch
+---
+
+fix: implement `wrangler docs <command>`
+
+closes #2359
diff --git a/packages/wrangler/src/__tests__/index.test.ts b/packages/wrangler/src/__tests__/index.test.ts
@@ -31,7 +31,7 @@ describe("wrangler", () => {
 			"wrangler
 
 			Commands:
-			  wrangler docs                📚 Open wrangler's docs in your browser
+			  wrangler docs [command]      📚 Open wrangler's docs in your browser
 			  wrangler init [name]         📥 Create a wrangler.toml configuration file
 			  wrangler dev [script]        👂 Start a local server for developing your worker
 			  wrangler publish [script]    🆙 Publish your Worker to Cloudflare.
@@ -78,7 +78,7 @@ describe("wrangler", () => {
 			wrangler
 
 			Commands:
-			  wrangler docs                📚 Open wrangler's docs in your browser
+			  wrangler docs [command]      📚 Open wrangler's docs in your browser
 			  wrangler init [name]         📥 Create a wrangler.toml configuration file
 			  wrangler dev [script]        👂 Start a local server for developing your worker
 			  wrangler publish [script]    🆙 Publish your Worker to Cloudflare.

diff --git a/packages/wrangler/src/docs/index.ts b/packages/wrangler/src/docs/index.ts
@@ -0,0 +1,94 @@
+import { printWranglerBanner } from "..";
+import { readConfig } from "../config";
+import { logger } from "../logger";
+import * as metrics from "../metrics";
+import openInBrowser from "../open-in-browser";
+
+import type {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "../yargs-types";
+import type { ArgumentsCamelCase, Argv } from "yargs";
+
+const argToUrlHash = {
+	init: "init",
+	generate: "generate",
+	dev: "dev",
+	publish: "publish",
+	delete: "delete",
+	"kv:namespace": "kvnamespace",
+	"kv:key": "kvkey",
+	"kv:bulk": "kvbulk",
+	"r2 bucket": "r2-bucket",
+	"r2 object": "r2-object",
+	secret: "secret",
+	"secret:bulk": "secretbulk",
+	tail: "tail",
+	pages: "pages",
+	login: "login",
+	logout: "logout",
+	whoami: "whoami",
+	types: "types",
+	deployments: "deployments",
+};
+
+export function docsOptions(yargs: Argv<CommonYargsOptions>) {
+	return yargs.positional("command", {
+		describe: "Enter the wrangler command you want to know more about",
+		type: "string",
+		// requiresArg: true,
+		choices: [
+			"init",
+			"dev",
+			"publish",
+			"delete",
+			"tail",
+			"secret",
+			"secret:bulk",
+			"kv:namespace",
+			"kv:key",
+			"kv:bulk",
+			"pages",
+			// "queues", //TODO: Undocumented
+			"r2 object",
+			"r2 bucket",
+			// "dispatch-namespace", // TODO: Undocumented - Workers for Platforms
+			// "d1", //TODO: Undocumented
+			// "pubsub", //TODO: Undocumented
+			"login",
+			"logout",
+			"whoami",
+			"types",
+			"deployments",
+			"api",
+		],
+	});
+}
+
+type DocsArgs = YargsOptionsToInterface<typeof docsOptions>;
+
+function isValidParam(k: string): k is keyof typeof argToUrlHash {
+	return k in argToUrlHash;
+}
+
+export async function docsHandler(args: ArgumentsCamelCase<DocsArgs>) {
+	let urlToOpen =
+		"https://developers.cloudflare.com/workers/wrangler/commands/";
+
+	if (args.command === "api") {
+		//if api, take them to the API docs
+		urlToOpen = "https://developers.cloudflare.com/workers/wrangler/api/";
+	} else if (args.command && isValidParam(args.command)) {
+		//otherwise, they get the wrangler commands page
+		urlToOpen += `#${argToUrlHash[args.command]}`;
+	}
+
+	await printWranglerBanner();
+
+	logger.log(`Opening a link in your default browser: ${urlToOpen}`);
+	await openInBrowser(urlToOpen);
+	const config = readConfig(undefined, {});
+	await metrics.sendMetricsEvent("view docs", {
+		sendMetrics: config.send_metrics,
+	});
+}
diff --git a/packages/wrangler/src/index.tsx b/packages/wrangler/src/index.tsx
@@ -26,11 +26,11 @@ import {
 } from "./deprecated";
 import { devHandler, devOptions } from "./dev";
 import { workerNamespaceCommands } from "./dispatch-namespace";
+import { docsHandler, docsOptions } from "./docs";
 import { initHandler, initOptions } from "./init";
 import { kvNamespace, kvKey, kvBulk } from "./kv";
 import { logBuildFailure, logger } from "./logger";
 import * as metrics from "./metrics";
-import openInBrowser from "./open-in-browser";
 import { pages } from "./pages";
 import { formatMessage, ParseError } from "./parse";
 import { publishOptions, publishHandler } from "./publish";
@@ -277,20 +277,10 @@ export function createCLIParser(argv: string[]) {
 
 	// docs
 	wrangler.command(
-		"docs",
+		"docs [command]",
 		"📚 Open wrangler's docs in your browser",
-		() => {},
-		async () => {
-			await printWranglerBanner();
-			const urlToOpen =
-				"https://developers.cloudflare.com/workers/wrangler/commands/";
-			logger.log(`Opening a link in your default browser: ${urlToOpen}`);
-			await openInBrowser(urlToOpen);
-			const config = readConfig(undefined, {});
-			await metrics.sendMetricsEvent("view docs", {
-				sendMetrics: config.send_metrics,
-			});
-		}
+		docsOptions,
+		docsHandler
 	);
 
 	// init