@geekmidas/cli 0.6.1 → 0.7.0

package/README.md

@@ -4,6 +4,7 @@ A powerful CLI tool for building and managing TypeScript-based backend APIs with
 
 ## Features
 
+- **Project Scaffolding**: Interactive `init` command to bootstrap new projects with templates
 - **Multi-Provider Support**: Generate handlers for AWS Lambda (API Gateway v1/v2) and server applications
 - **Development Server**: Hot-reload development server with file watching
 - **Telescope Integration**: Laravel-style debugging dashboard for inspecting requests, logs, and exceptions
@@ -13,6 +14,7 @@ A powerful CLI tool for building and managing TypeScript-based backend APIs with
 - **Flexible Routing**: Support for glob patterns to discover route files
 - **Environment Integration**: Seamless integration with @geekmidas/envkit for configuration
 - **Logger Integration**: Built-in logging configuration and integration
+- **Monorepo Support**: Optional pnpm workspace monorepo setup with shared packages
 
 ## Installation
 
@@ -28,6 +30,18 @@ npm install -g @geekmidas/cli
 
 ## Quick Start
 
+### Option 1: Use `gkm init` (Recommended)
+
+The fastest way to get started is with the interactive `init` command:
+
+```bash
+npx @geekmidas/cli init my-api
+```
+
+This will guide you through setting up a new project with your preferred options.
+
+### Option 2: Manual Setup
+
 ### 1. Create Configuration
 
 Create a `gkm.config.ts` file in your project root:
@@ -178,6 +192,111 @@ npx gkm openapi --output src/api.ts
 
 ## CLI Commands
 
+### `gkm init`
+
+Scaffold a new project with interactive prompts.
+
+```bash
+gkm init [name] [options]
+```
+
+**Arguments:**
+- `[name]`: Project name (optional, will prompt if not provided)
+
+**Options:**
+- `--template <template>`: Project template (`minimal`, `api`, `serverless`, `worker`)
+- `--skip-install`: Skip dependency installation
+- `-y, --yes`: Skip prompts, use defaults
+- `--monorepo`: Setup as monorepo structure
+- `--api-path <path>`: API app path in monorepo (default: `apps/api`)
+
+**Interactive Prompts:**
+
+When run without `--yes`, the command will ask:
+
+1. **Project name** - Name for your project directory
+2. **Template** - Choose from available templates:
+   - `minimal` - Basic health endpoint
+   - `api` - Full API with auth, database, services
+   - `serverless` - AWS Lambda handlers
+   - `worker` - Background job processing
+3. **Telescope** - Include debugging dashboard (default: yes)
+4. **Database** - Include Kysely database support (default: yes)
+5. **Logger** - Choose logger implementation:
+   - `pino` - Fast JSON logger for production (recommended)
+   - `console` - Simple console logger for development
+6. **Routes structure** - Choose file organization:
+   - `centralized-endpoints` - `src/endpoints/**/*.ts`
+   - `centralized-routes` - `src/routes/**/*.ts`
+   - `domain-based` - `src/**/routes/*.ts`
+7. **Monorepo** - Setup as pnpm workspace monorepo (default: no)
+8. **API path** - If monorepo, where to place the API app
+
+**Examples:**
+
+```bash
+# Interactive mode
+npx @geekmidas/cli init
+
+# With project name
+npx @geekmidas/cli init my-api
+
+# Skip prompts with defaults
+npx @geekmidas/cli init my-api --yes
+
+# Specific template
+npx @geekmidas/cli init my-api --template api
+
+# Monorepo setup
+npx @geekmidas/cli init my-project --monorepo --api-path apps/backend
+
+# Skip dependency installation
+npx @geekmidas/cli init my-api --skip-install
+```
+
+**Generated Structure (Minimal Template):**
+
+```
+my-api/
+├── src/
+│   ├── config/
+│   │   ├── env.ts           # Environment configuration
+│   │   └── logger.ts        # Logger setup
+│   └── endpoints/
+│       └── health.ts        # Health check endpoint
+├── .env                     # Environment variables
+├── .env.example             # Example env file
+├── .gitignore
+├── gkm.config.ts            # CLI configuration
+├── package.json
+├── tsconfig.json
+└── Dockerfile               # Docker configuration
+```
+
+**Generated Structure (Monorepo):**
+
+```
+my-project/
+├── apps/
+│   └── api/
+│       ├── src/
+│       │   ├── config/
+│       │   └── endpoints/
+│       ├── gkm.config.ts
+│       ├── package.json
+│       └── tsconfig.json
+├── packages/
+│   └── models/              # Shared types/models
+│       ├── src/
+│       │   └── index.ts
+│       ├── package.json
+│       └── tsconfig.json
+├── package.json             # Root workspace config
+├── pnpm-workspace.yaml
+├── tsconfig.json            # Base TypeScript config
+└── turbo.json               # Turborepo config
+```
+
 ### `gkm build`
 
 Generate handlers from your endpoints.

