@nocobase/cli 2.1.0-alpha.4 → 2.1.0-alpha.45

package/dist/commands/skills/install.js

@@ -0,0 +1,80 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { installNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsInstall extends Command {
+    static summary = 'Install the NocoBase AI coding skills globally';
+    static description = 'Install the NocoBase AI coding skills globally. If they are already installed, this command does not update them.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the install confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed install output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsInstall);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Install the NocoBase AI coding skills globally?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await installNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are already installed globally. Run `nb skills update` to refresh them.'
+                : 'NocoBase AI coding skills are already installed globally.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Installed the NocoBase AI coding skills globally.'
+            : 'Installed NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/skills/remove.js

@@ -0,0 +1,80 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { removeNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsRemove extends Command {
+    static summary = 'Remove the globally installed NocoBase AI coding skills';
+    static description = 'Remove the skills installed from nocobase/skills globally. This only removes the skills managed by `nb`.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the remove confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed remove output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsRemove);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Remove the globally installed NocoBase AI coding skills?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await removeNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are not installed globally.'
+                : 'NocoBase AI coding skills are not installed.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Removed the global NocoBase AI coding skills.'
+            : 'Removed NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/skills/update.js

@@ -0,0 +1,87 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { updateNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsUpdate extends Command {
+    static summary = 'Update the globally installed NocoBase AI coding skills';
+    static description = 'Refresh the globally installed NocoBase AI coding skills. This command only updates an existing @nocobase/skills install.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the update confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed update output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsUpdate);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Update the globally installed NocoBase AI coding skills?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await updateNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                reason: result.action === 'noop' ? result.reason : undefined,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            if (result.reason === 'not-installed') {
+                this.log(flags.verbose
+                    ? 'NocoBase AI coding skills are not installed globally. Run `nb skills install` first.'
+                    : 'Skipped skills update because NocoBase AI coding skills are not installed.');
+                return;
+            }
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are already up to date globally.'
+                : 'NocoBase AI coding skills are up to date.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Updated the global NocoBase AI coding skills.'
+            : 'Updated NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/source/build.js

@@ -0,0 +1,58 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { runNocoBaseCommand } from "../../lib/run-npm.js";
+import { setVerboseMode } from '../../lib/ui.js';
+export default class SourceBuild extends Command {
+    static hidden = false;
+    static args = {
+        /** Matches `nb source build @nocobase/acl @nocobase/actions` — zero or more package names. */
+        packages: Args.string({
+            description: 'package names to build',
+            multiple: true,
+            required: false,
+        }),
+    };
+    static description = 'Run the legacy NocoBase build for the local source project (forwards to `npm run build` in the repo root)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --no-dts',
+        '<%= config.bin %> <%= command.id %> --sourcemap',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl @nocobase/actions',
+    ];
+    static flags = {
+        'cwd': Flags.string({ description: 'Current working directory', char: 'c', required: false }),
+        'no-dts': Flags.boolean({ description: 'not generate dts' }),
+        sourcemap: Flags.boolean({ description: 'generate sourcemap' }),
+        verbose: Flags.boolean({ description: 'Show detailed command output', default: false }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(SourceBuild);
+        setVerboseMode(flags.verbose);
+        const packages = args.packages ?? [];
+        const npmArgs = ['build', ...packages];
+        if (flags['no-dts']) {
+            npmArgs.push('--no-dts');
+        }
+        if (flags.sourcemap) {
+            npmArgs.push('--sourcemap');
+        }
+        try {
+            await runNocoBaseCommand(npmArgs, {
+                cwd: flags['cwd'],
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(message);
+        }
+    }
+}

package/dist/commands/source/dev.js

@@ -0,0 +1,182 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { ensureLocalPostinstall } from '../../lib/app-managed-resources.js';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { announceTargetEnv, failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+function formatUnsupportedRuntimeMessage(kind, envName) {
+    if (kind === 'docker') {
+        return [
+            `Can't run dev mode for "${envName}".`,
+            'This env is managed by Docker, but `nb source dev` requires a local npm or Git source directory.',
+            `Use \`nb app logs --env ${envName}\` to inspect the Docker app, or create a source-based env with \`nb init --env ${envName} --source git\`.`,
+        ].join('\n');
+    }
+    if (kind === 'ssh') {
+        return [
+            `Can't run dev mode for "${envName}" yet.`,
+            'SSH env support is reserved but not implemented yet.',
+            `Create a source-based env with \`nb init --env ${envName} --source git\` if you want local development mode right now.`,
+        ].join('\n');
+    }
+    return [
+        `Can't run dev mode for "${envName}".`,
+        'This env only has an API connection, but `nb source dev` requires a local npm or Git source directory.',
+        `Create a source-based env with \`nb init --env ${envName} --source git\` if you want local development mode.`,
+    ].join('\n');
+}
+function appUrlForPort(port) {
+    const value = String(port ?? '').trim();
+    if (!value) {
+        return undefined;
+    }
+    return `http://127.0.0.1:${value}`;
+}
+async function isAppAlreadyRunning(appUrl) {
+    if (!appUrl) {
+        return false;
+    }
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), 1500);
+    try {
+        const response = await fetch(`${appUrl}/api/__health_check`, {
+            signal: controller.signal,
+        });
+        const text = await response.text();
+        return response.ok && text.trim().toLowerCase() === 'ok';
+    }
+    catch (_error) {
+        return false;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+export default class SourceDev extends Command {
+    static hidden = false;
+    static description = 'Run NocoBase in local development mode for an npm or Git source env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --db-sync',
+        '<%= config.bin %> <%= command.id %> --env app1 --port 12000',
+        '<%= config.bin %> <%= command.id %> --env app1 --client',
+        '<%= config.bin %> <%= command.id %> --env app1 --server',
+        '<%= config.bin %> <%= command.id %> --env app1 --inspect 9229',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to run dev mode for. Defaults to the current env when omitted',
+            required: false,
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+            required: false,
+        }),
+        'db-sync': Flags.boolean({
+            description: 'Synchronize the database before starting dev mode',
+            required: false,
+        }),
+        port: Flags.string({
+            description: 'Development server port',
+            char: 'p',
+            required: false,
+        }),
+        client: Flags.boolean({
+            description: 'Run client dev mode only',
+            char: 'c',
+            required: false,
+        }),
+        server: Flags.boolean({
+            description: 'Run server dev mode only',
+            char: 's',
+            required: false,
+        }),
+        inspect: Flags.string({
+            description: 'Node.js inspect port for server debugging',
+            char: 'i',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceDev);
+        const requestedEnv = flags.env?.trim() || undefined;
+        if (requestedEnv && hasExplicitEnvSelection(this.argv)) {
+            const confirmed = await ensureCrossEnvConfirmed({
+                command: this,
+                requestedEnv,
+                yes: flags.yes,
+            });
+            if (!confirmed) {
+                return;
+            }
+        }
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'docker' || runtime.kind === 'http' || runtime.kind === 'ssh') {
+            this.error(formatUnsupportedRuntimeMessage(runtime.kind, runtime.envName));
+        }
+        announceTargetEnv(runtime.envName);
+        const devPort = flags.port
+            || (runtime.env.appPort !== undefined && runtime.env.appPort !== null
+                ? String(runtime.env.appPort).trim()
+                : undefined);
+        const appUrl = appUrlForPort(devPort);
+        if (await isAppAlreadyRunning(appUrl)) {
+            this.error([
+                `NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`,
+                flags.port
+                    ? `Choose another dev port with --port, or stop the running app with \`nb app stop --env ${runtime.envName}\` first.`
+                    : `Run \`nb app stop --env ${runtime.envName}\` before starting dev mode, or choose another dev port with --port.`,
+            ].join('\n'));
+        }
+        const npmArgs = ['dev', '--rsbuild'];
+        if (flags['db-sync']) {
+            npmArgs.push('--db-sync');
+        }
+        if (devPort) {
+            npmArgs.push('--port', devPort);
+        }
+        if (flags.client) {
+            npmArgs.push('--client');
+        }
+        if (flags.server) {
+            npmArgs.push('--server');
+        }
+        if (flags.inspect) {
+            npmArgs.push('--inspect', flags.inspect);
+        }
+        printInfo(`Starting NocoBase dev mode for "${runtime.envName}" from ${runtime.projectRoot}. Press Ctrl+C to stop.`);
+        try {
+            await ensureLocalPostinstall(runtime, {
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+                verbose: true,
+            });
+            await runLocalNocoBaseCommand(runtime, npmArgs, {
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error([
+                `Couldn't start dev mode for "${runtime.envName}".`,
+                'Check that dependencies are installed and the saved env settings are valid, then try again.',
+                `Details: ${message}`,
+            ].join('\n'));
+        }
+    }
+}