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

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,
-};

package/src/license.js

@@ -1,76 +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 { resolve } = require('path');
-const fs = require('fs-extra');
-const { keyDecrypt, getEnvAsync } = require('@nocobase/license-kit');
-const { isEnvMatch } = require('@nocobase/plugin-license/utils/env');
-const { logger } = require('./logger');
-const { pick } = require('lodash');
-
-exports.getAccessKeyPair = async function () {
-  const keyFile = resolve(process.cwd(), 'storage/.license/license-key');
-  if (!fs.existsSync(keyFile)) {
-    logger.info('License key not found');
-    return {};
-  }
-  logger.info('License key found');
-  let keyData = {};
-  try {
-    const str = fs.readFileSync(keyFile, 'utf-8');
-    const keyDataStr = keyDecrypt(str);
-    keyData = JSON.parse(keyDataStr);
-  } catch (error) {
-    showLicenseInfo(LicenseKeyError.parseFailed);
-    throw new Error(LicenseKeyError.parseFailed.title);
-  }
-  const env = await getEnvAsync();
-  const isEnvMatched = await isEnvMatch(env, keyData);
-  if (!isEnvMatched) {
-    showLicenseInfo({
-      ...LicenseKeyError.notMatch,
-      env,
-    });
-    throw new Error(LicenseKeyError.notMatch.title);
-  }
-  const { accessKeyId, accessKeySecret } = keyData;
-  return { accessKeyId, accessKeySecret };
-};
-
-const LicenseKeyError = {
-  notExist: {
-    title: 'License key not found',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then generate the license key on the service platform.',
-  },
-  parseFailed: {
-    title: 'Invalid license key format',
-    content: 'Please check your license key, or regenerate the license key on the service platform.',
-  },
-  notMatch: {
-    title: 'License key not match current environment',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
-  },
-  notValid: {
-    title: 'Invalid license key',
-    content:
-      'Please go to the license settings page to obtain the Instance ID for the current environment, and then regenerate the license key on the service platform.',
-  },
-};
-
-exports.LicenseKeyError = LicenseKeyError;
-
-function showLicenseInfo({ title, content, env }) {
-  logger.error(title + '. ' + content);
-  logger.error('Current environment', pick(env, ['sys', 'osVer', 'db']));
-}
-
-exports.showLicenseInfo = showLicenseInfo;

package/src/logger.js

@@ -1,75 +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 fs = require('fs');
-const path = require('path');
-const winston = require('winston');
-require('winston-daily-rotate-file');
-
-function ensureDir(dir) {
-  if (!fs.existsSync(dir)) {
-    fs.mkdirSync(dir, { recursive: true });
-  }
-}
-
-function createSystemLogger({ dirname, filename, defaultMeta = {} }) {
-  ensureDir(dirname);
-
-  const commonFormat = winston.format.combine(
-    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
-    winston.format.printf((info) => {
-      const meta = info.meta ? JSON.stringify(info.meta) : '';
-      return `${info.timestamp} [${info.level}] ${info.message} ${meta}`;
-    }),
-  );
-
-  const consoleFormat = winston.format.combine(winston.format.colorize(), commonFormat);
-
-  const fileTransport = new winston.transports.DailyRotateFile({
-    dirname,
-    filename: `${filename}_%DATE%.log`,
-    datePattern: 'YYYY-MM-DD',
-    zippedArchive: false,
-    format: commonFormat,
-  });
-
-  const consoleTransport = new winston.transports.Console({
-    format: consoleFormat,
-  });
-
-  const logger = winston.createLogger({
-    level: 'info',
-    transports: [consoleTransport, fileTransport],
-    defaultMeta,
-  });
-
-  const wrap = (level) => (message, meta) => {
-    logger.log({ level, message, meta });
-    return logger;
-  };
-
-  return {
-    info: wrap('info'),
-    warn: wrap('warn'),
-    error: wrap('error'),
-  };
-}
-
-const getLoggerFilePath = (...paths) => {
-  return path.resolve(process.env.LOGGER_BASE_PATH || path.resolve(process.cwd(), 'storage', 'logs'), ...paths);
-};
-
-const logger = createSystemLogger({
-  dirname: getLoggerFilePath('main'),
-  filename: 'system',
-});
-
-module.exports = {
-  logger,
-};

package/src/plugin-generator.js

@@ -1,80 +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 { existsSync } = require('fs');
-const { join, resolve } = require('path');
-const { Generator } = require('@umijs/utils');
-const { readFile, writeFile } = require('fs').promises;
-const { genTsConfigPaths } = require('./util');
-
-const execa = require('execa');
-
-function camelize(str) {
-  return str.trim().replace(/[-_\s]+(.)?/g, (match, c) => c.toUpperCase());
-}
-
-function capitalize(string) {
-  return string.charAt(0).toUpperCase() + string.slice(1);
-}
-
-async function getProjectName() {
-  const content = await readFile(resolve(process.cwd(), 'package.json'), 'utf-8');
-  const json = JSON.parse(content);
-  return json.name;
-}
-
-async function getProjectVersion() {
-  const content = await readFile(resolve(process.cwd(), 'lerna.json'), 'utf-8');
-  const json = JSON.parse(content);
-  return json.version || '0.1.0';
-}
-
-class PluginGenerator extends Generator {
-  constructor(options) {
-    const { log, context = {}, ...opts } = options;
-    super(opts);
-    this.context = context;
-    this.log = log || console.log;
-  }
-
-  async getContext() {
-    const { name } = this.context;
-    const nocobaseVersion = require('@nocobase/server/package.json').version;
-    const packageVersion = await getProjectVersion();
-    return {
-      ...this.context,
-      packageName: name,
-      packageVersion,
-      nocobaseVersion,
-      pascalCaseName: capitalize(camelize(name.split('/').pop())),
-    };
-  }
-
-  async writing() {
-    const { name } = this.context;
-    const target = resolve(process.cwd(), 'packages/plugins/', name);
-    if (existsSync(target)) {
-      this.log(chalk.red(`[${name}] plugin already exists.`));
-      return;
-    }
-    this.log('Creating plugin');
-    this.copyDirectory({
-      target,
-      context: await this.getContext(),
-      path: join(__dirname, '../templates/plugin'),
-    });
-    this.log('');
-    genTsConfigPaths();
-    execa.sync('yarn', ['postinstall'], { shell: true, stdio: 'inherit' });
-    this.log(`The plugin folder is in ${chalk.green(`packages/plugins/${name}`)}`);
-  }
-}
-
-exports.PluginGenerator = PluginGenerator;