Merge pull request #677 from constructive-io/update/cli-unify-case

Unify codegen cli to hyphen case

Author: pyramation

graphql/codegen/README.md

@@ -661,7 +661,7 @@ Filter patterns support wildcards:
 
 The CLI provides a convenient way to run code generation from the command line.
 
-### `graphql-sdk generate`
+### `graphql-codegen`
 
 Generate React Query hooks and/or ORM client from various sources.
 
@@ -682,62 +682,57 @@ Database Options (for pgpm modes):
 Generator Options:
   --react-query                    Generate React Query hooks
   --orm                            Generate ORM client
-  -t, --target <name>              Target name in config file
   -o, --output <dir>               Output directory
+  -t, --target <name>              Target name (for multi-target configs)
   -a, --authorization <token>      Authorization header value
   --browser-compatible             Generate browser-compatible code (default: true)
                                    Set to false for Node.js with localhost DNS fix
   --skip-custom-operations         Only generate table CRUD operations
   --dry-run                        Preview without writing files
-  --keep-db                        Keep ephemeral database after generation (pgpm modes)
   -v, --verbose                    Show detailed output
-
-Watch Mode Options:
-  -w, --watch                      Watch for schema changes and regenerate
-  --poll-interval <ms>             Polling interval in milliseconds (default: 5000)
-  --debounce <ms>                  Debounce delay in milliseconds (default: 500)
-  --touch <path>                   Touch file after regeneration
-  --no-clear                       Don't clear console on regeneration
+  --keep-db                        Keep ephemeral database after generation (pgpm modes)
+  -h, --help                       Show help message
+  --version                        Show version number
 ```
 
 Examples:
 
 ```bash
 # Generate React Query hooks from an endpoint
-npx graphql-sdk generate --endpoint https://api.example.com/graphql --output ./generated --react-query
+npx @constructive-io/graphql-codegen --endpoint https://api.example.com/graphql --output ./generated --react-query
 
 # Generate ORM client from an endpoint
-npx graphql-sdk generate --endpoint https://api.example.com/graphql --output ./generated --orm
+npx @constructive-io/graphql-codegen --endpoint https://api.example.com/graphql --output ./generated --orm
 
 # Generate both React Query hooks and ORM client
-npx graphql-sdk generate --endpoint https://api.example.com/graphql --output ./generated --react-query --orm
+npx @constructive-io/graphql-codegen --endpoint https://api.example.com/graphql --output ./generated --react-query --orm
 
-# Generate from a PGPM module
-npx graphql-sdk generate --pgpm-module-path ./packages/my-module --schemas public --react-query
+# Generate from schema file
+npx @constructive-io/graphql-codegen --schema-file ./schema.graphql --output ./generated --react-query
 
-# Generate using apiNames for automatic schema discovery
-npx graphql-sdk generate --pgpm-module-path ./packages/my-module --api-names my_api --react-query --orm
-```
+# Generate from database with schemas
+npx @constructive-io/graphql-codegen --schemas public,app_public --output ./generated --react-query
 
-### `graphql-sdk init`
+# Generate from database with API names
+npx @constructive-io/graphql-codegen --api-names my_api --output ./generated --orm
 
-Create a configuration file.
+# Use config file
+npx @constructive-io/graphql-codegen --config ./graphql-codegen.config.ts
 
-```bash
-Options:
-  -f, --format <format>    Config format: ts, js, json (default: ts)
-  -o, --output <path>      Output path for config file
+# Generate specific target from multi-target config
+npx @constructive-io/graphql-codegen --config ./graphql-codegen.config.ts --target admin
 ```
 
-### `graphql-sdk introspect`
+### Using with Constructive CLI
 
-Inspect schema without generating code.
+The `@constructive-io/cli` package includes the codegen command:
 
 ```bash
-Options:
-  -e, --endpoint <url>     GraphQL endpoint URL
-  --json                   Output as JSON
-  -v, --verbose            Show detailed output
+# Install Constructive CLI
+npm install -g @constructive-io/cli
+
+# Run codegen via cnc
+cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --react-query
 ```
 
 ## Architecture

graphql/codegen/package.json

@@ -65,7 +65,7 @@
     "find-and-require-package-json": "^0.9.0",
     "gql-ast": "workspace:^",
     "graphql": "15.10.1",
-    "inflekt": "^0.3.0",
+    "inflekt": "^0.3.1",
     "inquirerer": "^4.4.0",
     "jiti": "^2.6.1",
     "oxfmt": "^0.26.0",

graphql/codegen/src/cli/index.ts

@@ -10,7 +10,7 @@ import { CLI, CLIOptions, Inquirerer, getPackageJson } from 'inquirerer';
 import { generate } from '../core/generate';
 import { findConfigFile, loadConfigFile } from '../core/config';
 import type { GraphQLSDKConfigTarget } from '../types/config';
-import { codegenQuestions, printResult, type CodegenAnswers } from './shared';
+import { camelizeArgv, codegenQuestions, printResult, type CodegenAnswers } from './shared';
 
 const usage = `
 graphql-codegen - GraphQL SDK generator for Constructive databases
