configforge 1.0.0-beta.10 → 1.0.0-beta.11

package/README.md

@@ -781,6 +781,57 @@ const result = await converter.convert('./config.yml');
 await result.save('./config.json');
 ```
 
+### Example 9: CLI Generation System
+
+```javascript
+const { forge, CLIGenerator } = require('configforge');
+
+// Create your converter
+const converter = forge()
+  .from('legacy')
+  .to('modern')
+  .map('app_name', 'name')
+  .map('app_version', 'version')
+  .map('database.host', 'db.hostname')
+  .map('database.port', 'db.port')
+  .defaults({
+    environment: 'production',
+  });
+
+// Generate CLI for your converter
+const cli = CLIGenerator.forConverter(converter, {
+  name: 'config-converter',
+  version: '1.0.0',
+  description: 'Convert legacy config to modern format',
+});
+
+// Add custom commands
+cli.addCommand({
+  name: 'migrate',
+  description: 'Migrate all configs in a directory',
+  options: [
+    {
+      flags: '-d, --directory <dir>',
+      description: 'Directory containing config files',
+    },
+  ],
+  action: async options => {
+    // Custom migration logic
+    console.log(`Migrating configs in ${options.directory}`);
+  },
+});
+
+// Parse command line arguments
+cli.parse();
+
+// Now you can use your CLI:
+// $ config-converter convert input.yml output.json
+// $ config-converter validate config.yml
+// $ config-converter profile save my-config
+// $ config-converter profile list
+// $ config-converter migrate -d ./configs
+```
+
 ## 🎯 Key Features
 
 - ✅ **Simple API**: Just map fields and convert
@@ -793,6 +844,7 @@ await result.save('./config.json');
 - ✅ **Multi-field merging**: Use `merge()` to combine multiple sources into one target
 - ✅ **Default values**: Set fallback values
 - ✅ **Comprehensive Error Handling**: Advanced error reporting with context and suggestions ⭐ NEW!
+- ✅ **CLI Generation System**: Create command-line interfaces for converters ⭐ NEW!
 - ✅ **File support**: Convert YAML, JSON files directly
 - ✅ **Statistics**: Get detailed conversion reports
 - ✅ **TypeScript**: Full type safety
@@ -811,13 +863,13 @@ await result.save('./config.json');
 - **Field validation with `validate()`**
 - **Lifecycle hooks with `before()` and `after()`** ⭐ NEW!
 - **Advanced error handling and reporting system** ⭐ NEW!
+- **CLI generation system with command-line interfaces** ⭐ ENHANCED!
 - File parsing (YAML, JSON)
 - Conversion statistics and reporting
 - Async and sync conversion support
 
 **🚧 Coming Soon:**
 
-- CLI generation
 - Plugin system
 
 ## 💡 Tips
@@ -843,6 +895,9 @@ await result.save('./config.json');
 19. **Error handling provides helpful suggestions** - when field mapping fails, you'll get suggestions for similar field names
 20. **Errors include rich context** - see exactly where and why conversions failed with detailed error information
 21. **Use error categories** to filter and handle different types of errors (validation, mapping, parsing, etc.)
+22. **Create CLIs for converters** - use `CLIGenerator.forConverter(converter)` to generate command-line interfaces
+23. **Use CLI profiles** - save converter configurations as profiles for reuse: `cli profile save my-converter`
+24. **CLI supports batch processing** - convert multiple files at once with pattern matching and parallel processing
 
 ---
 

package/dist/index.d.ts

@@ -6,5 +6,6 @@ export * as validators from './validators/built-in';
 export { ValidatorRegistry, validatorRegistry, } from './validators/ValidatorRegistry';
 export * from './types';
 export * from './errors';
+export { CLIGenerator, CLIUtils, CommandBuilder, createCLI, createCommand, quickCLI, } from './scripts';
 export { parsePath, setPath, mergePaths, detectFormat } from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,KAAK,UAAU,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gCAAgC,CAAC;AACxC,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC;AAMzB,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,KAAK,UAAU,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gCAAgC,CAAC;AACxC,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC;AAGzB,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,SAAS,EACT,aAAa,EACb,QAAQ,GACT,MAAM,WAAW,CAAC;AAMnB,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectFormat = exports.mergePaths = exports.setPath = exports.parsePath = exports.validatorRegistry = exports.ValidatorRegistry = exports.validators = exports.transforms = exports.Mapper = exports.Converter = exports.forge = void 0;
+exports.detectFormat = exports.mergePaths = exports.setPath = exports.parsePath = exports.quickCLI = exports.createCommand = exports.createCLI = exports.CommandBuilder = exports.CLIUtils = exports.CLIGenerator = exports.validatorRegistry = exports.ValidatorRegistry = exports.validators = exports.transforms = exports.Mapper = exports.Converter = exports.forge = void 0;
 // Main exports
 var Forge_1 = require("./core/Forge");
 Object.defineProperty(exports, "forge", { enumerable: true, get: function () { return Forge_1.forge; } });
@@ -52,6 +52,14 @@ Object.defineProperty(exports, "validatorRegistry", { enumerable: true, get: fun
 __exportStar(require("./types"), exports);
 // Error handling exports
 __exportStar(require("./errors"), exports);
+// CLI exports
+var scripts_1 = require("./scripts");
+Object.defineProperty(exports, "CLIGenerator", { enumerable: true, get: function () { return scripts_1.CLIGenerator; } });
+Object.defineProperty(exports, "CLIUtils", { enumerable: true, get: function () { return scripts_1.CLIUtils; } });
+Object.defineProperty(exports, "CommandBuilder", { enumerable: true, get: function () { return scripts_1.CommandBuilder; } });
+Object.defineProperty(exports, "createCLI", { enumerable: true, get: function () { return scripts_1.createCLI; } });
+Object.defineProperty(exports, "createCommand", { enumerable: true, get: function () { return scripts_1.createCommand; } });
+Object.defineProperty(exports, "quickCLI", { enumerable: true, get: function () { return scripts_1.quickCLI; } });
 // Plugin exports
 // export { Plugin, PluginContext } from './plugins/Plugin'; // TODO: Implement plugin system
 // Utility exports

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,sCAAqC;AAA5B,8FAAA,KAAK,OAAA;AACd,8CAA6C;AAApC,sGAAA,SAAS,OAAA;AAClB,wCAAuC;AAA9B,gGAAA,MAAM,OAAA;AACf,sEAAsD;AACtD,oEAAoD;AACpD,oEAGwC;AAFtC,sHAAA,iBAAiB,OAAA;AACjB,sHAAA,iBAAiB,OAAA;AAEnB,0CAAwB;AAExB,yBAAyB;AACzB,2CAAyB;AAEzB,iBAAiB;AACjB,6FAA6F;AAE7F,kBAAkB;AAClB,iCAAuE;AAA9D,kGAAA,SAAS,OAAA;AAAE,gGAAA,OAAO,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,qGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,eAAe;AACf,sCAAqC;AAA5B,8FAAA,KAAK,OAAA;AACd,8CAA6C;AAApC,sGAAA,SAAS,OAAA;AAClB,wCAAuC;AAA9B,gGAAA,MAAM,OAAA;AACf,sEAAsD;AACtD,oEAAoD;AACpD,oEAGwC;AAFtC,sHAAA,iBAAiB,OAAA;AACjB,sHAAA,iBAAiB,OAAA;AAEnB,0CAAwB;AAExB,yBAAyB;AACzB,2CAAyB;AAEzB,cAAc;AACd,qCAOmB;AANjB,uGAAA,YAAY,OAAA;AACZ,mGAAA,QAAQ,OAAA;AACR,yGAAA,cAAc,OAAA;AACd,oGAAA,SAAS,OAAA;AACT,wGAAA,aAAa,OAAA;AACb,mGAAA,QAAQ,OAAA;AAGV,iBAAiB;AACjB,6FAA6F;AAE7F,kBAAkB;AAClB,iCAAuE;AAA9D,kGAAA,SAAS,OAAA;AAAE,gGAAA,OAAO,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,qGAAA,YAAY,OAAA"}

package/dist/scripts/CLIGenerator.d.ts

@@ -0,0 +1,109 @@
+import { Command } from 'commander';
+/**
+ * CLI command configuration
+ */
+export interface CLICommand {
+    name: string;
+    description: string;
+    options?: CLIOption[];
+    action: (args: any, options: any) => Promise<void> | void;
+}
+/**
+ * CLI option configuration
+ */
+export interface CLIOption {
+    flags: string;
+    description: string;
+    defaultValue?: any;
+}
+/**
+ * CLI generation options
+ */
+export interface CLIGeneratorOptions {
+    name?: string;
+    version?: string;
+    description?: string;
+    commands?: CLICommand[];
+    globalOptions?: CLIOption[];
+}
+/**
+ * Profile configuration for saving converter setups
+ */
+export interface ConverterProfile {
+    name: string;
+    description?: string;
+    converter: any;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * CLI Generator for creating command-line interfaces for ConfigForge converters
+ */
+export declare class CLIGenerator {
+    private program;
+    private options;
+    private profiles;
+    private profilesPath;
+    constructor(options?: CLIGeneratorOptions);
+    /**
+     * Set up the main program configuration
+     */
+    private setupProgram;
+    /**
+     * Add built-in commands for common operations
+     */
+    private addBuiltInCommands;
+    /**
+     * Add a custom command to the CLI
+     */
+    addCommand(command: CLICommand): void;
+    /**
+     * Handle the convert command
+     */
+    private handleConvertCommand;
+    /**
+     * Handle the validate command
+     */
+    private handleValidateCommand;
+    /**
+     * Handle profile list command
+     */
+    private handleProfileListCommand;
+    /**
+     * Handle profile save command
+     */
+    private handleProfileSaveCommand;
+    /**
+     * Handle profile delete command
+     */
+    private handleProfileDeleteCommand;
+    /**
+     * Handle profile show command
+     */
+    private handleProfileShowCommand;
+    /**
+     * Load profiles from disk
+     */
+    private loadProfiles;
+    /**
+     * Save profiles to disk
+     */
+    private saveProfiles;
+    /**
+     * Deserialize a converter from configuration
+     */
+    private deserializeConverter;
+    /**
+     * Parse command line arguments and execute
+     */
+    parse(argv?: string[]): Promise<void>;
+    /**
+     * Get the commander program instance
+     */
+    getProgram(): Command;
+    /**
+     * Create a CLI for a specific converter
+     */
+    static forConverter(_converter: any, options?: Partial<CLIGeneratorOptions>): CLIGenerator;
+}
+//# sourceMappingURL=CLIGenerator.d.ts.map

package/dist/scripts/CLIGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CLIGenerator.d.ts","sourceRoot":"","sources":["../../src/scripts/CLIGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAQpC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,QAAQ,CAA4C;IAC5D,OAAO,CAAC,YAAY,CAAS;gBAEjB,OAAO,GAAE,mBAAwB;IAgB7C;;OAEG;IACH,OAAO,CAAC,YAAY;IAwBpB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAyE1B;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAuBrC;;OAEG;YACW,oBAAoB;IAmGlC;;OAEG;YACW,qBAAqB;IAiFnC;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAyBhC;;OAEG;YACW,wBAAwB;IAuCtC;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAWlC;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAsBhC;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB;;OAEG;IACH,OAAO,CAAC,YAAY;IASpB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAY5B;;OAEG;IACG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3C;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB;;OAEG;IACH,MAAM,CAAC,YAAY,CACjB,UAAU,EAAE,GAAG,EACf,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GACzC,YAAY;CA2BhB"}