@nocobase/cli 2.1.0-alpha.15 → 2.1.0-alpha.17

package/src/commands/postinstall.js

@@ -1,88 +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.
- */
-
-const { Command } = require('commander');
-const { run, isDev, isPackageValid, generatePlaywrightPath, generatePlugins } = require('../util');
-const { dirname, resolve } = require('path');
-const { existsSync, mkdirSync, readFileSync, appendFileSync } = require('fs');
-const { readFile, writeFile } = require('fs').promises;
-const { createStoragePluginsSymlink, createDevPluginsSymlink } = require('@nocobase/utils/plugin-symlink');
-
-function runPatchPackage() {
-  // run yarn patch-package
-  // console.log('patching third party packages...');
-  run('yarn', ['patch-package'], {
-    stdio: 'pipe',
-  });
-}
-
-function writeToExclude() {
-  const excludePath = resolve(process.cwd(), '.git', 'info', 'exclude');
-  const content = 'packages/pro-plugins/\n';
-  const dirPath = dirname(excludePath);
-
-  if (!existsSync(dirPath)) {
-    try {
-      mkdirSync(dirPath, { recursive: true });
-    } catch (e) {
-      console.log(`${e.message}, ignore write to git exclude`);
-      return;
-    }
-  }
-
-  let fileContent = '';
-  if (existsSync(excludePath)) {
-    fileContent = readFileSync(excludePath, 'utf-8');
-  }
-  if (!fileContent.includes(content)) {
-    appendFileSync(excludePath, content);
-  }
-}
-
-/**
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT } = process.env;
-  cli
-    .command('postinstall')
-    .allowUnknownOption()
-    .option('--skip-umi')
-    .action(async (options) => {
-      runPatchPackage();
-      writeToExclude();
-      generatePlugins();
-      generatePlaywrightPath(true);
-      await createStoragePluginsSymlink();
-      if (!isDev()) {
-        return;
-      }
-      await createDevPluginsSymlink();
-      const cwd = process.cwd();
-      if (!existsSync(resolve(cwd, '.env')) && existsSync(resolve(cwd, '.env.example'))) {
-        const content = await readFile(resolve(cwd, '.env.example'), 'utf-8');
-        await writeFile(resolve(cwd, '.env'), content, 'utf-8');
-      }
-      if (!existsSync(resolve(cwd, '.env.test')) && existsSync(resolve(cwd, '.env.test.example'))) {
-        const content = await readFile(resolve(cwd, '.env.test.example'), 'utf-8');
-        await writeFile(resolve(cwd, '.env.test'), content, 'utf-8');
-      }
-      if (!isPackageValid('umi')) {
-        return;
-      }
-      if (!options.skipUmi) {
-        run('umi', ['generate', 'tmp'], {
-          stdio: 'pipe',
-          env: {
-            APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
-          },
-        });
-      }
-    });
-};

package/src/commands/start.js

@@ -1,148 +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.
- */
-const _ = require('lodash');
-const { Command } = require('commander');
-const { run, postCheck, downloadPro, promptForTs, checkDBDialect } = require('../util');
-const { existsSync, rmSync } = require('fs');
-const { resolve, isAbsolute } = require('path');
-const chalk = require('chalk');
-const chokidar = require('chokidar');
-
-function getSocketPath() {
-  const { SOCKET_PATH } = process.env;
-
-  if (isAbsolute(SOCKET_PATH)) {
-    return SOCKET_PATH;
-  }
-
-  return resolve(process.cwd(), SOCKET_PATH);
-}
-
-function deleteSockFiles() {
-  const { PM2_HOME } = process.env;
-  if (existsSync(PM2_HOME)) {
-    rmSync(PM2_HOME, { recursive: true });
-  }
-  const socketPath = getSocketPath();
-  if (existsSync(socketPath)) {
-    rmSync(socketPath);
-  }
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT, NODE_ARGS } = process.env;
-  cli
-    .command('start')
-    .option('-p, --port [port]')
-    .option('-d, --daemon')
-    .option('-i, --instances [instances]')
-    .option('--db-sync')
-    .option('--quickstart')
-    .option('--launch-mode [launchMode]')
-    .allowUnknownOption()
-    .action(async (opts) => {
-      checkDBDialect();
-      if (opts.quickstart) {
-        await downloadPro();
-      }
-
-      if (process.env.NO_WATCH_PLUGINS === true || process.env.NO_WATCH_PLUGINS === 'true') {
-        const restart = _.debounce(async () => {
-          console.log('restarting...');
-          await run('yarn', ['nocobase', 'pm2-restart']);
-        }, 500);
-
-        const watcher = chokidar.watch('./storage/plugins/**/*', {
-          cwd: process.cwd(),
-          ignoreInitial: true,
-          ignored: /(^|[\/\\])\../, // 忽略隐藏文件
-          persistent: true,
-          depth: 1, // 只监听第一层目录
-        });
-
-        watcher
-          .on('ready', () => {
-            isReady = true;
-          })
-          .on('addDir', async (pathname) => {
-            if (!isReady) return;
-            restart();
-          })
-          .on('unlinkDir', async (pathname) => {
-            if (!isReady) return;
-            restart();
-          });
-      }
-
-      if (opts.port) {
-        process.env.APP_PORT = opts.port;
-      }
-      if (process.argv.includes('-h') || process.argv.includes('--help')) {
-        promptForTs();
-        run('ts-node', [
-          '-P',
-          process.env.SERVER_TSCONFIG_PATH,
-          '-r',
-          'tsconfig-paths/register',
-          `${APP_PACKAGE_ROOT}/src/index.ts`,
-          ...process.argv.slice(2),
-        ]);
-        return;
-      }
-      if (!existsSync(resolve(process.cwd(), `${APP_PACKAGE_ROOT}/lib/index.js`))) {
-        console.log('The code is not compiled, please execute it first');
-        console.log(chalk.yellow('$ yarn build'));
-        console.log('If you want to run in development mode, please execute');
-        console.log(chalk.yellow('$ yarn dev'));
-        return;
-      }
-      await postCheck(opts);
-      if (!opts.daemon) {
-        deleteSockFiles();
-      }
-      const instances = opts.instances || process.env.CLUSTER_MODE;
-      const instancesArgs = instances ? ['-i', instances] : [];
-      if (opts.daemon) {
-        await run('pm2', [
-          'start',
-          ...instancesArgs,
-          `${APP_PACKAGE_ROOT}/lib/index.js`,
-          '--',
-          ...process.argv.slice(2),
-        ]);
-        process.exit();
-      } else {
-        const launchMode = opts.launchMode || process.env.APP_LAUNCH_MODE || 'pm2';
-        if (launchMode === 'pm2') {
-          run(
-            'pm2-runtime',
-            [
-              'start',
-              ...instancesArgs,
-              `${APP_PACKAGE_ROOT}/lib/index.js`,
-              NODE_ARGS ? `--node-args="${NODE_ARGS}"` : undefined,
-              '--',
-              ...process.argv.slice(2),
-            ].filter(Boolean),
-          );
-        } else {
-          run(
-            'node',
-            [`${APP_PACKAGE_ROOT}/lib/index.js`, ...(NODE_ARGS || '').split(' '), ...process.argv.slice(2)].filter(
-              Boolean,
-            ),
-          );
-        }
-      }
-    });
-};