@@ -108,23 +108,26 @@ export const commands = async (
   // No config file - prompt for options using shared questions
   const answers = await prompter.prompt<CodegenAnswers>(argv as CodegenAnswers, codegenQuestions);
 
+  // Convert kebab-case CLI args to camelCase for internal use
+  const camelized = camelizeArgv(answers) as CodegenAnswers;
+
   // Build db config if schemas or apiNames provided
-  const db = (answers.schemas || answers.apiNames) ? {
-    schemas: answers.schemas,
-    apiNames: answers.apiNames,
+  const db = (camelized.schemas || camelized.apiNames) ? {
+    schemas: camelized.schemas,
+    apiNames: camelized.apiNames,
   } : undefined;
 
   const result = await generate({
-    endpoint: answers.endpoint,
-    schemaFile: answers.schemaFile,
+    endpoint: camelized.endpoint,
+    schemaFile: camelized.schemaFile,
     db,
-    output: answers.output,
-    authorization: answers.authorization,
-    reactQuery: answers.reactQuery,
-    orm: answers.orm,
-    browserCompatible: answers.browserCompatible,
-    dryRun: answers.dryRun,
-    verbose: answers.verbose,
+    output: camelized.output,
+    authorization: camelized.authorization,
+    reactQuery: camelized.reactQuery,
+    orm: camelized.orm,
+    browserCompatible: camelized.browserCompatible,
+    dryRun: camelized.dryRun,
+    verbose: camelized.verbose,
   });
 
   printResult(result);

graphql/codegen/src/cli/shared.ts

@@ -6,6 +6,8 @@
  */
 import type { Question } from 'inquirerer';
 import type { GenerateResult } from '../core/generate';
+import { camelize } from 'inflekt';
+import { inflektTree } from 'inflekt/transform-keys';
 
 /**
  * Sanitize function that splits comma-separated strings into arrays
@@ -17,6 +19,7 @@ export const splitCommas = (input: string | undefined): string[] | undefined =>
 
 /**
  * Interface for codegen CLI answers
+ * CLI accepts kebab-case arguments, converted to camelCase for internal use
  */
 export interface CodegenAnswers {
   endpoint?: string;
@@ -43,7 +46,7 @@ export const codegenQuestions: Question[] = [
     required: false,
   },
   {
-    name: 'schemaFile',
+    name: 'schema-file',
     message: 'Path to GraphQL schema file',
     type: 'text',
     required: false,
@@ -64,14 +67,14 @@ export const codegenQuestions: Question[] = [
     sanitize: splitCommas,
   },
   {
-    name: 'apiNames',
+    name: 'api-names',
     message: 'API names (comma-separated)',
     type: 'text',
     required: false,
     sanitize: splitCommas,
   },
   {
-    name: 'reactQuery',
+    name: 'react-query',
     message: 'Generate React Query hooks?',
     type: 'confirm',
     required: false,
@@ -87,7 +90,7 @@ export const codegenQuestions: Question[] = [
     useDefault: true,
   },
   {
-    name: 'browserCompatible',
+    name: 'browser-compatible',
     message: 'Generate browser-compatible code?',
     type: 'confirm',
     required: false,
@@ -101,7 +104,7 @@ export const codegenQuestions: Question[] = [
     required: false,
   },
   {
-    name: 'dryRun',
+    name: 'dry-run',
     message: 'Preview without writing files?',
     type: 'confirm',
     required: false,
@@ -133,3 +136,16 @@ export function printResult(result: GenerateResult): void {
     process.exit(1);
   }
 }
+
+const isTopLevel = (_key: string, path: string[]) => path.length === 0;
+export const camelizeArgv = (argv: Record<string, any>) =>
+  inflektTree(argv, (key) => {
+    // inflection.camelize expects underscores, so replace hyphens first
+    const underscored = key.replace(/-/g, '_');
+    return camelize(underscored, true);
+  }, {
+    skip: (key, path) =>
+      !isTopLevel(key, path) ||
+      key === '_' ||
+      key.startsWith('_')
+  });

graphql/codegen/src/index.ts

@@ -29,7 +29,7 @@ export type { GenerateOptions, GenerateResult } from './core/generate';
 export { findConfigFile, loadConfigFile } from './core/config';
 
 // CLI shared utilities (for packages/cli to import)
-export { codegenQuestions, splitCommas, printResult } from './cli/shared';
+export { codegenQuestions, splitCommas, printResult, camelizeArgv } from './cli/shared';
 export type { CodegenAnswers } from './cli/shared';
 
 // Database schema utilities (re-exported from core for convenience)

packages/cli/README.md

@@ -61,24 +61,40 @@ cnc explorer --origin http://localhost:3000
 Generate TypeScript types, operations, and SDK from a GraphQL schema or endpoint.
 
 ```bash
-# From endpoint
-cnc codegen --endpoint http://localhost:5555/graphql --out ./codegen
+# Generate React Query hooks from endpoint
+cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --react-query
 
-# From database
-cnc codegen --database constructive_db --out ./codegen --verbose
+# Generate ORM client from endpoint
+cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --orm
+
+# Generate both React Query hooks and ORM client
+cnc codegen --endpoint http://localhost:5555/graphql --output ./codegen --react-query --orm
+
+# From schema file
+cnc codegen --schema-file ./schema.graphql --output ./codegen --react-query
+
+# From database with schemas
+cnc codegen --schemas public,app_public --output ./codegen --react-query
+
+# From database with API names
+cnc codegen --api-names my_api --output ./codegen --orm
 ```
 
 **Options:**
 
+- `--config <path>` - Path to config file
 - `--endpoint <url>` - GraphQL endpoint URL
-- `--auth <token>` - Authorization header value (e.g., "Bearer 123")
-- `--out <dir>` - Output directory (default: graphql/codegen/dist)
+- `--schema-file <path>` - Path to GraphQL schema file
+- `--schemas <list>` - Comma-separated PostgreSQL schemas
+- `--api-names <list>` - Comma-separated API names
+- `--react-query` - Generate React Query hooks
+- `--orm` - Generate ORM client
+- `--output <dir>` - Output directory (default: ./codegen)
+- `--authorization <token>` - Authorization header value
+- `--browser-compatible` - Generate browser-compatible code (default: true)
 - `--dry-run` - Preview without writing files
 - `--verbose` - Verbose output
 
-- `--database <name>` - Database override for DB mode (defaults to PGDATABASE)
-- `--schemas <list>` - Comma-separated schemas (required unless using --endpoint)
-
 ### `cnc get-graphql-schema`
 
 Fetch or build GraphQL schema SDL.

packages/cli/__tests__/codegen.test.ts

@@ -35,6 +35,7 @@ jest.mock('@constructive-io/graphql-codegen', () => {
         process.exit(1);
       }
     }),
+    camelizeArgv: jest.fn((argv: Record<string, any>) => argv),
   };
 })
 

packages/cli/src/commands/codegen.ts

@@ -4,6 +4,7 @@ import {
   findConfigFile,
   codegenQuestions,
   printResult,
+  camelizeArgv,
   type CodegenAnswers,
 } from '@constructive-io/graphql-codegen';
 
@@ -15,20 +16,20 @@ Constructive GraphQL Codegen:
 Source Options (choose one):
   --config <path>            Path to graphql-codegen config file
   --endpoint <url>           GraphQL endpoint URL
-  --schemaFile <path>        Path to GraphQL schema file
+  --schema-file <path>       Path to GraphQL schema file
 
 Database Options:
   --schemas <list>           Comma-separated PostgreSQL schemas
-  --apiNames <list>          Comma-separated API names
+  --api-names <list>         Comma-separated API names
 
 Generator Options:
-  --reactQuery               Generate React Query hooks (default)
+  --react-query              Generate React Query hooks (default)
   --orm                      Generate ORM client
   --output <dir>             Output directory (default: codegen)
   --authorization <token>    Authorization header value
-  --browserCompatible        Generate browser-compatible code (default: true)
+  --browser-compatible       Generate browser-compatible code (default: true)
                              Set to false for Node.js with localhost DNS fix
-  --dryRun                   Preview without writing files
+  --dry-run                  Preview without writing files
   --verbose                  Verbose output
 
   --help, -h                 Show this help message
@@ -55,24 +56,26 @@ export default async (
 
   // No config file - prompt for options using shared questions
   const answers = await prompter.prompt<CodegenAnswers>(argv as CodegenAnswers, codegenQuestions);
+  // Convert kebab-case CLI args to camelCase for internal use
+  const camelized = camelizeArgv(answers);
 
   // Build db config if schemas or apiNames provided
-  const db = (answers.schemas || answers.apiNames) ? {
-    schemas: answers.schemas,
-    apiNames: answers.apiNames,
+  const db = (camelized.schemas || camelized.apiNames) ? {
+    schemas: camelized.schemas,
+    apiNames: camelized.apiNames,
   } : undefined;
 
   const result = await generate({
-    endpoint: answers.endpoint,
-    schemaFile: answers.schemaFile,
+    endpoint: camelized.endpoint,
+    schemaFile: camelized.schemaFile,
     db,
-    output: answers.output,
-    authorization: answers.authorization,
-    reactQuery: answers.reactQuery,
-    orm: answers.orm,
-    browserCompatible: answers.browserCompatible,
-    dryRun: answers.dryRun,
-    verbose: answers.verbose,
+    output: camelized.output,
+    authorization: camelized.authorization,
+    reactQuery: camelized.reactQuery,
+    orm: camelized.orm,
+    browserCompatible: camelized.browserCompatible,
+    dryRun: camelized.dryRun,
+    verbose: camelized.verbose,
   });
 
   printResult(result);