Merge pull request #36 from poviolabs/feature/file-config

Add file config & Update lint

Author: monikaboz

.eslintrc.json

@@ -1,26 +1,24 @@
 {
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint", "prettier"],
+  "plugins": ["@typescript-eslint", "prettier", "no-relative-import-paths"],
   "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
   "parserOptions": {
-    "project": "./tsconfig.json"
+    "project": "./tsconfig.eslint.json"
   },
   "root": true,
   "env": {
-    "node": true,
-    "jest": true
+    "node": true
   },
   "rules": {
-    "@typescript-eslint/interface-name-prefix": "off",
-    "no-console": 0,
-    "@typescript-eslint/ban-ts-comment": [0],
+    "no-console": ["error"],
     "prettier/prettier": [
       "error",
       {
         "endOfLine": "auto"
       }
     ],
-    "@typescript-eslint/no-explicit-any": 0,
-    "@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }]
+    "@typescript-eslint/no-explicit-any": ["error"],
+    "@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }],
+    "no-relative-import-paths/no-relative-import-paths": ["error", { "allowSameFolder": true }]
   }
 }

.gitignore

@@ -17,4 +17,5 @@ node_modules
 
 # Test specs
 test/*
-!config/petstore.yaml
+!test/petstore.yaml
+!test/config.ts

README.md

@@ -24,6 +24,45 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json
 yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalone
 ```
 
+## Configuration Files
+
+The CLI supports TypeScript configuration files to simplify command execution and provide consistent settings with full type safety. Configuration files are automatically discovered in your project root.
+
+**Note:** Command-line arguments always take precedence over configuration file values, allowing you to override specific settings when needed.
+
+### Quick Start
+
+Create an `openapi-codegen.config.ts` file:
+
+```typescript
+import { OpenAPICodegenConfig } from "@povio/openapi-codegen-cli";
+
+const config: OpenAPICodegenConfig = {
+  input: "http://localhost:4000/docs-json/",
+  output: "src/data",
+};
+
+export default config;
+```
+
+Then run without arguments:
+
+```bash
+yarn openapi-codegen generate
+```
+
+### Configuration File Discovery
+
+The CLI automatically searches for the TypeScript configuration file:
+
+- `openapi-codegen.config.ts`
+
+You can also specify a custom configuration file:
+
+```bash
+yarn openapi-codegen generate --config my-config.ts
+```
+
 ## Options
 
 #### Generate command (generates Zod schemas, API definitions and React queries)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.14.9",
+  "version": "0.15.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
@@ -12,14 +12,13 @@
     "build:clean": "rm -rf ./dist",
     "build:types": "tsc --project . --declaration --emitDeclarationOnly",
     "build": "yarn build:clean && yarn build:types && node ./esbuild.mjs && chmod +x ./dist/sh.js",
-    "build:check": "yarn tsc --project . --noEmit",
     "start:dist": "node ./dist/sh.js",
     "typecheck": "tsc --noEmit",
-    "lint": "eslint --fix",
-    "format:check": "prettier --check .",
-    "format:fix": "prettier --write .",
+    "lint": "eslint ./src",
+    "check": "yarn typecheck && yarn lint && yarn test",
     "push": "yarn exec ./scripts/publish.sh",
-    "dev:generate": "rm -rf ./output && yarn start generate --input ./test/test.json"
+    "dev:generate": "rm -rf ./output && yarn start generate --config ./test/config.ts",
+    "dev:check": "yarn start check --config ./test/config.ts"
   },
   "files": [
     "dist/*",
@@ -53,6 +52,7 @@
     "esbuild": "^0.21.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-no-relative-import-paths": "^1.6.1",
     "eslint-plugin-prettier": "^5.1.3",
     "handlebars": "^4.7.8",
     "openapi-types": "^12.1.3",

src/commands/check.command.ts

@@ -1,35 +1,33 @@
-import { DEFAULT_GENERATE_OPTIONS } from "src/generators/const/options.const";
 import yargs from "yargs";
-import { logBanner, logVariable } from "../helpers/cli.helper";
-import { getVersion } from "../helpers/version.helper";
-import { getBuilder, YargOption } from "../helpers/yargs.helper";
+import { logBanner } from "src/helpers/cli.helper";
+import { getVersion } from "src/helpers/version.helper";
+import { getBuilder, YargOption } from "src/helpers/yargs.helper";
 import { check, CheckParams } from "./check";
 
 class CheckOptions implements CheckParams {
-  @YargOption({ envAlias: "input", demandOption: true })
-  input!: string;
+  @YargOption({ envAlias: "config" })
+  config?: string;
 
-  @YargOption({ envAlias: "splitByTags", default: DEFAULT_GENERATE_OPTIONS.splitByTags, type: "boolean" })
-  splitByTags!: boolean;
+  @YargOption({ envAlias: "input" })
+  input?: string;
 
-  @YargOption({ envAlias: "defaultTag", default: DEFAULT_GENERATE_OPTIONS.defaultTag })
-  defaultTag!: string;
+  @YargOption({ envAlias: "splitByTags", type: "boolean" })
+  splitByTags?: boolean;
 
-  @YargOption({ envAlias: "excludeTags", default: DEFAULT_GENERATE_OPTIONS.excludeTags.join(",") })
-  excludeTags!: string;
+  @YargOption({ envAlias: "defaultTag" })
+  defaultTag?: string;
 
-  @YargOption({ envAlias: "excludePathRegex", default: DEFAULT_GENERATE_OPTIONS.excludePathRegex })
-  excludePathRegex!: string;
+  @YargOption({ envAlias: "excludeTags" })
+  excludeTags?: string;
 
-  @YargOption({
-    envAlias: "excludeRedundantZodSchemas",
-    default: DEFAULT_GENERATE_OPTIONS.excludeRedundantZodSchemas,
-    type: "boolean",
-  })
-  excludeRedundantZodSchemas!: boolean;
+  @YargOption({ envAlias: "excludePathRegex" })
+  excludePathRegex?: string;
+
+  @YargOption({ envAlias: "excludeRedundantZodSchemas", type: "boolean" })
+  excludeRedundantZodSchemas?: boolean;
 
   @YargOption({ envAlias: "verbose", default: false, type: "boolean" })
-  verbose!: boolean;
+  verbose?: boolean;
 }
 
 export const command: yargs.CommandModule = {
@@ -40,7 +38,6 @@ export const command: yargs.CommandModule = {
     const argv = (await _argv) as unknown as CheckOptions;
     if (argv.verbose) {
       logBanner(`OpenAPI CodeGen ${getVersion()}`);
-      logVariable("input", argv.input);
     }
     return check(argv);
   },

src/commands/check.ts

@@ -1,41 +1,43 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
 import { OpenAPIV3 } from "openapi-types";
 import { checkOpenAPIDoc } from "src/generators/checkOpenAPIDoc";
+import { DEFAULT_GENERATE_OPTIONS } from "src/generators/const/options.const";
 import { GenerateOptions } from "src/generators/types/options";
+import { deepMerge } from "src/generators/utils/object.utils";
 import { logInfo, logSuccess } from "src/helpers/cli.helper";
+import { loadConfig } from "src/helpers/config.helper";
 
 export type CheckParams = {
-  excludeTags: string;
-  verbose: boolean;
-} & Pick<GenerateOptions, "input" | "splitByTags" | "defaultTag">;
+  config?: string;
+  excludeTags?: string;
+  verbose?: boolean;
+} & Partial<Pick<GenerateOptions, "input" | "splitByTags" | "defaultTag">>;
 
-export async function check({ input, excludeTags, verbose, ...params }: CheckParams) {
+export async function check({ verbose, ...params }: CheckParams) {
   const start = Date.now();
 
   if (verbose) {
-    logInfo("Parsing OpenAPI spec...");
-  }
-  const openApiDoc = (await SwaggerParser.bundle(input)) as OpenAPIV3.Document;
-  if (verbose) {
-    logSuccess("Parsing finished.");
+    logInfo("Resolving config...");
   }
+  const fileConfig = await loadConfig(params.config);
+  const config = deepMerge(DEFAULT_GENERATE_OPTIONS, fileConfig ?? {}, {
+    ...params,
+    excludeTags: params.excludeTags?.split(","),
+  });
 
   if (verbose) {
-    logInfo("Running check...");
+    logInfo("Parsing OpenAPI spec...");
   }
-  const errorMessages = checkOpenAPIDoc(openApiDoc, {
-    input,
-    excludeTags: excludeTags.split(","),
-    ...params,
-  });
+  const openApiDoc = (await SwaggerParser.bundle(config.input)) as OpenAPIV3.Document;
 
   if (verbose) {
-    logInfo(`TIME: ${Date.now() - start}ms`);
+    logInfo("Running check...");
   }
+  const errorMessages = checkOpenAPIDoc(openApiDoc, config);
 
   if (errorMessages.length === 0) {
-    logSuccess("Check finished.");
+    logSuccess(`Time: ${Date.now() - start}ms`);
   } else {
-    throw new Error(`Check finished. Found ${errorMessages.length} issues.`);
+    throw new Error(`Found ${errorMessages.length} issues. Time: ${Date.now() - start}ms`);
   }
 }