package/src/commands/tar.js

@@ -1,36 +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.
- */
-
-const { resolve } = require('path');
-const { Command } = require('commander');
-const { run, nodeCheck, isPackageValid } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('tar')
-    .allowUnknownOption()
-    .argument('[packages...]')
-    .option('-v, --version', 'print version')
-    .option('-c, --compile', 'compile the @nocobase/build package')
-    .option('-w, --watch', 'watch compile the @nocobase/build package')
-    .action(async (pkgs, options) => {
-      nodeCheck();
-      if (options.compile || options.watch || isPackageValid('@nocobase/build/src/index.ts')) {
-        await run('yarn', ['build', options.watch ? '--watch' : ''], {
-          cwd: resolve(process.cwd(), 'packages/core/build'),
-        });
-        if (options.watch) return;
-      }
-      await run('nocobase-build', [...pkgs, '--only-tar', options.version ? '--version' : '']);
-    });
-};

package/src/commands/test-coverage.js

@@ -1,55 +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.
- */
-
-const { run, checkDBDialect } = require('../util');
-const fg = require('fast-glob');
-
-const coreClientPackages = ['packages/core/client', 'packages/core/sdk'];
-const isCore = (dir) => dir.startsWith('packages/core');
-
-const getPackagesDir = (isClient) => {
-  if (process.argv.length > 3 && !process.argv[3].startsWith('-')) {
-    return [process.argv[3]];
-  }
-
-  const allPackageJson = fg.sync(['packages/*/*/package.json', 'packages/*/*/*/package.json'], {
-    cwd: process.cwd(),
-    onlyFiles: true,
-  });
-  const res = allPackageJson.map((pkg) => pkg.replace('/package.json', ''));
-  return isClient
-    ? res.filter((dir) => (isCore(dir) ? coreClientPackages.includes(dir) : true))
-    : res.filter((dir) => (isCore(dir) ? !coreClientPackages.includes(dir) : true));
-};
-
-module.exports = (cli) => {
-  cli.command('test-coverage:server').action(async () => {
-    checkDBDialect();
-    const packageRoots = getPackagesDir(false);
-    for (const dir of packageRoots) {
-      try {
-        await run('yarn', ['test:server', dir, '--coverage']);
-      } catch (e) {
-        continue;
-      }
-    }
-  });
-
-  cli.command('test-coverage:client').action(async () => {
-    checkDBDialect();
-    const packageRoots = getPackagesDir(true);
-    for (const dir of packageRoots) {
-      try {
-        await run('yarn', ['test:client', dir, '--coverage']);
-      } catch (e) {
-        continue;
-      }
-    }
-  });
-};

