chore: Update CLI option to disable using operationId for generating …

…operation names
7nohe · Oct 14, 2024 · a8f2935 · a8f2935
1 parent f65ac4e
commit a8f2935
Show file tree

Hide file tree

Showing 5 changed files with 157 additions and 9 deletions.
diff --git a/docs/src/content/docs/guides/cli-options.mdx b/docs/src/content/docs/guides/cli-options.mdx
@@ -57,9 +57,9 @@ The available options are:
 - `biome`
 - `eslint`
 
-### --operationId
+### --noOperationId
 
-Use operation ID to generate operation names? The default value is `true`.
+Do not use operation ID to generate operation names. The default value is `true`.
 
 ### --enums \<value\>
 

diff --git a/examples/react-app/package.json b/examples/react-app/package.json
@@ -9,7 +9,7 @@
     "dev:mock": "prism mock ../petstore.yaml --dynamic",
     "build": "tsc && vite build",
     "preview": "vite preview",
-    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../petstore.yaml --format=biome --lint=biome -c @hey-api/client-axios",
+    "generate:api": "rimraf ./openapi && node ../../dist/cli.mjs -i ../routes.json --format=biome --lint=biome -c @hey-api/client-axios",
     "test:generated": "tsc -p ./tsconfig.json --noEmit"
   },
   "dependencies": {

diff --git a/examples/routes.json b/examples/routes.json
@@ -0,0 +1,148 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "api",
+    "description": "",
+    "license": {
+      "name": ""
+    },
+    "version": "0.0.0"
+  },
+  "paths": {
+    "/api/v1/boards/export": {
+      "get": {
+        "tags": ["boards"],
+        "summary": "Returns an export of a collection of boards.",
+        "operationId": "export",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "description": "The name of the resultant file (including extension).",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "boards[]",
+            "in": "query",
+            "description": "The boards to be included in this export.",
+            "required": true,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/BoardId"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/octet-stream": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/v1/documents/{file}/export": {
+      "get": {
+        "tags": ["documents"],
+        "summary": "Exports the document as a PDF with annotations included.",
+        "operationId": "export",
+        "parameters": [
+          {
+            "name": "file",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/FileId"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/pdf": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/v1/tags/export": {
+      "get": {
+        "tags": ["tags"],
+        "summary": "Returns an export of a collection of tags.",
+        "operationId": "export",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "description": "The name of the resultant file (including extension).",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "tags[]",
+            "in": "query",
+            "description": "The tags to be included in this export.",
+            "required": true,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/TagId"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/octet-stream": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "BoardId": {
+        "type": "string",
+        "format": "base58 encoded UUID",
+        "example": "CBD7wDFfZFjQfkvZ5BfC9"
+      },
+      "FileId": {
+        "type": "string",
+        "format": "base58 encoded UUID",
+        "example": "CBD7wDFfZFjQfkvZ5BfC9"
+      },
+      "TagId": {
+        "type": "string",
+        "format": "base58 encoded UUID",
+        "example": "CBD7wDFfZFjQfkvZ5BfC9"
+      }
+    }
+  }
+}
diff --git a/src/cli.mts b/src/cli.mts
@@ -14,7 +14,7 @@ export type LimitedUserConfig = {
   client?: "@hey-api/client-fetch" | "@hey-api/client-axios";
   format?: "biome" | "prettier";
   lint?: "biome" | "eslint";
-  operationId?: boolean;
+  noOperationId?: boolean;
   enums?: "javascript" | "typescript" | false;
   useDateType?: boolean;
   debug?: boolean;
@@ -58,7 +58,10 @@ async function setupProgram() {
         "Process output folder with linter?",
       ).choices(["biome", "eslint"]),
     )
-    .option("--operationId", "Use operation ID to generate operation names?")
+    .option(
+      "--noOperationId",
+      "Do not use operationId to generate operation names",
+    )
     .addOption(
       new Option(
         "--enums <value>",

diff --git a/src/generate.mts b/src/generate.mts
@@ -31,10 +31,7 @@ export async function generate(options: LimitedUserConfig, version: string) {
     services: {
       export: true,
       asClass: false,
-      operationId:
-        formattedOptions.operationId !== undefined
-          ? formattedOptions.operationId
-          : true,
+      operationId: !formattedOptions.noOperationId,
     },
     types: {
       dates: formattedOptions.useDateType,