package/dist/config-Bq72aj8e.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config-Bq72aj8e.mjs","names":["config: GkmConfig","configString: string","defaultAlias: string","cwd: string"],"sources":["../src/config.ts"],"sourcesContent":["import { existsSync } from 'fs';\nimport { join } from 'path';\nimport type { GkmConfig } from './types.ts';\n\n/**\n * Define GKM configuration with full TypeScript support.\n * This is an identity function that provides type safety and autocomplete.\n *\n * @example\n * ```ts\n * // gkm.config.ts\n * import { defineConfig } from '@geekmidas/cli/config';\n *\n * export default defineConfig({\n *   routes: './src/endpoints/**\\/*.ts',\n *   envParser: './src/config/env',\n *   logger: './src/config/logger',\n *   telescope: true,\n * });\n * ```\n */\nexport function defineConfig(config: GkmConfig): GkmConfig {\n  return config;\n}\n\nexport interface ParsedModuleConfig {\n  path: string;\n  importPattern: string;\n}\n\n/**\n * Parse a module config string into path and import pattern.\n *\n * @param configString - Config string in format \"./path/to/module\" or \"./path/to/module#exportName\"\n * @param defaultAlias - The default alias name to use if no export name specified\n * @returns Object with path and import pattern\n *\n * @example\n * parseModuleConfig('./src/config/env', 'envParser')\n * // { path: './src/config/env', importPattern: 'envParser' }\n *\n * parseModuleConfig('./src/config/env#envParser', 'envParser')\n * // { path: './src/config/env', importPattern: '{ envParser }' }\n *\n * parseModuleConfig('./src/config/env#myEnv', 'envParser')\n * // { path: './src/config/env', importPattern: '{ myEnv as envParser }' }\n */\nexport function parseModuleConfig(\n  configString: string,\n  defaultAlias: string,\n): ParsedModuleConfig {\n  const [path, exportName] = configString.split('#');\n  const importPattern = !exportName\n    ? defaultAlias\n    : exportName === defaultAlias\n      ? `{ ${defaultAlias} }`\n      : `{ ${exportName} as ${defaultAlias} }`;\n\n  return { path, importPattern };\n}\n\nexport async function loadConfig(\n  cwd: string = process.cwd(),\n): Promise<GkmConfig> {\n  const files = ['gkm.config.json', 'gkm.config.ts', 'gkm.config.js'];\n  let configPath = '';\n\n  for (const file of files) {\n    const path = join(cwd, file);\n    if (existsSync(path)) {\n      configPath = path;\n      break;\n    }\n  }\n\n  if (!configPath) {\n    throw new Error(\n      'Configuration file not found. Please create gkm.config.json, gkm.config.ts, or gkm.config.js in the project root.',\n    );\n  }\n\n  try {\n    const config = await import(configPath);\n    return config.default;\n  } catch (error) {\n    throw new Error(\n      `Failed to load gkm.config.json: ${(error as Error).message}`,\n    );\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,aAAaA,QAA8B;AACzD,QAAO;AACR;;;;;;;;;;;;;;;;;;AAwBD,SAAgB,kBACdC,cACAC,cACoB;CACpB,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,MAAM,IAAI;CAClD,MAAM,iBAAiB,aACnB,eACA,eAAe,gBACZ,IAAI,aAAa,OACjB,IAAI,WAAW,MAAM,aAAa;AAEzC,QAAO;EAAE;EAAM;CAAe;AAC/B;AAED,eAAsB,WACpBC,MAAc,QAAQ,KAAK,EACP;CACpB,MAAM,QAAQ;EAAC;EAAmB;EAAiB;CAAgB;CACnE,IAAI,aAAa;AAEjB,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,KAAK,KAAK,KAAK;AAC5B,MAAI,WAAW,KAAK,EAAE;AACpB,gBAAa;AACb;EACD;CACF;AAED,MAAK,WACH,OAAM,IAAI,MACR;AAIJ,KAAI;EACF,MAAM,SAAS,MAAM,OAAO;AAC5B,SAAO,OAAO;CACf,SAAQ,OAAO;AACd,QAAM,IAAI,OACP,kCAAmC,MAAgB,QAAQ;CAE/D;AACF"}
+{"version":3,"file":"config-Bq72aj8e.mjs","names":["config: GkmConfig","configString: string","defaultAlias: string","cwd: string"],"sources":["../src/config.ts"],"sourcesContent":["import { existsSync } from 'fs';\nimport { join } from 'path';\nimport type { GkmConfig } from './types.ts';\n\nexport type { GkmConfig } from './types.ts';\n/**\n * Define GKM configuration with full TypeScript support.\n * This is an identity function that provides type safety and autocomplete.\n *\n * @example\n * ```ts\n * // gkm.config.ts\n * import { defineConfig } from '@geekmidas/cli/config';\n *\n * export default defineConfig({\n *   routes: './src/endpoints/**\\/*.ts',\n *   envParser: './src/config/env',\n *   logger: './src/config/logger',\n *   telescope: true,\n * });\n * ```\n */\nexport function defineConfig(config: GkmConfig): GkmConfig {\n  return config;\n}\n\nexport interface ParsedModuleConfig {\n  path: string;\n  importPattern: string;\n}\n\n/**\n * Parse a module config string into path and import pattern.\n *\n * @param configString - Config string in format \"./path/to/module\" or \"./path/to/module#exportName\"\n * @param defaultAlias - The default alias name to use if no export name specified\n * @returns Object with path and import pattern\n *\n * @example\n * parseModuleConfig('./src/config/env', 'envParser')\n * // { path: './src/config/env', importPattern: 'envParser' }\n *\n * parseModuleConfig('./src/config/env#envParser', 'envParser')\n * // { path: './src/config/env', importPattern: '{ envParser }' }\n *\n * parseModuleConfig('./src/config/env#myEnv', 'envParser')\n * // { path: './src/config/env', importPattern: '{ myEnv as envParser }' }\n */\nexport function parseModuleConfig(\n  configString: string,\n  defaultAlias: string,\n): ParsedModuleConfig {\n  const [path, exportName] = configString.split('#');\n  const importPattern = !exportName\n    ? defaultAlias\n    : exportName === defaultAlias\n      ? `{ ${defaultAlias} }`\n      : `{ ${exportName} as ${defaultAlias} }`;\n\n  return { path, importPattern };\n}\n\nexport async function loadConfig(\n  cwd: string = process.cwd(),\n): Promise<GkmConfig> {\n  const files = ['gkm.config.json', 'gkm.config.ts', 'gkm.config.js'];\n  let configPath = '';\n\n  for (const file of files) {\n    const path = join(cwd, file);\n    if (existsSync(path)) {\n      configPath = path;\n      break;\n    }\n  }\n\n  if (!configPath) {\n    throw new Error(\n      'Configuration file not found. Please create gkm.config.json, gkm.config.ts, or gkm.config.js in the project root.',\n    );\n  }\n\n  try {\n    const config = await import(configPath);\n    return config.default;\n  } catch (error) {\n    throw new Error(\n      `Failed to load gkm.config.json: ${(error as Error).message}`,\n    );\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,aAAaA,QAA8B;AACzD,QAAO;AACR;;;;;;;;;;;;;;;;;;AAwBD,SAAgB,kBACdC,cACAC,cACoB;CACpB,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,MAAM,IAAI;CAClD,MAAM,iBAAiB,aACnB,eACA,eAAe,gBACZ,IAAI,aAAa,OACjB,IAAI,WAAW,MAAM,aAAa;AAEzC,QAAO;EAAE;EAAM;CAAe;AAC/B;AAED,eAAsB,WACpBC,MAAc,QAAQ,KAAK,EACP;CACpB,MAAM,QAAQ;EAAC;EAAmB;EAAiB;CAAgB;CACnE,IAAI,aAAa;AAEjB,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,KAAK,KAAK,KAAK;AAC5B,MAAI,WAAW,KAAK,EAAE;AACpB,gBAAa;AACb;EACD;CACF;AAED,MAAK,WACH,OAAM,IAAI,MACR;AAIJ,KAAI;EACF,MAAM,SAAS,MAAM,OAAO;AAC5B,SAAO,OAAO;CACf,SAAQ,OAAO;AACd,QAAM,IAAI,OACP,kCAAmC,MAAgB,QAAQ;CAE/D;AACF"}

package/dist/config-CFls09Ey.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"config-CFls09Ey.cjs","names":["config: GkmConfig","configString: string","defaultAlias: string","path","cwd: string"],"sources":["../src/config.ts"],"sourcesContent":["import { existsSync } from 'fs';\nimport { join } from 'path';\nimport type { GkmConfig } from './types.ts';\n\n/**\n * Define GKM configuration with full TypeScript support.\n * This is an identity function that provides type safety and autocomplete.\n *\n * @example\n * ```ts\n * // gkm.config.ts\n * import { defineConfig } from '@geekmidas/cli/config';\n *\n * export default defineConfig({\n *   routes: './src/endpoints/**\\/*.ts',\n *   envParser: './src/config/env',\n *   logger: './src/config/logger',\n *   telescope: true,\n * });\n * ```\n */\nexport function defineConfig(config: GkmConfig): GkmConfig {\n  return config;\n}\n\nexport interface ParsedModuleConfig {\n  path: string;\n  importPattern: string;\n}\n\n/**\n * Parse a module config string into path and import pattern.\n *\n * @param configString - Config string in format \"./path/to/module\" or \"./path/to/module#exportName\"\n * @param defaultAlias - The default alias name to use if no export name specified\n * @returns Object with path and import pattern\n *\n * @example\n * parseModuleConfig('./src/config/env', 'envParser')\n * // { path: './src/config/env', importPattern: 'envParser' }\n *\n * parseModuleConfig('./src/config/env#envParser', 'envParser')\n * // { path: './src/config/env', importPattern: '{ envParser }' }\n *\n * parseModuleConfig('./src/config/env#myEnv', 'envParser')\n * // { path: './src/config/env', importPattern: '{ myEnv as envParser }' }\n */\nexport function parseModuleConfig(\n  configString: string,\n  defaultAlias: string,\n): ParsedModuleConfig {\n  const [path, exportName] = configString.split('#');\n  const importPattern = !exportName\n    ? defaultAlias\n    : exportName === defaultAlias\n      ? `{ ${defaultAlias} }`\n      : `{ ${exportName} as ${defaultAlias} }`;\n\n  return { path, importPattern };\n}\n\nexport async function loadConfig(\n  cwd: string = process.cwd(),\n): Promise<GkmConfig> {\n  const files = ['gkm.config.json', 'gkm.config.ts', 'gkm.config.js'];\n  let configPath = '';\n\n  for (const file of files) {\n    const path = join(cwd, file);\n    if (existsSync(path)) {\n      configPath = path;\n      break;\n    }\n  }\n\n  if (!configPath) {\n    throw new Error(\n      'Configuration file not found. Please create gkm.config.json, gkm.config.ts, or gkm.config.js in the project root.',\n    );\n  }\n\n  try {\n    const config = await import(configPath);\n    return config.default;\n  } catch (error) {\n    throw new Error(\n      `Failed to load gkm.config.json: ${(error as Error).message}`,\n    );\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,aAAaA,QAA8B;AACzD,QAAO;AACR;;;;;;;;;;;;;;;;;;AAwBD,SAAgB,kBACdC,cACAC,cACoB;CACpB,MAAM,CAACC,QAAM,WAAW,GAAG,aAAa,MAAM,IAAI;CAClD,MAAM,iBAAiB,aACnB,eACA,eAAe,gBACZ,IAAI,aAAa,OACjB,IAAI,WAAW,MAAM,aAAa;AAEzC,QAAO;EAAE;EAAM;CAAe;AAC/B;AAED,eAAsB,WACpBC,MAAc,QAAQ,KAAK,EACP;CACpB,MAAM,QAAQ;EAAC;EAAmB;EAAiB;CAAgB;CACnE,IAAI,aAAa;AAEjB,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAMD,SAAO,eAAK,KAAK,KAAK;AAC5B,MAAI,mBAAWA,OAAK,EAAE;AACpB,gBAAaA;AACb;EACD;CACF;AAED,MAAK,WACH,OAAM,IAAI,MACR;AAIJ,KAAI;EACF,MAAM,SAAS,MAAM,OAAO;AAC5B,SAAO,OAAO;CACf,SAAQ,OAAO;AACd,QAAM,IAAI,OACP,kCAAmC,MAAgB,QAAQ;CAE/D;AACF"}
+{"version":3,"file":"config-CFls09Ey.cjs","names":["config: GkmConfig","configString: string","defaultAlias: string","path","cwd: string"],"sources":["../src/config.ts"],"sourcesContent":["import { existsSync } from 'fs';\nimport { join } from 'path';\nimport type { GkmConfig } from './types.ts';\n\nexport type { GkmConfig } from './types.ts';\n/**\n * Define GKM configuration with full TypeScript support.\n * This is an identity function that provides type safety and autocomplete.\n *\n * @example\n * ```ts\n * // gkm.config.ts\n * import { defineConfig } from '@geekmidas/cli/config';\n *\n * export default defineConfig({\n *   routes: './src/endpoints/**\\/*.ts',\n *   envParser: './src/config/env',\n *   logger: './src/config/logger',\n *   telescope: true,\n * });\n * ```\n */\nexport function defineConfig(config: GkmConfig): GkmConfig {\n  return config;\n}\n\nexport interface ParsedModuleConfig {\n  path: string;\n  importPattern: string;\n}\n\n/**\n * Parse a module config string into path and import pattern.\n *\n * @param configString - Config string in format \"./path/to/module\" or \"./path/to/module#exportName\"\n * @param defaultAlias - The default alias name to use if no export name specified\n * @returns Object with path and import pattern\n *\n * @example\n * parseModuleConfig('./src/config/env', 'envParser')\n * // { path: './src/config/env', importPattern: 'envParser' }\n *\n * parseModuleConfig('./src/config/env#envParser', 'envParser')\n * // { path: './src/config/env', importPattern: '{ envParser }' }\n *\n * parseModuleConfig('./src/config/env#myEnv', 'envParser')\n * // { path: './src/config/env', importPattern: '{ myEnv as envParser }' }\n */\nexport function parseModuleConfig(\n  configString: string,\n  defaultAlias: string,\n): ParsedModuleConfig {\n  const [path, exportName] = configString.split('#');\n  const importPattern = !exportName\n    ? defaultAlias\n    : exportName === defaultAlias\n      ? `{ ${defaultAlias} }`\n      : `{ ${exportName} as ${defaultAlias} }`;\n\n  return { path, importPattern };\n}\n\nexport async function loadConfig(\n  cwd: string = process.cwd(),\n): Promise<GkmConfig> {\n  const files = ['gkm.config.json', 'gkm.config.ts', 'gkm.config.js'];\n  let configPath = '';\n\n  for (const file of files) {\n    const path = join(cwd, file);\n    if (existsSync(path)) {\n      configPath = path;\n      break;\n    }\n  }\n\n  if (!configPath) {\n    throw new Error(\n      'Configuration file not found. Please create gkm.config.json, gkm.config.ts, or gkm.config.js in the project root.',\n    );\n  }\n\n  try {\n    const config = await import(configPath);\n    return config.default;\n  } catch (error) {\n    throw new Error(\n      `Failed to load gkm.config.json: ${(error as Error).message}`,\n    );\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,aAAaA,QAA8B;AACzD,QAAO;AACR;;;;;;;;;;;;;;;;;;AAwBD,SAAgB,kBACdC,cACAC,cACoB;CACpB,MAAM,CAACC,QAAM,WAAW,GAAG,aAAa,MAAM,IAAI;CAClD,MAAM,iBAAiB,aACnB,eACA,eAAe,gBACZ,IAAI,aAAa,OACjB,IAAI,WAAW,MAAM,aAAa;AAEzC,QAAO;EAAE;EAAM;CAAe;AAC/B;AAED,eAAsB,WACpBC,MAAc,QAAQ,KAAK,EACP;CACpB,MAAM,QAAQ;EAAC;EAAmB;EAAiB;CAAgB;CACnE,IAAI,aAAa;AAEjB,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAMD,SAAO,eAAK,KAAK,KAAK;AAC5B,MAAI,mBAAWA,OAAK,EAAE;AACpB,gBAAaA;AACb;EACD;CACF;AAED,MAAK,WACH,OAAM,IAAI,MACR;AAIJ,KAAI;EACF,MAAM,SAAS,MAAM,OAAO;AAC5B,SAAO,OAAO;CACf,SAAQ,OAAO;AACd,QAAM,IAAI,OACP,kCAAmC,MAAgB,QAAQ;CAE/D;AACF"}

package/dist/config.d.cts

@@ -1,4 +1,4 @@
-import { GkmConfig } from "./types-KmjzMgu8.cjs";
+import { GkmConfig } from "./types-C0hwnSjm.cjs";
 
 //#region src/config.d.ts
 
@@ -44,5 +44,5 @@ interface ParsedModuleConfig {
 declare function parseModuleConfig(configString: string, defaultAlias: string): ParsedModuleConfig;
 declare function loadConfig(cwd?: string): Promise<GkmConfig>;
 //#endregion
-export { ParsedModuleConfig, defineConfig, loadConfig, parseModuleConfig };
+export { GkmConfig, ParsedModuleConfig, defineConfig, loadConfig, parseModuleConfig };
 //# sourceMappingURL=config.d.cts.map

package/dist/config.d.mts

@@ -1,4 +1,4 @@
-import { GkmConfig } from "./types-Bi7VzDUZ.mjs";
+import { GkmConfig } from "./types-B3TXoj7v.mjs";
 
 //#region src/config.d.ts
 
@@ -44,5 +44,5 @@ interface ParsedModuleConfig {
 declare function parseModuleConfig(configString: string, defaultAlias: string): ParsedModuleConfig;
 declare function loadConfig(cwd?: string): Promise<GkmConfig>;
 //#endregion
-export { ParsedModuleConfig, defineConfig, loadConfig, parseModuleConfig };
+export { GkmConfig, ParsedModuleConfig, defineConfig, loadConfig, parseModuleConfig };
 //# sourceMappingURL=config.d.mts.map