package/src/commands/test.js

@@ -1,107 +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.
- */
-
-const { Command } = require('commander');
-const { run, checkDBDialect } = require('../util');
-const path = require('path');
-
-/**
- *
- * @param {String} name
- * @param {Command} cli
- */
-function addTestCommand(name, cli) {
-  return cli
-    .command(name)
-    .option('-w, --watch')
-    .option('--run')
-    .option('--allowOnly')
-    .option('--bail')
-    .option('--coverage')
-    .option('-h, --help')
-    .option('--single-thread [singleThread]')
-    .arguments('[paths...]')
-    .allowUnknownOption()
-    .action(async (paths, opts) => {
-      checkDBDialect();
-      if (name === 'test:server') {
-        process.env.TEST_ENV = 'server-side';
-      } else if (name === 'test:client') {
-        process.env.TEST_ENV = 'client-side';
-      }
-      if (opts.server) {
-        process.env.TEST_ENV = 'server-side';
-        process.argv.splice(process.argv.indexOf('--server'), 1);
-      }
-
-      if (opts.client) {
-        process.env.TEST_ENV = 'client-side';
-        process.argv.splice(process.argv.indexOf('--client'), 1);
-      }
-
-      process.env.NODE_ENV = 'test';
-
-      if (!opts.watch && !opts.run) {
-        process.argv.push('--run');
-      }
-
-      const first = paths?.[0];
-      if (!process.env.TEST_ENV && first) {
-        const key = first.split(path.sep).join('/');
-        if (key.includes('/client/') || key.includes('/client-v2/') || key.includes('/flow-engine/')) {
-          process.env.TEST_ENV = 'client-side';
-        } else {
-          process.env.TEST_ENV = 'server-side';
-        }
-      }
-
-      if (process.env.TEST_ENV === 'server-side' && opts.singleThread !== 'false') {
-        process.argv.push('--poolOptions.threads.singleThread=true');
-      }
-
-      if (opts.singleThread === 'false') {
-        process.argv.splice(process.argv.indexOf('--single-thread=false'), 1);
-      }
-
-      const cliArgs = ['--max_old_space_size=14096', './node_modules/vitest/vitest.mjs', ...process.argv.slice(3)];
-
-      if (process.argv.includes('-h') || process.argv.includes('--help')) {
-        await run('node', cliArgs);
-        return;
-      }
-
-      if (process.env.TEST_ENV) {
-        console.log('process.env.TEST_ENV', process.env.TEST_ENV, cliArgs);
-        await run('node', cliArgs);
-      } else {
-        await Promise.all([
-          run('node', cliArgs, {
-            env: {
-              TEST_ENV: 'client-side',
-            },
-          }),
-          run('node', cliArgs, {
-            env: {
-              TEST_ENV: 'server-side',
-            },
-          }),
-        ]);
-      }
-    });
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  addTestCommand('test:server', cli);
-  addTestCommand('test:client', cli);
-  addTestCommand('test', cli).option('--client').option('--server');
-};

package/src/commands/umi.js

@@ -1,33 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { run, isDev } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT } = process.env;
-  cli
-    .command('umi')
-    .allowUnknownOption()
-    .action(() => {
-      if (!isDev()) {
-        return;
-      }
-      run('umi', process.argv.slice(3), {
-        env: {
-          APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
-        },
-      });
-    });
-};

package/src/commands/update-deps.js

