From b449ca39627dd1cc429e68dd83f2dc35862d892d Mon Sep 17 00:00:00 2001
From: Chris Rybicki <chrisr@wing.cloud>
Date: Tue, 3 Sep 2024 16:24:00 -0400
Subject: [PATCH] feat(cli): rename gen-docs command to docs

---
 docs/api/02-cli-user-manual.md                      |  6 +++---
 packages/@winglibs/testfixture/package.json         |  2 +-
 packages/winglang/package.json                      |  1 -
 packages/winglang/src/cli.ts                        |  8 +-------
 packages/winglang/src/commands/docs.test.ts         | 10 ----------
 packages/winglang/src/commands/docs.ts              |  5 -----
 packages/winglang/src/commands/generateDocs.test.ts |  2 +-
 packages/winglang/src/commands/index.ts             |  1 -
 8 files changed, 6 insertions(+), 29 deletions(-)
 delete mode 100644 packages/winglang/src/commands/docs.test.ts
 delete mode 100644 packages/winglang/src/commands/docs.ts

diff --git a/docs/api/02-cli-user-manual.md b/docs/api/02-cli-user-manual.md
index 4d78ae00a5b..1e9151f0750 100644
--- a/docs/api/02-cli-user-manual.md
+++ b/docs/api/02-cli-user-manual.md
@@ -242,14 +242,14 @@ This will compile your current Wing directory, and bundle it as a tarball that c
 
 See [Libraries](/docs/category/wing-libraries-winglibs) for more details on packaging and consuming Wing libraries.
 
-## Generate Docs: `wing gen-docs`
+## Generate Docs: `wing docs`
 
-The `wing gen-docs` command can be used to generate API documentation for your Wing project.
+The `wing docs` command can be used to generate API documentation for your Wing project.
 
 Usage:
 
 ```sh
-$ wing gen-docs
+$ wing docs
 ```
 
 This will generate a file named `API.md` in the root of your project.
diff --git a/packages/@winglibs/testfixture/package.json b/packages/@winglibs/testfixture/package.json
index a63fd6a79c0..8985479c936 100644
--- a/packages/@winglibs/testfixture/package.json
+++ b/packages/@winglibs/testfixture/package.json
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "compile": "wing compile .",
-    "test": "wing test && wing gen-docs"
+    "test": "wing test && wing docs"
   },
   "license": "MIT",
   "engines": {
diff --git a/packages/winglang/package.json b/packages/winglang/package.json
index 05e15f05a16..c63e2ce71d8 100644
--- a/packages/winglang/package.json
+++ b/packages/winglang/package.json
@@ -48,7 +48,6 @@
     "inquirer": "^8.2.6",
     "nanoid": "^3.3.7",
     "npm-packlist": "^8.0.2",
-    "open": "^8.4.2",
     "ora": "^5.4.1",
     "tar": "^6.2.1",
     "tiny-updater": "^3.5.2",
diff --git a/packages/winglang/src/cli.ts b/packages/winglang/src/cli.ts
index 5a86547c92b..7292e24b877 100644
--- a/packages/winglang/src/cli.ts
+++ b/packages/winglang/src/cli.ts
@@ -165,7 +165,7 @@ async function main() {
     .action(runSubCommand("lsp"));
 
   program
-    .command("gen-docs")
+    .command("docs")
     .description("Generate documentation for the current project")
     .hook("preAction", collectAnalyticsHook)
     .action(runSubCommand("generateDocs"));
@@ -276,12 +276,6 @@ async function main() {
     .hook("postAction", collectAnalyticsHook) // to catch the options that are added later
     .action(runSubCommand("init"));
 
-  program
-    .command("docs")
-    .description("Open the Wing documentation")
-    .hook("preAction", collectAnalyticsHook)
-    .action(runSubCommand("docs"));
-
   program.hook("postAction", exportAnalyticsHook);
 
   program.parse();
diff --git a/packages/winglang/src/commands/docs.test.ts b/packages/winglang/src/commands/docs.test.ts
deleted file mode 100644
index 83422ee1234..00000000000
--- a/packages/winglang/src/commands/docs.test.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import open from "open";
-import { vi, test, expect } from "vitest";
-import { docs } from "./docs";
-
-vi.mock("open");
-
-test("wing docs opens the docs website", async () => {
-  await docs();
-  expect(open).toBeCalledWith("https://www.winglang.io/docs/");
-});
diff --git a/packages/winglang/src/commands/docs.ts b/packages/winglang/src/commands/docs.ts
deleted file mode 100644
index 9884d8f692a..00000000000
--- a/packages/winglang/src/commands/docs.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import open from "open";
-
-export async function docs() {
-  await open("https://www.winglang.io/docs/");
-}
diff --git a/packages/winglang/src/commands/generateDocs.test.ts b/packages/winglang/src/commands/generateDocs.test.ts
index b69d81c092d..9cc1b5b2e27 100644
--- a/packages/winglang/src/commands/generateDocs.test.ts
+++ b/packages/winglang/src/commands/generateDocs.test.ts
@@ -5,7 +5,7 @@ import { generateDocs } from "./generateDocs";
 
 const fixturesDir = join(__dirname, "..", "..", "fixtures");
 
-describe("wing gen-docs", () => {
+describe("wing docs", () => {
   afterEach(() => {
     vi.restoreAllMocks();
   });
diff --git a/packages/winglang/src/commands/index.ts b/packages/winglang/src/commands/index.ts
index cbd2caad289..82b977eaeb9 100644
--- a/packages/winglang/src/commands/index.ts
+++ b/packages/winglang/src/commands/index.ts
@@ -1,5 +1,4 @@
 export * from "./compile";
 export * from "./upgrade";
 export * from "./test";
-export * from "./docs";
 export * from "./run";