@nexical/cli-core 0.1.0

package/.github/workflows/deploy.yml

@@ -0,0 +1,34 @@
+name: Deploy Nexical Core CLI Framework
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Build & Publish
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm run test
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Cellebris LTD
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/index.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+import { CLI } from './src/CLI.js';
+
+import { logger } from './src/utils/logger.js';
+
+logger.debug('CLI ENTRY POINT HIT', process.argv);
+
+const app = new CLI();
+app.start();

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@nexical/cli-core",
+    "version": "0.1.0",
+    "type": "module",
+    "scripts": {
+        "build": "tsup",
+        "dev": "tsup --watch",
+        "cli": "node dist/index.js",
+        "test": "npm run test:unit && npm run test:integration && npm run test:e2e",
+        "test:unit": "vitest run --config vitest.config.ts --coverage",
+        "test:integration": "vitest run --config vitest.integration.config.ts",
+        "test:e2e": "npm run build && vitest run --config vitest.e2e.config.ts",
+        "test:watch": "vitest"
+    },
+    "dependencies": {
+        "cac": "^6.7.14",
+        "consola": "^3.4.2",
+        "lilconfig": "^3.1.3",
+        "picocolors": "^1.1.1",
+        "yaml": "^2.8.2",
+        "zod": "^3.22.4"
+    },
+    "devDependencies": {
+        "@types/fs-extra": "^11.0.4",
+        "@types/node": "^20.10.0",
+        "@vitest/coverage-v8": "^4.0.15",
+        "execa": "^9.6.1",
+        "fs-extra": "^11.3.2",
+        "tsup": "^8.0.1",
+        "typescript": "^5.3.3",
+        "vitest": "^4.0.15"
+    }
+}

package/src/BaseCommand.ts

@@ -0,0 +1,73 @@
+import { logger } from './utils/logger.js';
+import { CommandDefinition, CommandInterface } from './CommandInterface.js';
+import { findProjectRoot, loadConfig } from './utils/config.js';
+import process from 'node:process';
+
+export abstract class BaseCommand implements CommandInterface {
+    static usage = '';
+    static description = '';
+    static args: CommandDefinition = {};
+
+    // Configurable flags
+    static requiresProject = false;
+
+    protected projectRoot: string | null = null;
+    protected config: any = {};
+    protected globalOptions: any = {};
+    protected cli: any = null;
+
+
+    constructor(cli: any, globalOptions: any = {}) {
+        this.globalOptions = globalOptions;
+        this.cli = cli;
+    }
+
+    async init() {
+        // 1. Root detection strategy
+        if (this.globalOptions.rootDir) {
+            this.projectRoot = this.globalOptions.rootDir;
+        } else {
+            this.projectRoot = await findProjectRoot(this.cli.name, process.cwd());
+        }
+
+        const requiresProject = (this.constructor as any).requiresProject;
+
+        if (requiresProject && !this.projectRoot) {
+            this.error('This command requires to be run within an app project (app.yml not found).', 1);
+            return; // TS doesn't know error exits
+        }
+
+        if (this.projectRoot) {
+            this.config = await loadConfig(this.cli.name, this.projectRoot);
+            // logger.debug(`Loaded config from ${this.projectRoot}`);
+        }
+    }
+
+    abstract run(options: any): Promise<void>;
+
+    // Helpers
+    success(msg: string) {
+        logger.success(msg);
+    }
+
+
+    info(msg: string) {
+        logger.info(msg);
+    }
+
+    warn(msg: string) {
+        logger.warn(msg);
+    }
+
+    error(msg: string | Error, code = 1) {
+        if (msg instanceof Error) {
+            logger.error(msg.message);
+            if (this.globalOptions.debug) {
+                logger.error(msg.stack);
+            }
+        } else {
+            logger.error(msg);
+        }
+        process.exit(code);
+    }
+}

package/src/CLI.ts