@@ -1,72 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { resolve } = require('path');
-const { run, promptForTs, runAppCommand, hasCorePackages, downloadPro, hasTsNode, checkDBDialect } = require('../util');
-const { existsSync, rmSync } = require('fs');
-const { readJSON, writeJSON } = require('fs-extra');
-const deepmerge = require('deepmerge');
-
-const rmAppDir = () => {
-  // If ts-node is not installed, do not do the following
-  const appDevDir = resolve(process.cwd(), './storage/.app-dev');
-  if (existsSync(appDevDir)) {
-    rmSync(appDevDir, { recursive: true, force: true });
-  }
-};
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('update-deps')
-    .option('--force')
-    .allowUnknownOption()
-    .action(async (options) => {
-      if (hasCorePackages() || !hasTsNode()) {
-        await downloadPro();
-        return;
-      }
-      const pkg = require('../../package.json');
-      let distTag = 'latest';
-      if (pkg.version.includes('alpha')) {
-        distTag = 'alpha';
-      } else if (pkg.version.includes('beta')) {
-        distTag = 'beta';
-      }
-      const { stdout } = await run('npm', ['info', `@nocobase/cli@${distTag}`, 'version'], {
-        stdio: 'pipe',
-      });
-      if (!options.force && pkg.version === stdout) {
-        await downloadPro();
-        rmAppDir();
-        return;
-      }
-      const descPath = resolve(process.cwd(), 'package.json');
-      const descJson = await readJSON(descPath, 'utf8');
-      const sourcePath = resolve(__dirname, '../../templates/create-app-package.json');
-      const sourceJson = await readJSON(sourcePath, 'utf8');
-      if (descJson['dependencies']?.['@nocobase/cli']) {
-        descJson['dependencies']['@nocobase/cli'] = stdout;
-      }
-      if (descJson['devDependencies']?.['@nocobase/devtools']) {
-        descJson['devDependencies']['@nocobase/devtools'] = stdout;
-      }
-      descJson['resolutions'] = sourceJson['resolutions'];
-      const json = deepmerge(descJson, sourceJson);
-      await writeJSON(descPath, json, { spaces: 2, encoding: 'utf8' });
-      await run('yarn', ['install']);
-      await downloadPro();
-      rmAppDir();
-    });
-};

package/src/commands/upgrade.js

@@ -1,47 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { resolve } = require('path');
-const { run, promptForTs, runAppCommand, hasCorePackages, downloadPro, hasTsNode, checkDBDialect } = require('../util');
-const { existsSync, rmSync } = require('fs');
-const { readJSON, writeJSON } = require('fs-extra');
-const deepmerge = require('deepmerge');
-
-async function updatePackage() {
-  const sourcePath = resolve(__dirname, '../../templates/create-app-package.json');
-  const descPath = resolve(process.cwd(), 'package.json');
-  const sourceJson = await readJSON(sourcePath, 'utf8');
-  const descJson = await readJSON(descPath, 'utf8');
-  const json = deepmerge(descJson, sourceJson);
-  await writeJSON(descPath, json, { spaces: 2, encoding: 'utf8' });
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('upgrade')
-    .allowUnknownOption()
-    .option('--raw')
-    .option('--next')
-    .option('-S|--skip-code-update')
-    .action(async (options) => {
-      checkDBDialect();
-      if (options.skipCodeUpdate) {
-        await runAppCommand('upgrade');
-      } else {
-        await run('nocobase', ['update-deps']);
-        await run('nocobase', ['upgrade', '--skip-code-update']);
-      }
-    });
-};

package/src/commands/view-license-key.js

@@ -1,44 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { keyDecrypt } = require('@nocobase/license-kit');
-const path = require('path');
-const fs = require('fs');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('view-license-key')
-    .description('View License Key')
-    .action(async (options) => {
-      const dir = path.resolve(process.cwd(), 'storage/.license');
-      const filePath = path.resolve(dir, 'license-key');
-      if (!fs.existsSync(filePath)) {
-        console.log('License key not found at ' + filePath);
-        return;
-      }
-      const key = fs.readFileSync(filePath, 'utf-8');
-      let keyDataStr;
-      try {
-        keyDataStr = keyDecrypt(key);
-      } catch (e) {
-        console.log('License key decrypt failed', e);
-        return;
-      }
-      const keyData = JSON.parse(keyDataStr);
-      const { accessKeyId, accessKeySecret } = keyData;
-      console.log(chalk.greenBright(`Access Key ID: ${accessKeyId}`));
-      console.log(chalk.greenBright(`Access Key Secret: ${accessKeySecret}`));
-    });
-};

package/src/index.js

@@ -1,14 +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.
- */
-
-const util = require('./util');
-
-module.exports = {
-  ...util,
-};