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

package/dist/commands/source/publish.js

@@ -0,0 +1,109 @@
+/**
+ * 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 { buildSuggestedInitCommand, publishSourceSnapshot } from '../../lib/source-publish.js';
+import { failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+function formatPublishFailure(message) {
+    if (message.includes('The specified --cwd does not exist:')
+        || message.includes('The specified --cwd is not a directory:')
+        || message.includes('Couldn\'t find a NocoBase source project from --cwd:')) {
+        return message;
+    }
+    return [
+        'Couldn\'t publish a source snapshot.',
+        'Check that Docker is running, the target npm registry is reachable, and the current directory is a NocoBase source repo.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourcePublish extends Command {
+    static description = 'Publish the current NocoBase source repo as a snapshot version to an npm registry for install testing.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --snapshot',
+        '<%= config.bin %> <%= command.id %> --snapshot --no-build',
+        '<%= config.bin %> <%= command.id %> --snapshot --build-dts',
+        '<%= config.bin %> <%= command.id %> --snapshot --cwd /path/to/nocobase/source',
+        '<%= config.bin %> <%= command.id %> --snapshot --npm-registry=http://127.0.0.1:4873',
+        '<%= config.bin %> <%= command.id %> --snapshot --json',
+    ];
+    static flags = {
+        snapshot: Flags.boolean({
+            description: 'Publish the current source repo as a unique snapshot version',
+            required: true,
+            default: false,
+        }),
+        'npm-registry': Flags.string({
+            description: 'npm registry URL to publish to. Defaults to the running local source registry when available',
+            required: false,
+        }),
+        cwd: Flags.string({
+            description: 'Source repository path. Defaults to the nearest detected NocoBase source root from the current working directory',
+            required: false,
+        }),
+        'no-build': Flags.boolean({
+            description: 'Skip building the source repo before snapshot versioning and publish',
+            default: false,
+        }),
+        'build-dts': Flags.boolean({
+            description: 'Generate TypeScript declaration files during the source build',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Print the publish result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed command output while versioning and publishing the snapshot',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourcePublish);
+        if (!flags.snapshot) {
+            this.error('`nb source publish` currently requires `--snapshot`.');
+        }
+        if (!flags.json) {
+            startTask('Publishing a source snapshot...');
+        }
+        try {
+            const result = await publishSourceSnapshot({
+                cwd: flags.cwd,
+                npmRegistry: flags['npm-registry'],
+                build: !flags['no-build'],
+                buildDts: flags['build-dts'],
+                verbose: flags.verbose,
+            });
+            if (flags.json) {
+                this.log(JSON.stringify({
+                    version: result.version,
+                    npmRegistry: result.npmRegistry,
+                    gitSha: result.gitSha,
+                    projectRoot: result.projectRoot,
+                    suggestedInitCommand: buildSuggestedInitCommand(result),
+                }, null, 2));
+                return;
+            }
+            succeedTask(`Published source snapshot ${result.version} to ${result.npmRegistry}.`);
+            printInfo(`Source root: ${result.projectRoot}`);
+            printInfo(`Snapshot version: ${result.version}`);
+            printInfo(`npm registry: ${result.npmRegistry}`);
+            printInfo(`Next: ${buildSuggestedInitCommand(result)}`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            if (flags.json) {
+                this.logToStderr(JSON.stringify({
+                    error: formatPublishFailure(message),
+                }, null, 2));
+                this.exit(1);
+            }
+            failTask('Failed to publish the source snapshot.');
+            this.error(formatPublishFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/logs.js

@@ -0,0 +1,70 @@
+/**
+ * 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 { run } from '../../../lib/run-npm.js';
+import { printInfo } from '../../../lib/ui.js';
+import { getSourceRegistryInfo } from '../../../lib/source-registry.js';
+function formatLogsFailure(message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            'Can\'t show source registry logs yet.',
+            'The saved source registry container could not be found on this machine.',
+            'Start the registry first with `nb source registry start`.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        'Couldn\'t show source registry logs.',
+        'Check that Docker is installed and the source registry container still exists, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourceRegistryLogs extends Command {
+    static description = 'Show logs for the local Docker-based npm registry used for source tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --tail 200',
+        '<%= config.bin %> <%= command.id %> --follow',
+    ];
+    static flags = {
+        tail: Flags.integer({
+            description: 'Number of recent log lines to show before following',
+            default: 100,
+            min: 0,
+        }),
+        follow: Flags.boolean({
+            char: 'f',
+            description: 'Keep streaming new log lines',
+            default: false,
+            allowNo: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryLogs);
+        const info = getSourceRegistryInfo();
+        printInfo(flags.follow
+            ? `Showing source registry logs from "${info.containerName}" (press Ctrl+C to stop).`
+            : `Showing recent source registry logs from "${info.containerName}".`);
+        const dockerArgs = ['logs', '--tail', String(flags.tail ?? 100)];
+        if (flags.follow) {
+            dockerArgs.push('--follow');
+        }
+        dockerArgs.push(info.containerName);
+        try {
+            await run('docker', dockerArgs, {
+                errorName: 'docker logs',
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(formatLogsFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/start.js

@@ -0,0 +1,57 @@
+/**
+ * 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 { failTask, startTask, succeedTask } from '../../../lib/ui.js';
+import { getSourceRegistryInfo, startSourceRegistry } from '../../../lib/source-registry.js';
+function formatStartFailure(message) {
+    if (/port is already allocated|address already in use/i.test(message)) {
+        return [
+            'Can\'t start the source registry.',
+            'Port 4873 is already in use on this machine.',
+            'Stop the conflicting process, or free the port before trying again.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        'Couldn\'t start the source registry.',
+        'Check that Docker is installed and running, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourceRegistryStart extends Command {
+    static description = 'Start the local Docker-based npm registry used for source snapshot publish and install tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --verbose',
+    ];
+    static flags = {
+        verbose: Flags.boolean({
+            description: 'Show raw Docker output while starting the registry container',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryStart);
+        const info = getSourceRegistryInfo();
+        startTask(`Starting the source registry at ${info.url}...`);
+        try {
+            const state = await startSourceRegistry({
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+            succeedTask(state === 'already-running'
+                ? `The source registry is already running at ${info.url}.`
+                : `The source registry is running at ${info.url}.`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask('Failed to start the source registry.');
+            this.error(formatStartFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/status.js

@@ -0,0 +1,33 @@
+/**
+ * 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 { renderTable } from '../../../lib/ui.js';
+import { resolveSourceRegistryInfo } from '../../../lib/source-registry.js';
+export default class SourceRegistryStatus extends Command {
+    static description = 'Show the status of the local Docker-based npm registry used for source tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        json: Flags.boolean({
+            description: 'Print the source registry status as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryStatus);
+        const info = await resolveSourceRegistryInfo();
+        if (flags.json) {
+            this.log(JSON.stringify(info, null, 2));
+            return;
+        }
+        this.log(renderTable(['Container', 'Status', 'URL', 'Storage'], [[info.containerName, info.status, info.url, info.storageDir]]));
+    }
+}

package/dist/commands/source/registry/stop.js

@@ -0,0 +1,48 @@
+/**
+ * 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 { failTask, startTask, succeedTask } from '../../../lib/ui.js';
+import { stopSourceRegistry } from '../../../lib/source-registry.js';
+function formatStopFailure(message) {
+    return [
+        'Couldn\'t stop the source registry.',
+        'Check that Docker is installed and the saved registry container still exists, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourceRegistryStop extends Command {
+    static description = 'Stop the local Docker-based npm registry used for source snapshot tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --verbose',
+    ];
+    static flags = {
+        verbose: Flags.boolean({
+            description: 'Show raw Docker output while stopping the registry container',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryStop);
+        startTask('Stopping the source registry...');
+        try {
+            const state = await stopSourceRegistry({
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+            succeedTask(state === 'already-stopped'
+                ? 'The source registry is already stopped.'
+                : 'The source registry has stopped.');
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask('Failed to stop the source registry.');
+            this.error(formatStopFailure(message));
+        }
+    }
+}