@hazeljs/cli 0.6.0 → 0.6.5

package/dist/commands/add.d.ts

@@ -1,2 +1,11 @@
 import { Command } from 'commander';
+/**
+ * Register the `hazel add [package]` command.
+ *
+ * Installs a HazelJS package via npm and prints import/usage hints.
+ * When called without a package name, shows an interactive selection list.
+ * Use `--setup` to also generate a minimal `*.setup.ts` starter file.
+ *
+ * @param program - The root Commander program instance
+ */
 export declare function addCommand(program: Command): void;

package/dist/commands/add.js

@@ -11,6 +11,15 @@ const path_1 = __importDefault(require("path"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const packages_registry_1 = require("../utils/packages-registry");
 const generator_1 = require("../utils/generator");
+/**
+ * Register the `hazel add [package]` command.
+ *
+ * Installs a HazelJS package via npm and prints import/usage hints.
+ * When called without a package name, shows an interactive selection list.
+ * Use `--setup` to also generate a minimal `*.setup.ts` starter file.
+ *
+ * @param program - The root Commander program instance
+ */
 function addCommand(program) {
     program
         .command('add [package]')

package/dist/commands/generate-auth.d.ts

@@ -1,4 +1,16 @@
 import { Command } from 'commander';
 import { GenerateResult, GenerateCLIOptions } from '../utils/generator';
+/**
+ * Generate a complete auth module (6 files: module, service, controller, JWT guard, 2 DTOs).
+ *
+ * @param _name   - Unused (auth generator doesn't need a custom name)
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of all created files and setup next-steps
+ */
 export declare function runAuth(_name: string, options: GenerateCLIOptions): Promise<GenerateResult>;
+/**
+ * Register `hazel g auth` as a sub-command of the generate command.
+ *
+ * @param command - The Commander `generate` parent command
+ */
 export declare function generateAuth(command: Command): void;

package/dist/commands/generate-auth.js

@@ -145,6 +145,13 @@ export class LoginDto {
   password: string;
 }
 `;
+/**
+ * Generate a complete auth module (6 files: module, service, controller, JWT guard, 2 DTOs).
+ *
+ * @param _name   - Unused (auth generator doesn't need a custom name)
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of all created files and setup next-steps
+ */
 async function runAuth(_name, options) {
     const basePath = path_1.default.join(process.cwd(), options.path || 'src/auth');
     const data = {};
@@ -179,6 +186,11 @@ async function runAuth(_name, options) {
         ],
     };
 }
+/**
+ * Register `hazel g auth` as a sub-command of the generate command.
+ *
+ * @param command - The Commander `generate` parent command
+ */
 function generateAuth(command) {
     command
         .command('auth')

package/dist/commands/generate-crud.d.ts

@@ -1,4 +1,16 @@
 import { Command } from 'commander';
 import { GenerateResult, GenerateCLIOptions } from '../utils/generator';
+/**
+ * Generate a complete CRUD resource (4 files: controller, service, DTOs, module).
+ *
+ * @param name    - Resource name (e.g. 'product') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json, --route)
+ * @returns GenerateResult with paths of all created files
+ */
 export declare function runCrud(name: string, options: GenerateCLIOptions): Promise<GenerateResult>;
+/**
+ * Register `hazel g crud <name>` as a sub-command of the generate command.
+ *
+ * @param command - The Commander `generate` parent command
+ */
 export declare function generateCrud(command: Command): void;

package/dist/commands/generate-crud.js

@@ -127,6 +127,13 @@ import { {{className}}Service } from './{{fileName}}.service';
 })
 export class {{className}}Module {}
 `;
+/**
+ * Generate a complete CRUD resource (4 files: controller, service, DTOs, module).
+ *
+ * @param name    - Resource name (e.g. 'product') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json, --route)
+ * @returns GenerateResult with paths of all created files
+ */
 async function runCrud(name, options) {
     try {
         const className = (0, generator_1.toPascalCase)(name);
@@ -171,6 +178,11 @@ async function runCrud(name, options) {
         };
     }
 }
+/**
+ * Register `hazel g crud <name>` as a sub-command of the generate command.
+ *
+ * @param command - The Commander `generate` parent command
+ */
 function generateCrud(command) {
     command
         .command('crud <name>')

package/dist/commands/generate-dto.d.ts

@@ -1,4 +1,16 @@
 import { Command } from 'commander';
 import { GenerateResult, GenerateCLIOptions } from '../utils/generator';
+/**
+ * Generate a pair of DTOs (create + update) for the given name.
+ *
+ * @param name    - Entity name (e.g. 'product') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of both created DTO files
+ */
 export declare function runDto(name: string, options: GenerateCLIOptions): Promise<GenerateResult>;
+/**
+ * Register `hazel g dto <name>` as a sub-command of the generate command.
+ *
+ * @param program - The Commander `generate` parent command
+ */
 export declare function generateDto(program: Command): void;

package/dist/commands/generate-dto.js

@@ -59,10 +59,22 @@ class DtoGenerator extends generator_1.Generator {
         };
     }
 }
+/**
+ * Generate a pair of DTOs (create + update) for the given name.
+ *
+ * @param name    - Entity name (e.g. 'product') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of both created DTO files
+ */
 async function runDto(name, options) {
     const generator = new DtoGenerator();
     return generator.generate({ name, path: options.path, dryRun: options.dryRun });
 }
+/**
+ * Register `hazel g dto <name>` as a sub-command of the generate command.
+ *
+ * @param program - The Commander `generate` parent command
+ */
 function generateDto(program) {
     program
         .command('dto <name>')

package/dist/commands/generate-module.d.ts

@@ -1,4 +1,16 @@
 import { Command } from 'commander';
 import { GenerateResult, GenerateCLIOptions } from '../utils/generator';
+/**
+ * Generate a complete feature module (5 files: module, controller, service, 2 DTOs).
+ *
+ * @param name    - Feature name (e.g. 'users') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of all created files
+ */
 export declare function runModule(name: string, options: GenerateCLIOptions): Promise<GenerateResult>;
+/**
+ * Register `hazel g module <name>` as a sub-command of the generate command.
+ *
+ * @param program - The Commander `generate` parent command
+ */
 export declare function generateModule(program: Command): void;

package/dist/commands/generate-module.js

@@ -64,6 +64,13 @@ const UPDATE_DTO_TEMPLATE = `export class Update{{className}}Dto {
   name?: string;
 }
 `;
+/**
+ * Generate a complete feature module (5 files: module, controller, service, 2 DTOs).
+ *
+ * @param name    - Feature name (e.g. 'users') — determines file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json)
+ * @returns GenerateResult with paths of all created files
+ */
 async function runModule(name, options) {
     const className = (0, generator_1.toPascalCase)(name);
     const fileName = (0, generator_1.toKebabCase)(name);
@@ -95,6 +102,11 @@ async function runModule(name, options) {
         nextSteps: [`Import ${className}Module in your app module.`],
     };
 }
+/**
+ * Register `hazel g module <name>` as a sub-command of the generate command.
+ *
+ * @param program - The Commander `generate` parent command
+ */
 function generateModule(program) {
     program
         .command('module <name>')

package/dist/commands/generate-simple.d.ts

@@ -1,27 +1,74 @@
 /**
  * Config-driven generator factory for simple single-file generators.
- * Replaces 12+ individual generator files with one data-driven approach.
+ *
+ * Architecture:
+ *   1. Templates live in ./templates.ts (Mustache strings, one per generator type).
+ *   2. SIMPLE_GENERATORS is a declarative config array — each entry maps a CLI
+ *      sub-command to a template, suffix, alias, and optional next-steps.
+ *   3. registerSimpleGenerators() loops over the config and registers each one
+ *      as a Commander sub-command of `hazel generate`.
+ *   4. runSimpleGenerator() instantiates a lightweight SimpleGenerator (extends
+ *      the base Generator class) and renders the template with the user's name.
+ *
+ * To add a new single-file generator:
+ *   1. Add a Mustache template in ./templates.ts
+ *   2. Add a SimpleGeneratorConfig entry to SIMPLE_GENERATORS below
+ *   — that's it; the CLI, --list, --json, and --dry-run support are automatic.
  */
 import { Command } from 'commander';
 import { GenerateResult, GenerateCLIOptions } from '../utils/generator';
+/**
+ * Declarative configuration for a single-file generator.
+ *
+ * Each entry in SIMPLE_GENERATORS produces one CLI sub-command under
+ * `hazel generate` (e.g. `hazel g controller <name>`).
+ */
 export interface SimpleGeneratorConfig {
+    /** Generator type used as the sub-command name (e.g. 'controller', 'agent') */
     type: string;
+    /** Human-readable description shown in `hazel g --list` and `--help` */
     description: string;
+    /** File suffix before .ts — e.g. 'controller' produces `name.controller.ts` */
     suffix: string;
+    /** Mustache template string (imported from ./templates.ts) */
     template: string;
+    /** Short alias for the sub-command (e.g. 'c' for controller) */
     alias?: string;
+    /** Default output directory if --path is not provided (defaults to 'src') */
     defaultPath?: string;
+    /** Whether the generator requires a <name> argument (false for config, etc.) */
     nameRequired: boolean;
-    /** Extra template data injected at generation time */
+    /** Factory function returning extra Mustache data merged into the template context */
     extraData?: (name: string) => Record<string, string>;
-    /** Next steps shown after generation */
+    /** Post-generation instructions printed to the user (e.g. 'npm install ...') */
     nextSteps?: string[];
-    /** Extra CLI options beyond --path, --dry-run, --json */
+    /** Additional CLI options beyond the standard --path, --dry-run, --json */
     extraOptions?: string[];
 }
 export declare const SIMPLE_GENERATORS: SimpleGeneratorConfig[];
+/**
+ * Execute a simple generator given its config, a name, and CLI options.
+ *
+ * @param config  - The SimpleGeneratorConfig entry (from SIMPLE_GENERATORS)
+ * @param name    - User-provided name (e.g. 'users') — used for file and class names
+ * @param options - Standard CLI options (--path, --dry-run, --json, --platform)
+ * @returns A GenerateResult with created file paths and optional next steps
+ */
 export declare function runSimpleGenerator(config: SimpleGeneratorConfig, name: string, options: GenerateCLIOptions): Promise<GenerateResult>;
-/** Register all simple generators as sub-commands of the generate command */
+/**
+ * Register all simple generators as sub-commands of the `hazel generate` command.
+ *
+ * Iterates over SIMPLE_GENERATORS and creates a Commander sub-command for each,
+ * wiring up aliases, options (--path, --dry-run, --json, plus any extraOptions),
+ * and the action handler that calls runSimpleGenerator.
+ *
+ * @param generateCommand - The Commander `generate` parent command to attach sub-commands to
+ */
 export declare function registerSimpleGenerators(generateCommand: Command): void;
-/** Lookup a simple generator config by type */
+/**
+ * Look up a SimpleGeneratorConfig by its type name (e.g. 'controller', 'agent').
+ *
+ * @param type - The generator type to find
+ * @returns The matching config, or undefined if no simple generator matches
+ */
 export declare function findSimpleGenerator(type: string): SimpleGeneratorConfig | undefined;