@@ -0,0 +1,316 @@
+import { cac } from 'cac';
+import { CommandLoader } from './CommandLoader.js';
+import path from 'node:path';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import pc from 'picocolors';
+import pkg from '../package.json';
+import { logger, setDebugMode } from './utils/logger.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export interface CLIConfig {
+    commandName?: string;
+    searchDirectories?: string[];
+}
+
+export class CLI {
+    public name: string;
+    private cli: ReturnType<typeof cac>;
+    private loader: CommandLoader;
+    private HelpCommandClass: any;
+    private config: CLIConfig;
+
+    constructor(config: CLIConfig = {}) {
+        this.config = config;
+        this.name = this.config.commandName || 'app';
+        this.cli = cac(this.name);
+        this.loader = new CommandLoader(this);
+    }
+
+    private loadedCommands: any[] = [];
+
+    getCommands() {
+        return this.loadedCommands;
+    }
+
+    getRawCLI() {
+        return this.cli;
+    }
+
+    async start() {
+        // In built version, we are in dist/index.js (from cli/index.ts) -> core bundled? or just imported.
+        // The core logic is now in src/cli/core/src/CLI.ts or dist/core/src/CLI.js
+
+        // Check for debug flag early
+        if (process.argv.includes('--debug')) {
+            setDebugMode(true);
+            logger.debug('Debug mode enabled via --debug flag');
+        }
+
+        let commandsDirs: string[] = [];
+
+        if (this.config.searchDirectories && this.config.searchDirectories.length > 0) {
+            commandsDirs = this.config.searchDirectories;
+        } else {
+            // We assume the standard structure:
+            // cli/
+            //   index.js
+            //   commands/
+            //   core/
+            //     src/
+            //       CLI.ts
+
+            // When running from source (ts-node src/cli/index.ts), specific commands are in src/cli/commands.
+            // core is in src/cli/core/src.
+            // Relative path from CLI.ts to commands: ../../../commands
+
+            const possibleDirs = [
+                path.resolve(__dirname, './src/commands'),
+                path.resolve(process.cwd(), 'commands')    // Fallback relative to cwd?
+            ];
+
+            for (const dir of possibleDirs) {
+                if (fs.existsSync(dir)) {
+                    commandsDirs.push(dir);
+                    break; // Keep existing behavior: verify if we want multiple or just first found
+                }
+            }
+        }
+
+        // Fallback or error
+        if (commandsDirs.length === 0) {
+            logger.debug("No commands directory found.");
+        }
+
+        for (const dir of commandsDirs) {
+            // Loader accumulates commands
+            await this.loader.load(dir);
+        }
+        this.loadedCommands = this.loader.getCommands();
+
+        // Group commands by root command name
+        const commandGroups: Record<string, any[]> = {};
+        // Locate HelpCommand for fallback usage
+        const helpCmd = this.loadedCommands.find(c => c.command === 'help');
+        if (helpCmd) {
+            this.HelpCommandClass = helpCmd.class;
+        }
+
+        for (const cmd of this.loadedCommands) {
+            const root = cmd.command.split(' ')[0];
+            if (!commandGroups[root]) commandGroups[root] = [];
+            commandGroups[root].push(cmd);
+        }
+
+        for (const [root, cmds] of Object.entries(commandGroups)) {
+            // Case 1: Single command, no subcommands (e.g. 'init')
+            if (cmds.length === 1 && cmds[0].command === root) {
+                const cmd = cmds[0];
+                const CommandClass = cmd.class;
+                // Original logic for single command
+                let commandName = cmd.command;
+                const argsDef = CommandClass.args || {};
+                if (argsDef.args) {
+                    argsDef.args.forEach((arg: any) => {
+                        const isVariadic = arg.name.endsWith('...');
+                        const cleanName = isVariadic ? arg.name.slice(0, -3) : arg.name;
+                        // Always use optional brackets [] for CAC to allow --help to pass validation
+                        // We will enforce 'required' manually in the action handler
+                        commandName += isVariadic ? ` [...${cleanName}]` : ` [${cleanName}]`;
+                    });
+                }
+                const cacCommand = this.cli.command(commandName, CommandClass.description || '');
+
+                // Register options
+                if (argsDef.options) {
+                    argsDef.options.forEach((opt: any) => {
+                        cacCommand.option(opt.name, opt.description, { default: opt.default });
+                    });
+                }
+                this.registerGlobalOptions(cacCommand);
+
+                cacCommand.action(async (...args: any[]) => {
+                    const options = args.pop();
+
+                    if (options.help) {
+                        await this.runHelp([cmd.command]);
+                        return;
+                    }
+
+                    const positionalArgs = args;
+
+                    if (argsDef.args) {
+                        argsDef.args.forEach((arg: any, index: number) => {
+                            const isVariadic = arg.name.endsWith('...');
+                            const name = isVariadic ? arg.name.slice(0, -3) : arg.name;
+                            const val = positionalArgs[index];
+
+                            if (val !== undefined) {
+                                options[name] = val;
+                            } else if (arg.required) {
+                                console.error(pc.red(`Missing required argument: ${name}`));
+                                this.runHelp([cmd.command]).then(() => process.exit(1));
+                                return;
+                            }
+                        });
+                    }
+                    await this.runCommand(CommandClass, options, [cmd.command]);
+                });
+            } else {
+                // Case 2: Command with subcommands (e.g. 'module add')
+                // Register 'module <subcommand>' catch-all
+                const commandName = `${root} [subcommand] [...args]`;
+                const cacCommand = this.cli.command(commandName, `Manage ${root} commands`);
+
+                cacCommand.allowUnknownOptions(); // Pass options to subcommand
+                this.registerGlobalOptions(cacCommand);
+
+                cacCommand.action(async (subcommand: string, ...args: any[]) => {
+                    const options = args.pop(); // last is options
+
+                    if (!subcommand || options.help) {
+                        // If --help is passed to 'module --help', subcommand might be caught as 'module' if args parsing is weird?  
+                        // ACTUALLY: cac parses 'module add --help' as subcommand="add".
+                        // 'module --help' might trigger the command itself? No, 'module <subcommand>' expects a subcommand.
+                        // If I run 'module --help', it might fail validation or parse 'help' as subcommand if unlucky, 
+                        // but likely it just prints help if we didn't override.
+
+                        await this.runHelp([root, subcommand].filter(Boolean));
+                        return;
+                    }
+
+
+                    // Find matching command
+                    // Match against "root subcommand"
+                    const fullCommandName = `${root} ${subcommand}`;
+                    const cmd = cmds.find(c => c.command === fullCommandName);
+
+                    if (!cmd) {
+                        console.error(pc.red(`Unknown subcommand '${subcommand}' for '${root}'`));
+                        process.exit(1);
+                    }
+
+                    const CommandClass = cmd.class;
+                    // Map remaining args? 
+                    // The args array contains positional args AFTER subcommand.
+                    // But we didn't define them in CAC, so they are just strings.
+                    // We need to map them manually to the Target Command's args definition.
+                    // argsDef.args usually starts after the command.
+                    // For 'module add <url>', <url> is the first arg after 'add'.
+                    // So 'args' here corresponds to <url>.
+
+                    const argsDef = CommandClass.args || {};
+                    // If using [...args], the variadic args are collected into the first argument array
+                    // args here is what remains after popping options.
+                    const positionalArgs = (args.length > 0 && Array.isArray(args[0])) ? args[0] : args;
+
+                    const childOptions = { ...options }; // Copy options
+
+                    const cmdParts = [root, subcommand];
+
+                    if (argsDef.args) {
+                        argsDef.args.forEach((arg: any, index: number) => {
+                            const isVariadic = arg.name.endsWith('...');
+                            const name = isVariadic ? arg.name.slice(0, -3) : arg.name;
+                            const val = positionalArgs[index];
+
+                            if (val !== undefined) {
+                                if (isVariadic) {
+                                    childOptions[name] = positionalArgs.slice(index);
+                                } else {
+                                    childOptions[name] = val;
+                                }
+                            } else if (arg.required) {
+                                console.error(pc.red(`Missing required argument: ${name}`));
+                                this.runHelp(cmdParts).then(() => process.exit(1));
+                                return;
+                            }
+                        });
+                    }
+
+                    await this.runCommand(CommandClass, childOptions, cmdParts);
+                });
+            }
+        }
+        // Disable default help
+        // this.cli.help(); 
+
+        // Manually register global help to ensure it's allowed
+        this.cli.option('--help, -h', 'Display help');
+
+        this.cli.version(pkg.version);
+
+        // Global help interception for root command
+        // If we run `app --help`, we need to catch it.
+        // CAC doesn't expose a clean global action without a command content.
+        // However, if we parse and no command matches, it usually errors or shows help.
+        // If we have default logic, we can put it here?
+        // Let's rely on standard parsing but maybe inspect raw args first?
+
+        if (process.argv.includes('--help') || process.argv.includes('-h')) {
+            // Inspect non-option args to see if there's a command?
+            const args = process.argv.slice(2).filter(a => !a.startsWith('-'));
+            if (args.length === 0) {
+                await this.runHelp([]);
+                process.exit(0);
+            }
+        }
+
+        try {
+            this.cli.parse();
+        } catch (e: any) {
+            console.error(pc.red(e.message));
+
+            // Try to provide helpful context
+            console.log('');
+            // Simple heuristic: find first non-flag arg as command
+            const args = process.argv.slice(2);
+            const potentialCommand = args.find(a => !a.startsWith('-'));
+            // If it matches a loaded command root, show help for it
+            // Otherwise show global help
+
+            // We need to match 'module add' etc?
+            // Just pass the potential command parts to runHelp. 
+            // runHelp handles filtering itself? No, runHelp takes commandParts to pass to HelpCommand.
+            // HelpCommand expects `command` array.
+
+            const helpArgs = potentialCommand ? [potentialCommand] : [];
+            await this.runHelp(helpArgs);
+
+            process.exit(1);
+        }
+    }
+
+    private registerGlobalOptions(cacCommand: any) {
+        cacCommand.option('--root-dir <path>', 'Override project root');
+        cacCommand.option('--debug', 'Enable debug mode');
+        cacCommand.option('--help, -h', 'Display help message');
+    }
+
+    private async runHelp(commandParts: string[]) {
+        if (this.HelpCommandClass) {
+            const helpInstance = new this.HelpCommandClass(this);
+            await helpInstance.run({ command: commandParts });
+        } else {
+            // Fallback if HelpCommand not loaded (shouldn't happen)
+            this.cli.outputHelp();
+        }
+    }
+
+    private async runCommand(CommandClass: any, options: any, commandParts: string[] = []) {
+        try {
+            const instance = new CommandClass(this, options);
+            await instance.init();
+            await instance.run(options);
+        } catch (e: any) {
+            console.error(pc.red(e.message));
+            if (options.debug) console.error(e.stack);
+
+            console.log(''); // spacer
+            await this.runHelp(commandParts);
+
+            process.exit(1);
+        }
+    }
+}