@nocobase/cli 2.1.0-beta.16 → 2.1.0-beta.19

package/dist/lib/run-npm.js

@@ -6,38 +6,83 @@
  * 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 { spawn } from 'node:child_process';
+/**
+ * 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 fs from 'node:fs';
 import path from 'node:path';
+import spawn from 'cross-spawn';
+const FORWARDED_SIGNALS = ['SIGINT', 'SIGTERM'];
 function resolveCommandName(name) {
-    if (process.platform !== 'win32' || path.extname(name) || name.includes(path.sep)) {
-        return name;
+    return name;
+}
+function pathExists(candidate) {
+    try {
+        return Boolean(candidate) && fs.statSync(candidate) !== undefined;
     }
-    if (['npm', 'npx', 'pnpm', 'yarn'].includes(name)) {
-        return `${name}.cmd`;
+    catch {
+        return false;
     }
-    return name;
 }
-function resolveCwd(cwd) {
+function hasLocalNocoBaseBinary(candidate) {
+    return (pathExists(path.join(candidate, 'node_modules', '.bin', 'nocobase-v1'))
+        || pathExists(path.join(candidate, 'node_modules', '.bin', 'nocobase-v1.cmd')));
+}
+export function resolveCwd(cwd) {
     const next = cwd ?? process.cwd();
     if (path.isAbsolute(next)) {
         return next;
     }
     return path.resolve(process.cwd(), next);
 }
+export function resolveProjectCwd(cwd) {
+    const normalizedCwd = typeof cwd === 'string' && cwd.trim() === '' ? undefined : cwd;
+    const next = normalizedCwd ?? process.cwd();
+    const resolvedNext = resolveCwd(normalizedCwd);
+    if (!normalizedCwd || path.isAbsolute(next)) {
+        return resolvedNext;
+    }
+    const baseCwd = process.cwd();
+    let current = baseCwd;
+    const fallback = resolvedNext;
+    while (true) {
+        const candidate = path.resolve(current, next);
+        if (hasLocalNocoBaseBinary(candidate)) {
+            return candidate;
+        }
+        const parent = path.dirname(current);
+        if (parent === current) {
+            return fallback;
+        }
+        current = parent;
+    }
+}
 export function run(name, args, options) {
     const cwd = resolveCwd(options?.cwd);
     const label = options?.errorName ?? name;
+    const command = resolveCommandName(name);
     return new Promise((resolve, reject) => {
-        const child = spawn(resolveCommandName(name), [...args], {
+        const child = spawn(command, [...args], {
             stdio: options?.stdio ?? 'inherit',
             cwd,
             env: {
                 ...process.env,
                 ...options?.env,
             },
+            windowsHide: process.platform === 'win32',
+        });
+        const cleanupSignalForwarding = forwardSignalsToChild(child);
+        child.once('error', (error) => {
+            cleanupSignalForwarding();
+            reject(error);
         });
-        child.once('error', reject);
         child.once('close', (code, signal) => {
+            cleanupSignalForwarding();
             if (code === 0) {
                 resolve();
                 return;
@@ -50,16 +95,45 @@ export function run(name, args, options) {
         });
     });
 }
+function forwardSignalsToChild(child) {
+    let forwardedSignalCount = 0;
+    const listeners = new Map();
+    const isChildRunning = () => child.exitCode === null && child.signalCode === null;
+    for (const signal of FORWARDED_SIGNALS) {
+        const listener = () => {
+            if (!isChildRunning()) {
+                return;
+            }
+            const nextSignal = forwardedSignalCount > 0 ? 'SIGKILL' : signal;
+            forwardedSignalCount += 1;
+            try {
+                child.kill(nextSignal);
+            }
+            catch {
+                // Ignore kill errors here and let the child close/error handlers surface the failure.
+            }
+        };
+        listeners.set(signal, listener);
+        process.on(signal, listener);
+    }
+    return () => {
+        for (const [signal, listener] of listeners) {
+            process.off(signal, listener);
+        }
+    };
+}
 export function commandSucceeds(name, args, options) {
     const cwd = resolveCwd(options?.cwd);
+    const command = resolveCommandName(name);
     return new Promise((resolve) => {
-        const child = spawn(resolveCommandName(name), [...args], {
+        const child = spawn(command, [...args], {
             cwd,
             env: {
                 ...process.env,
                 ...options?.env,
             },
             stdio: 'ignore',
+            windowsHide: process.platform === 'win32',
         });
         child.once('error', () => resolve(false));
         child.once('close', (code) => resolve(code === 0));
@@ -68,14 +142,16 @@ export function commandSucceeds(name, args, options) {
 export function commandOutput(name, args, options) {
     const cwd = resolveCwd(options?.cwd);
     const label = options?.errorName ?? name;
+    const command = resolveCommandName(name);
     return new Promise((resolve, reject) => {
-        const child = spawn(resolveCommandName(name), [...args], {
+        const child = spawn(command, [...args], {
             cwd,
             env: {
                 ...process.env,
                 ...options?.env,
             },
             stdio: ['ignore', 'pipe', 'pipe'],
+            windowsHide: process.platform === 'win32',
         });
         let stdout = '';
         let stderr = '';
@@ -107,16 +183,14 @@ export function runNpm(args, options) {
     return run('yarn', [...args], { ...options, errorName: 'npm' });
 }
 export function runNocoBaseCommand(args, options) {
-    let cwd = options?.cwd ?? process.cwd();
-    if (!path.isAbsolute(cwd)) {
-        cwd = path.resolve(process.cwd(), cwd);
-    }
+    const cwd = resolveProjectCwd(options?.cwd);
     const localBin = path.join(cwd, 'node_modules', '.bin');
-    return run('node', ['./node_modules/.bin/nocobase-v1', ...args], {
+    return run('nocobase-v1', [...args], {
         ...options,
+        cwd,
         errorName: 'nocobase command',
         env: {
-            PATH: `${localBin}${path.delimiter}${process.env.PATH}`,
+            PATH: `${localBin}${path.delimiter}${process.env.PATH ?? ''}`,
             ...options?.env,
         },
     });

package/dist/lib/self-manager.js

@@ -0,0 +1,246 @@
+/**
+ * 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 fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { commandOutput, run } from './run-npm.js';
+const DEFAULT_PACKAGE_NAME = '@nocobase/cli';
+const PACKAGE_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..');
+function normalizePath(value) {
+    return path.resolve(value);
+}
+function isSubPath(parent, child) {
+    const relative = path.relative(normalizePath(parent), normalizePath(child));
+    return relative === '' || (!relative.startsWith('..') && !path.isAbsolute(relative));
+}
+function parseVersion(version) {
+    const normalized = String(version ?? '').trim();
+    const match = normalized.match(/^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z-.]+))?$/);
+    if (!match) {
+        return undefined;
+    }
+    return {
+        major: Number(match[1]),
+        minor: Number(match[2]),
+        patch: Number(match[3]),
+        prerelease: match[4] ? match[4].split('.').filter(Boolean) : [],
+    };
+}
+function compareIdentifier(left, right) {
+    const leftNumeric = /^\d+$/.test(left);
+    const rightNumeric = /^\d+$/.test(right);
+    if (leftNumeric && rightNumeric) {
+        return Number(left) - Number(right);
+    }
+    if (leftNumeric) {
+        return -1;
+    }
+    if (rightNumeric) {
+        return 1;
+    }
+    return left.localeCompare(right);
+}
+export function compareVersions(leftVersion, rightVersion) {
+    const left = parseVersion(leftVersion);
+    const right = parseVersion(rightVersion);
+    if (!left || !right) {
+        return String(leftVersion ?? '').localeCompare(String(rightVersion ?? ''));
+    }
+    if (left.major !== right.major) {
+        return left.major - right.major;
+    }
+    if (left.minor !== right.minor) {
+        return left.minor - right.minor;
+    }
+    if (left.patch !== right.patch) {
+        return left.patch - right.patch;
+    }
+    if (left.prerelease.length === 0 && right.prerelease.length === 0) {
+        return 0;
+    }
+    if (left.prerelease.length === 0) {
+        return 1;
+    }
+    if (right.prerelease.length === 0) {
+        return -1;
+    }
+    const maxLength = Math.max(left.prerelease.length, right.prerelease.length);
+    for (let index = 0; index < maxLength; index += 1) {
+        const leftIdentifier = left.prerelease[index];
+        const rightIdentifier = right.prerelease[index];
+        if (leftIdentifier === undefined) {
+            return -1;
+        }
+        if (rightIdentifier === undefined) {
+            return 1;
+        }
+        const compared = compareIdentifier(leftIdentifier, rightIdentifier);
+        if (compared !== 0) {
+            return compared;
+        }
+    }
+    return 0;
+}
+function detectChannel(currentVersion) {
+    if (/-alpha(?:[.-]|$)/i.test(currentVersion)) {
+        return 'alpha';
+    }
+    if (/-beta(?:[.-]|$)/i.test(currentVersion)) {
+        return 'beta';
+    }
+    return 'latest';
+}
+function readCurrentVersion(packageRoot) {
+    const packageJsonPath = path.join(packageRoot, 'package.json');
+    const content = fs.readFileSync(packageJsonPath, 'utf8');
+    const pkg = JSON.parse(content);
+    return String(pkg.version ?? '').trim();
+}
+function detectInstallMethod(packageRoot, globalPrefix) {
+    if (fs.existsSync(path.join(packageRoot, 'src'))
+        && fs.existsSync(path.join(packageRoot, 'tsconfig.json'))) {
+        return 'source';
+    }
+    if (globalPrefix && isSubPath(globalPrefix, packageRoot)) {
+        return 'npm-global';
+    }
+    if (packageRoot.includes(`${path.sep}node_modules${path.sep}`)) {
+        return 'package-local';
+    }
+    return 'unknown';
+}
+async function readGlobalPrefix(commandOutputFn) {
+    try {
+        return (await commandOutputFn('npm', ['prefix', '-g'], {
+            errorName: 'npm prefix',
+        })).trim();
+    }
+    catch {
+        return undefined;
+    }
+}
+async function readDistTags(packageName, commandOutputFn) {
+    const output = await commandOutputFn('npm', ['view', packageName, 'dist-tags', '--json'], {
+        errorName: 'npm view',
+    });
+    const parsed = JSON.parse(output);
+    return parsed ?? {};
+}
+function getUnsupportedSelfUpdateReason(installMethod) {
+    if (installMethod === 'source') {
+        return [
+            'This CLI is running from source in a repository checkout.',
+            'Automatic self-update is only supported for standard global npm installs.',
+            'Upgrade this checkout through your repo workflow instead.',
+        ].join(' ');
+    }
+    if (installMethod === 'package-local') {
+        return [
+            'This CLI is installed from a local project dependency tree.',
+            'Automatic self-update is only supported for standard global npm installs.',
+            'Upgrade the parent project dependency that provides this CLI instead.',
+        ].join(' ');
+    }
+    if (installMethod === 'unknown') {
+        return [
+            'This CLI install could not be recognized as a standard global npm install.',
+            'Automatic self-update is only supported for standard global npm installs.',
+        ].join(' ');
+    }
+    return undefined;
+}
+export function getRecommendedSelfUpdateCommand(status) {
+    if (!status.updatable || !status.updateAvailable) {
+        return undefined;
+    }
+    return 'nb self update --yes';
+}
+export function formatSelfUpdateUnavailableMessage(status) {
+    if (status.registryError) {
+        return [
+            `Couldn't resolve the latest published version for ${status.packageName}.`,
+            'Check your npm registry access and try again.',
+            `Details: ${status.registryError}`,
+        ].join('\n');
+    }
+    return [
+        `Couldn't resolve the latest published version for ${status.packageName}.`,
+        'Check your npm registry access and try again.',
+    ].join('\n');
+}
+export function getSelfUpdatePackageSpec(status) {
+    return `${status.packageName}@${status.channel}`;
+}
+export async function inspectSelfStatus(options = {}) {
+    const packageRoot = options.packageRoot ? normalizePath(options.packageRoot) : PACKAGE_ROOT;
+    const packageName = options.packageName ?? DEFAULT_PACKAGE_NAME;
+    const currentVersion = options.currentVersion ?? readCurrentVersion(packageRoot);
+    const channel = options.channel && options.channel !== 'auto' ? options.channel : detectChannel(currentVersion);
+    const commandOutputFn = options.commandOutputFn ?? commandOutput;
+    const globalPrefix = await readGlobalPrefix(commandOutputFn);
+    const installMethod = detectInstallMethod(packageRoot, globalPrefix);
+    let latestVersion;
+    let registryError;
+    try {
+        const distTags = await readDistTags(packageName, commandOutputFn);
+        latestVersion = distTags[channel] || distTags.latest;
+    }
+    catch (error) {
+        registryError = error instanceof Error ? error.message : String(error);
+    }
+    const updateAvailable = latestVersion ? compareVersions(latestVersion, currentVersion) > 0 : false;
+    return {
+        packageName,
+        packageRoot,
+        currentVersion,
+        channel,
+        latestVersion,
+        updateAvailable,
+        installMethod,
+        updatable: installMethod === 'npm-global',
+        updateBlockedReason: getUnsupportedSelfUpdateReason(installMethod),
+        globalPrefix,
+        registryError,
+    };
+}
+export function formatUnsupportedSelfUpdateMessage(status) {
+    return status.updateBlockedReason
+        ?? [
+            'Automatic self-update is only supported for standard global npm installs.',
+        ].join('\n');
+}
+export async function updateSelf(options = {}) {
+    const status = await inspectSelfStatus(options);
+    if (!status.updatable) {
+        throw new Error(formatUnsupportedSelfUpdateMessage(status));
+    }
+    const targetVersion = options.targetVersion ?? status.latestVersion;
+    if (!targetVersion) {
+        throw new Error(formatSelfUpdateUnavailableMessage(status));
+    }
+    if (!targetVersion || compareVersions(targetVersion, status.currentVersion) <= 0) {
+        return {
+            action: 'noop',
+            status,
+            targetVersion,
+            packageSpec: getSelfUpdatePackageSpec(status),
+        };
+    }
+    const packageSpec = getSelfUpdatePackageSpec(status);
+    await (options.runFn ?? run)('npm', ['install', '-g', packageSpec], {
+        stdio: 'inherit',
+        errorName: 'npm install',
+    });
+    return {
+        action: 'updated',
+        status,
+        targetVersion,
+        packageSpec,
+    };
+}

package/dist/lib/skills-manager.js

@@ -0,0 +1,202 @@
+/**
+ * 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 fs from 'node:fs';
+import fsp from 'node:fs/promises';
+import path from 'node:path';
+import { commandOutput, run } from './run-npm.js';
+export const NOCOBASE_SKILLS_PACKAGE = 'nocobase/skills';
+export const NOCOBASE_SKILLS_REPO_URL = 'https://github.com/nocobase/skills.git';
+const NOCOBASE_SKILLS_NAME_PREFIX = 'nocobase-';
+function normalizePath(value) {
+    return path.resolve(value);
+}
+export function resolveSkillsWorkspaceRoot(startCwd = process.cwd()) {
+    let current = normalizePath(startCwd);
+    while (true) {
+        if (fs.existsSync(path.join(current, '.nocobase')) || fs.existsSync(path.join(current, '.agents'))) {
+            return current;
+        }
+        const parent = path.dirname(current);
+        if (parent === current) {
+            return normalizePath(startCwd);
+        }
+        current = parent;
+    }
+}
+export function getManagedSkillsStateFile(workspaceRoot) {
+    return path.join(workspaceRoot, '.nocobase', 'skills.json');
+}
+async function readManagedSkillsState(workspaceRoot) {
+    const filePath = getManagedSkillsStateFile(workspaceRoot);
+    try {
+        const content = await fsp.readFile(filePath, 'utf8');
+        return JSON.parse(content);
+    }
+    catch {
+        return undefined;
+    }
+}
+async function writeManagedSkillsState(workspaceRoot, state) {
+    const filePath = getManagedSkillsStateFile(workspaceRoot);
+    await fsp.mkdir(path.dirname(filePath), { recursive: true });
+    await fsp.writeFile(filePath, JSON.stringify(state, null, 2));
+}
+export async function listProjectSkills(options = {}) {
+    const workspaceRoot = options.workspaceRoot ? normalizePath(options.workspaceRoot) : resolveSkillsWorkspaceRoot();
+    const output = await (options.commandOutputFn ?? commandOutput)('npx', ['-y', 'skills', 'list', '--json'], {
+        cwd: workspaceRoot,
+        errorName: 'skills list',
+    });
+    const parsed = JSON.parse(output);
+    return Array.isArray(parsed) ? parsed : [];
+}
+function pickInstalledNocoBaseSkillNames(installedSkills, state) {
+    const installedNames = new Set(installedSkills.map((skill) => String(skill.name ?? '').trim()).filter(Boolean));
+    if (state?.skillNames?.length) {
+        return state.skillNames.filter((name) => installedNames.has(name)).sort();
+    }
+    return Array.from(installedNames)
+        .filter((name) => name.startsWith(NOCOBASE_SKILLS_NAME_PREFIX))
+        .sort();
+}
+export async function readNocoBaseSkillsHeadRef(options = {}) {
+    try {
+        const output = await (options.commandOutputFn ?? commandOutput)('git', ['ls-remote', NOCOBASE_SKILLS_REPO_URL, 'HEAD'], {
+            cwd: options.workspaceRoot ? normalizePath(options.workspaceRoot) : resolveSkillsWorkspaceRoot(),
+            errorName: 'git ls-remote',
+        });
+        const ref = output.trim().split(/\s+/)[0];
+        return { ref: ref || undefined };
+    }
+    catch (error) {
+        return {
+            error: error instanceof Error ? error.message : String(error),
+        };
+    }
+}
+export async function inspectSkillsStatus(options = {}) {
+    const workspaceRoot = options.workspaceRoot ? normalizePath(options.workspaceRoot) : resolveSkillsWorkspaceRoot();
+    const stateFile = getManagedSkillsStateFile(workspaceRoot);
+    const [installedSkills, managedState] = await Promise.all([
+        listProjectSkills({
+            workspaceRoot,
+            commandOutputFn: options.commandOutputFn,
+        }),
+        readManagedSkillsState(workspaceRoot),
+    ]);
+    const installedSkillNames = pickInstalledNocoBaseSkillNames(installedSkills, managedState);
+    const managedByNb = managedState?.packageName === NOCOBASE_SKILLS_PACKAGE;
+    let latestRef;
+    let registryError;
+    let updateAvailable = installedSkillNames.length > 0 ? null : false;
+    if (installedSkillNames.length > 0 || managedByNb) {
+        const remote = await readNocoBaseSkillsHeadRef({
+            workspaceRoot,
+            commandOutputFn: options.commandOutputFn,
+        });
+        latestRef = remote.ref;
+        registryError = remote.error;
+        if (managedState?.installedRef && latestRef) {
+            updateAvailable = latestRef !== managedState.installedRef;
+        }
+    }
+    return {
+        workspaceRoot,
+        stateFile,
+        installed: installedSkillNames.length > 0,
+        managedByNb,
+        sourcePackage: NOCOBASE_SKILLS_PACKAGE,
+        installedSkillNames,
+        latestRef,
+        installedRef: managedState?.installedRef,
+        updateAvailable,
+        registryError,
+    };
+}
+function formatSkillsNotInstalledMessage() {
+    return [
+        'NocoBase AI coding skills are not installed for this workspace.',
+        'Run `nb skills install` first.',
+    ].join('\n');
+}
+async function persistManagedSkillsState(workspaceRoot, options = {}) {
+    const installedSkills = await listProjectSkills({
+        workspaceRoot,
+        commandOutputFn: options.commandOutputFn,
+    });
+    const managedState = await readManagedSkillsState(workspaceRoot);
+    const installedSkillNames = pickInstalledNocoBaseSkillNames(installedSkills, managedState);
+    const remote = await readNocoBaseSkillsHeadRef({
+        workspaceRoot,
+        commandOutputFn: options.commandOutputFn,
+    });
+    const now = new Date().toISOString();
+    await writeManagedSkillsState(workspaceRoot, {
+        packageName: NOCOBASE_SKILLS_PACKAGE,
+        repoUrl: NOCOBASE_SKILLS_REPO_URL,
+        installedAt: managedState?.installedAt ?? now,
+        updatedAt: now,
+        installedRef: remote.ref,
+        skillNames: installedSkillNames,
+    });
+    return await inspectSkillsStatus({
+        workspaceRoot,
+        commandOutputFn: options.commandOutputFn,
+    });
+}
+export async function installNocoBaseSkills(options = {}) {
+    const workspaceRoot = options.workspaceRoot ? normalizePath(options.workspaceRoot) : resolveSkillsWorkspaceRoot();
+    const status = await inspectSkillsStatus({
+        workspaceRoot,
+        commandOutputFn: options.commandOutputFn,
+    });
+    if (status.installed) {
+        return {
+            action: 'noop',
+            status,
+        };
+    }
+    await (options.runFn ?? run)('npx', ['-y', 'skills', 'add', NOCOBASE_SKILLS_PACKAGE, '-y'], {
+        cwd: workspaceRoot,
+        stdio: 'inherit',
+        errorName: 'skills add',
+    });
+    return {
+        action: 'installed',
+        status: await persistManagedSkillsState(workspaceRoot, options),
+    };
+}
+export async function updateNocoBaseSkills(options = {}) {
+    const workspaceRoot = options.workspaceRoot ? normalizePath(options.workspaceRoot) : resolveSkillsWorkspaceRoot();
+    const status = await inspectSkillsStatus({
+        workspaceRoot,
+        commandOutputFn: options.commandOutputFn,
+    });
+    if (!status.installed) {
+        throw new Error(formatSkillsNotInstalledMessage());
+    }
+    if (status.managedByNb
+        && status.latestRef
+        && status.installedRef
+        && status.latestRef === status.installedRef) {
+        return {
+            action: 'noop',
+            status,
+        };
+    }
+    await (options.runFn ?? run)('npx', ['-y', 'skills', 'update', '-p', '-y', ...status.installedSkillNames], {
+        cwd: workspaceRoot,
+        stdio: 'inherit',
+        errorName: 'skills update',
+    });
+    return {
+        action: 'updated',
+        status: await persistManagedSkillsState(workspaceRoot, options),
+    };
+}