Sort the CLI arguments alphabetically

Signed-off-by: Sora Morimoto <[email protected]>

Author: smorimoto

.changeset/wicked-lemons-refuse.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+Sort the CLI arguments alphabetically.

index.ts

@@ -25,6 +25,11 @@ const generateTemplatesCommand = defineCommand({
         "clean output folder before generate template. WARNING: May cause data loss",
       default: templateGenBaseConfig.cleanOutput,
     },
+    debug: {
+      type: "boolean",
+      description: "additional information about processes inside this tool",
+      default: templateGenBaseConfig.debug,
+    },
     "http-client": {
       type: "string",
       description: `http client type (possible values: ${Object.values(
@@ -56,11 +61,6 @@ const generateTemplatesCommand = defineCommand({
       description: "Output only errors to console",
       default: templateGenBaseConfig.silent,
     },
-    debug: {
-      type: "boolean",
-      description: "additional information about processes inside this tool",
-      default: templateGenBaseConfig.debug,
-    },
   },
   run: async ({ args }) => {
     await generateTemplates({
@@ -83,80 +83,86 @@ const generateCommand = defineCommand({
     description: packageJson.description,
   },
   args: {
-    path: {
-      type: "string",
-      alias: "p",
-      description: "path/url to swagger scheme",
-      required: true,
-    },
-    output: {
-      type: "string",
-      alias: "o",
-      description: "output path of typescript api file",
-      default: "./",
+    "add-readonly": {
+      type: "boolean",
+      description: "generate readonly properties",
+      default: codeGenBaseConfig.addReadonly,
     },
-    name: {
-      type: "string",
-      alias: "n",
-      description: "name of output typescript api file",
-      default: codeGenBaseConfig.fileName,
+    "another-array-type": {
+      type: "boolean",
+      description: "generate array types as Array<Type> (by default Type[])",
+      default: codeGenBaseConfig.anotherArrayType,
     },
-    templates: {
+    "api-class-name": {
       type: "string",
-      alias: "t",
-      description: "path to folder containing templates",
+      description: "name of the api class",
+      default: codeGenBaseConfig.apiClassName,
     },
-    "default-as-success": {
+    axios: {
       type: "boolean",
-      alias: "d",
-      description:
-        'use "default" response status code as success response too. some swagger schemas use "default" response status code as success response type by default.',
-      default: codeGenBaseConfig.defaultResponseAsSuccess,
+      description: "generate axios http client",
+      default: false,
     },
-    responses: {
+    "clean-output": {
       type: "boolean",
-      alias: "r",
       description:
-        "generate additional information about request responses also add typings for bad responses",
-      default: codeGenBaseConfig.generateResponses,
+        "clean output folder before generate api. WARNING: May cause data loss",
+      default: codeGenBaseConfig.cleanOutput,
     },
-    "union-enums": {
+    client: {
       type: "boolean",
-      description: 'generate all "enum" types as union types (T1 | T2 | TN)',
-      default: codeGenBaseConfig.generateUnionEnums,
+      description: "do not generate an API class",
+      default: codeGenBaseConfig.generateClient,
     },
-    "add-readonly": {
+    "custom-config": {
+      type: "string",
+      description: "custom config: primitiveTypeConstructs, hooks, ... ",
+    },
+    debug: {
       type: "boolean",
-      description: "generate readonly properties",
-      default: codeGenBaseConfig.addReadonly,
+      description: "additional information about processes inside this tool",
+      default: codeGenBaseConfig.debug,
     },
-    "route-types": {
+    "default-as-success": {
       type: "boolean",
-      description: "generate type definitions for API routes",
-      default: codeGenBaseConfig.generateRouteTypes,
+      alias: "d",
+      description:
+        'use "default" response status code as success response too. some swagger schemas use "default" response status code as success response type by default.',
+      default: codeGenBaseConfig.defaultResponseAsSuccess,
     },
-    client: {
+    "default-response": {
+      type: "string",
+      description: "default type for empty response schema",
+      default: codeGenBaseConfig.defaultResponseType,
+    },
+    "disable-throw-on-error": {
       type: "boolean",
-      description: "do not generate an API class",
-      default: codeGenBaseConfig.generateClient,
+      description: "Do not throw an error when response.ok is not true",
+      default: codeGenBaseConfig.disableThrowOnError,
     },
     "enum-names-as-values": {
       type: "boolean",
       description:
         "use values in 'x-enumNames' as enum values (not only as keys)",
       default: codeGenBaseConfig.enumNamesAsValues,
     },
-    "extract-request-params": {
+    "extract-enums": {
       type: "boolean",
       description:
-        "extract request params to data contract (Also combine path params and query params into one object)",
-      default: codeGenBaseConfig.extractRequestParams,
+        "extract all enums from inline interface/type content to typescript enum construction",
+      default: codeGenBaseConfig.extractEnums,
     },
     "extract-request-body": {
       type: "boolean",
       description: "extract request body type to data contract",
       default: codeGenBaseConfig.extractRequestBody,
     },
+    "extract-request-params": {
+      type: "boolean",
+      description:
+        "extract request params to data contract (Also combine path params and query params into one object)",
+      default: codeGenBaseConfig.extractRequestParams,
+    },
     "extract-response-body": {
       type: "boolean",
       description: "extract response body type to data contract",
@@ -172,57 +178,98 @@ const generateCommand = defineCommand({
       description: "extract all responses described in /components/responses",
       default: codeGenBaseConfig.extractResponses,
     },
+    "generate-union-enums": {
+      type: "boolean",
+      description: 'generate all "enum" types as union types (T1 | T2 | TN)',
+      default: codeGenBaseConfig.generateUnionEnums,
+    },
+    "http-client": {
+      type: "string",
+      description: `http client type (possible values: ${Object.values(
+        HTTP_CLIENT,
+      )})`,
+    },
+    js: {
+      type: "boolean",
+      description: "generate js api module with declaration file",
+      default: codeGenBaseConfig.toJS,
+    },
     modular: {
       type: "boolean",
       description:
         "generate separated files for http client, data contracts, and routes",
       default: codeGenBaseConfig.modular,
     },
-    js: {
+    "module-name-first-tag": {
       type: "boolean",
-      description: "generate js api module with declaration file",
-      default: codeGenBaseConfig.toJS,
+      description: "splits routes based on the first tag",
+      default: codeGenBaseConfig.moduleNameFirstTag,
     },
     "module-name-index": {
       type: "string",
       description:
         "determines which path index should be used for routes separation (example: GET:/fruits/getFruit -> index:0 -> moduleName -> fruits)",
       default: codeGenBaseConfig.moduleNameIndex.toString(),
     },
-    "module-name-first-tag": {
+    name: {
+      type: "string",
+      alias: "n",
+      description: "name of output typescript api file",
+      default: codeGenBaseConfig.fileName,
+    },
+    output: {
+      type: "string",
+      alias: "o",
+      description: "output path of typescript api file",
+      default: "./",
+    },
+    patch: {
       type: "boolean",
-      description: "splits routes based on the first tag",
-      default: codeGenBaseConfig.moduleNameFirstTag,
+      description: "fix up small errors in the swagger source definition",
+      default: codeGenBaseConfig.patch,
     },
-    axios: {
+    path: {
+      type: "string",
+      alias: "p",
+      description: "path/url to swagger scheme",
+      required: true,
+    },
+    responses: {
       type: "boolean",
-      description: "generate axios http client",
-      default: false,
+      alias: "r",
+      description:
+        "generate additional information about request responses also add typings for bad responses",
+      default: codeGenBaseConfig.generateResponses,
     },
-    "unwrap-response-data": {
+    "route-types": {
       type: "boolean",
-      description: "unwrap the data item from the response",
-      default: codeGenBaseConfig.unwrapResponseData,
+      description: "generate type definitions for API routes",
+      default: codeGenBaseConfig.generateRouteTypes,
     },
-    "disable-throw-on-error": {
+    silent: {
       type: "boolean",
-      description: "Do not throw an error when response.ok is not true",
-      default: codeGenBaseConfig.disableThrowOnError,
+      description: "Output only errors to console",
+      default: codeGenBaseConfig.silent,
     },
     "single-http-client": {
       type: "boolean",
       description: "Ability to send HttpClient instance to Api constructor",
       default: codeGenBaseConfig.singleHttpClient,
     },
-    silent: {
+    "sort-routes": {
       type: "boolean",
-      description: "Output only errors to console",
-      default: codeGenBaseConfig.silent,
+      description: "sort routes in alphabetical order",
+      default: codeGenBaseConfig.sortRoutes,
     },
-    "default-response": {
+    "sort-types": {
+      type: "boolean",
+      description: "sort fields and types",
+      default: codeGenBaseConfig.sortTypes,
+    },
+    templates: {
       type: "string",
-      description: "default type for empty response schema",
-      default: codeGenBaseConfig.defaultResponseType,
+      alias: "t",
+      description: "path to folder containing templates",
     },
     "type-prefix": {
       type: "string",
@@ -234,51 +281,15 @@ const generateCommand = defineCommand({
       description: "data contract name suffix",
       default: codeGenBaseConfig.typeSuffix,
     },
-    "clean-output": {
-      type: "boolean",
-      description:
-        "clean output folder before generate api. WARNING: May cause data loss",
-      default: codeGenBaseConfig.cleanOutput,
-    },
-    "api-class-name": {
-      type: "string",
-      description: "name of the api class",
-      default: codeGenBaseConfig.apiClassName,
-    },
-    patch: {
-      type: "boolean",
-      description: "fix up small errors in the swagger source definition",
-      default: codeGenBaseConfig.patch,
-    },
-    debug: {
-      type: "boolean",
-      description: "additional information about processes inside this tool",
-      default: codeGenBaseConfig.debug,
-    },
-    "another-array-type": {
-      type: "boolean",
-      description: "generate array types as Array<Type> (by default Type[])",
-      default: codeGenBaseConfig.anotherArrayType,
-    },
-    "sort-types": {
-      type: "boolean",
-      description: "sort fields and types",
-      default: codeGenBaseConfig.sortTypes,
-    },
-    "extract-enums": {
+    "union-enums": {
       type: "boolean",
-      description:
-        "extract all enums from inline interface/type content to typescript enum construction",
-      default: codeGenBaseConfig.extractEnums,
+      description: 'generate all "enum" types as union types (T1 | T2 | TN)',
+      default: codeGenBaseConfig.generateUnionEnums,
     },
-    "sort-routes": {
+    "unwrap-response-data": {
       type: "boolean",
-      description: "sort routes in alphabetical order",
-      default: codeGenBaseConfig.sortRoutes,
-    },
-    "custom-config": {
-      type: "string",
-      description: "custom config: primitiveTypeConstructs, hooks, ... ",
+      description: "unwrap the data item from the response",
+      default: codeGenBaseConfig.unwrapResponseData,
     },
   },
   run: async ({ args }) => {

src/commands/generate-templates/configuration.ts

@@ -7,12 +7,12 @@ import { objectAssign } from "../../util/object-assign.js";
 
 export class TemplatesGenConfig {
   cleanOutput = false;
-  output = undefined;
+  debug = false;
   httpClientType: HttpClientType = HTTP_CLIENT.FETCH;
   modular = false;
+  output = undefined;
   rewrite = false;
   silent = false;
-  debug = false;
   version = PROJECT_VERSION;
 
   constructor(config: GenerateTemplatesParams) {