@nocobase/cli 2.1.0-alpha.19 → 2.1.0-alpha.20

package/dist/lib/run-npm.js

@@ -7,68 +7,53 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { spawn } from 'node:child_process';
-export function run(name, args, cwd, options) {
+import path from 'node:path';
+export function run(name, args, options) {
+    let cwd = options?.cwd ?? process.cwd();
+    if (!path.isAbsolute(cwd)) {
+        cwd = path.resolve(process.cwd(), cwd);
+    }
+    const label = options?.errorName ?? name;
     return new Promise((resolve, reject) => {
         const child = spawn(name, [...args], {
             stdio: 'inherit',
             shell: true,
             cwd,
             env: {
-                ...options?.env,
                 ...process.env,
+                ...options?.env,
             },
         });
         child.once('error', reject);
-        child.once('close', (code) => {
-            if (code === 0) {
-                resolve();
-                return;
-            }
-            reject(new Error(`${name} exited with code ${code}`));
-        });
-    });
-}
-/** Run `npm` with the given argument list in `cwd`, inheriting stdio. */
-export function runNpm(args, cwd) {
-    return new Promise((resolve, reject) => {
-        const child = spawn('yarn', [...args], {
-            stdio: 'inherit',
-            shell: true,
-            cwd,
-            env: process.env,
-        });
-        child.once('error', reject);
         child.once('close', (code, signal) => {
             if (code === 0) {
                 resolve();
                 return;
             }
             if (signal) {
-                reject(new Error(`npm exited due to signal ${signal}`));
+                reject(new Error(`${label} exited due to signal ${signal}`));
                 return;
             }
-            reject(new Error(`npm exited with code ${code}`));
+            reject(new Error(`${label} exited with code ${code}`));
         });
     });
 }
-export async function runNocoBaseCommand(args, cwd, options) {
-    return new Promise((resolve, reject) => {
-        const child = spawn('node', ['./node_modules/.bin/nocobase-v1', ...args], {
-            stdio: 'inherit',
-            shell: true,
-            cwd,
-            env: {
-                ...options?.env,
-                ...process.env,
-            },
-        });
-        child.once('error', reject);
-        child.once('close', (code) => {
-            if (code === 0) {
-                resolve();
-                return;
-            }
-            reject(new Error(`nocobase command exited with code ${code}`));
-        });
+/** Run `yarn` with the given argument list, inheriting stdio (errors label as `npm` for compatibility). */
+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 localBin = path.join(cwd, 'node_modules', '.bin');
+    return run('node', ['./node_modules/.bin/nocobase-v1', ...args], {
+        ...options,
+        errorName: 'nocobase command',
+        env: {
+            PATH: `${localBin}${path.delimiter}${process.env.PATH}`,
+            ...options?.env,
+        },
     });
 }

package/nocobase-ctl.config.json

@@ -1,17 +1,11 @@
 {
   "moduleGroups": [
     {
-      "match": [
-        "workflow*",
-        "@nocobase/plugin-workflow*"
-      ],
+      "match": ["workflow*", "@nocobase/plugin-workflow*"],
       "module": "workflow"
     },
     {
-      "match": [
-        "@nocobase/plugin-data-source-main",
-        "@nocobase/plugin-data-source-manager"
-      ],
+      "match": ["@nocobase/plugin-data-source-main", "@nocobase/plugin-data-source-manager"],
       "module": "data-modeling"
     }
   ],
@@ -21,10 +15,7 @@
       "description": "NocoBase core resource APIs.",
       "include": true,
       "resources": {
-        "includes": [
-          "app",
-          "pm"
-        ],
+        "includes": ["app", "pm"],
         "excludes": [],
         "overrides": {
           "app": {
@@ -45,12 +36,7 @@
       "description": "Based on roles, resources, and actions, access control can precisely manage interface configuration permissions, data operation permissions, menu access permissions, and plugin permissions.",
       "include": true,
       "resources": {
-        "includes": [
-          "availableActions",
-          "dataSources",
-          "roles",
-          "rolesResourcesScopes"
-        ],
+        "includes": ["availableActions", "dataSources", "roles", "rolesResourcesScopes", "desktopRoutes"],
         "excludes": [],
         "overrides": {
           "availableActions": {
@@ -72,6 +58,14 @@
             "name": "roles-resources-scopes",
             "description": "Manage role resource scopes and permissions.",
             "topLevel": false
+          },
+          "desktopRoutes": {
+            "name": "desktop-routes",
+            "description": "Manage desktop route permissions and visibility.",
+            "topLevel": false,
+            "operations": {
+              "includes": ["desktopRoutes:listAccessible"]
+            }
           }
         }
       }
@@ -81,9 +75,7 @@
       "description": "Allow users to access the HTTP API with API keys.",
       "include": true,
       "resources": {
-        "includes": [
-          "apiKeys"
-        ],
+        "includes": ["apiKeys"],
         "excludes": [],
         "overrides": {
           "apiKeys": {
@@ -99,9 +91,7 @@
       "description": "User authentication management, including password auth, SMS auth, SSO protocols, and extensible providers.",
       "include": true,
       "resources": {
-        "includes": [
-          "authenticators"
-        ],
+        "includes": ["authenticators"],
         "excludes": [],
         "overrides": {
           "auth": {
@@ -122,21 +112,16 @@
       "description": "Provide the web client interface for the NocoBase server.",
       "include": true,
       "resources": {
-        "includes": [
-          "desktopRoutes",
-          "roles"
-        ],
+        "includes": ["desktopRoutes"],
         "excludes": [],
         "overrides": {
           "desktopRoutes": {
             "name": "desktop-routes",
             "description": "Manage desktop route permissions and visibility.",
-            "topLevel": true
-          },
-          "roles": {
-            "name": "roles",
-            "description": "Manage client permissions scoped by role.",
-            "topLevel": false
+            "topLevel": true,
+            "operations": {
+              "excludes": ["desktopRoutes:listAccessible"]
+            }
           }
         }
       }
@@ -146,11 +131,7 @@
       "description": "Manage data sources, collections, and database modeling resources.",
       "include": true,
       "resources": {
-        "includes": [
-          "collections",
-          "fields",
-          "dbViews"
-        ],
+        "includes": ["collections", "fields", "dbViews"],
         "excludes": [],
         "overrides": {
           "collections": {
@@ -172,9 +153,7 @@
             "description": "Manage fields with the compact high-level modeling interface.",
             "topLevel": false,
             "operations": {
-              "includes": [
-                "apply"
-              ]
+              "includes": ["apply"]
             }
           },
           "dbViews": {
@@ -182,10 +161,7 @@
             "description": "Inspect and query database views.",
             "topLevel": false,
             "operations": {
-              "includes": [
-                "dbViews:list",
-                "dbViews:get"
-              ]
+              "includes": ["dbViews:list", "dbViews:get"]
             }
           }
         }
@@ -196,9 +172,7 @@
       "description": "Provide file storage services, file collections, and attachment fields.",
       "include": true,
       "resources": {
-        "includes": [
-          "storages"
-        ],
+        "includes": ["storages"],
         "excludes": [],
         "overrides": {
           "storages": {
@@ -214,9 +188,7 @@
       "description": "Manage flow surface composition, configuration, layout, and mutation APIs.",
       "include": true,
       "resources": {
-        "includes": [
-          "flowSurfaces"
-        ],
+        "includes": ["flowSurfaces"],
         "excludes": [],
         "overrides": {
           "flowSurfaces": {
@@ -232,9 +204,7 @@
       "description": "Map blocks with support for AMap, Google Maps, and extensible providers.",
       "include": true,
       "resources": {
-        "includes": [
-          "map-configuration"
-        ],
+        "includes": ["map-configuration"],
         "excludes": [],
         "overrides": {
           "map-configuration": {
@@ -250,9 +220,7 @@
       "description": "Adjust system title, logo, language, and other global settings.",
       "include": true,
       "resources": {
-        "includes": [
-          "systemSettings"
-        ],
+        "includes": ["systemSettings"],
         "excludes": [],
         "overrides": {
           "systemSettings": {
@@ -268,9 +236,7 @@
       "description": "Customize UI colors and dimensions, save themes, and switch between them.",
       "include": true,
       "resources": {
-        "includes": [
-          "themeConfig"
-        ],
+        "includes": ["themeConfig"],
         "excludes": [],
         "overrides": {
           "themeConfig": {
@@ -286,13 +252,7 @@
       "description": "A powerful BPM tool that provides the foundation for business automation and extensible triggers and nodes.",
       "include": true,
       "resources": {
-        "includes": [
-          "executions",
-          "flow_nodes",
-          "jobs",
-          "userWorkflowTasks",
-          "workflows"
-        ],
+        "includes": ["executions", "flow_nodes", "jobs", "userWorkflowTasks", "workflows"],
         "excludes": [],
         "overrides": {
           "executions": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-alpha.19",
+  "version": "2.1.0-alpha.20",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -28,6 +28,7 @@
     "additionalHelpFlags": [
       "-h"
     ],
+    "helpClass": "./dist/help/runtime-help.js",
     "commands": {
       "strategy": "explicit",
       "target": "./dist/generated/command-registry.js"
@@ -44,20 +45,20 @@
     }
   },
   "dependencies": {
-    "@apidevtools/swagger-parser": "^12.1.0",
+    "@clack/prompts": "^0.9.1",
     "@oclif/core": "^4.10.4",
     "openapi-types": "^12.1.3",
     "ora": "^8.2.0",
-    "picocolors": "^1.1.1",
-    "typescript": "^6.0.2"
+    "picocolors": "^1.1.1"
   },
   "devDependencies": {
     "@types/node": "^18.19.130",
-    "tsx": "^4.20.6"
+    "tsx": "^4.20.6",
+    "typescript": "^6.0.2"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "3d13700360eac1c0f9dbf6a5f167ed396a294a3c"
+  "gitHead": "3d1535db6bf93ca23257faf474afee0d565f54c6"
 }

package/dist/commands/self-update.js

@@ -1,46 +0,0 @@
-/**
- * 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 } from '@oclif/core';
-import { spawn } from 'node:child_process';
-function runNpmInstallGlobal(args) {
-    return new Promise((resolve, reject) => {
-        const child = spawn('npm', ['install', '-g', ...args], {
-            stdio: 'inherit',
-            shell: true,
-            env: process.env,
-        });
-        child.once('error', reject);
-        child.once('close', (code) => {
-            if (code === 0) {
-                resolve();
-                return;
-            }
-            reject(new Error(`npm exited with code ${code}`));
-        });
-    });
-}
-export default class SelfUpdate extends Command {
-    static description = 'Update the NocoBase CLI to the latest version';
-    static examples = ['<%= config.bin %> <%= command.id %>'];
-    async run() {
-        this.log('Updating NocoBase CLI to the latest version...');
-        try {
-            await runNpmInstallGlobal(['@nocobase/cli']);
-            this.log('Update finished.');
-        }
-        catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            this.error([
-                'Failed to update the CLI.',
-                'Try running manually: npm install -g @nocobase/cli',
-                message,
-            ].join('\n'), { exit: 1 });
-        }
-    }
-}