feat(cli)!: rename gen-docs command to docs (#7071)

winglang · Sep 3, 2024 · cc77a45 · cc77a45
1 parent fb852cf
commit cc77a45
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 45 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git a/packages/winglang/src/commands/docs.ts b/packages/winglang/src/commands/docs.ts
diff --git 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
@@ -1,5 +1,4 @@
 export * from "./compile";
 export * from "./upgrade";
 export * from "./test";
-export * from "./docs";
 export * from "./run";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml