1. refactor: change tcb command to cloudbase

2. optimize: add types defination files

Author: chhpt

README.md

@@ -1,6 +1,6 @@
 # CloudBase 命令行工具 ![npm (tag)](https://img.shields.io/npm/v/@cloudbase/cli)
 
-CloudBase CLI 是一个开源的命令行界面交互工具，用于帮助用户快速、方便的部署项目，管理 TCB 资源。
+CloudBase CLI 是一个开源的命令行界面交互工具，用于帮助用户快速、方便的部署项目，管理云开发资源。
 
 ## 安装 CloudBase CLI
 
@@ -16,7 +16,7 @@ npm install -g @cloudbase/cli
 yarn global add @cloudbase/cli
 ```
 
-安装完成后，你可以使用 `tcb -V` 验证是否安装成功，如果输出了类似下面的版本号，则表明 CloudBase CLI 被成功安装到您的计算机中。
+安装完成后，你可以使用 `cloudbase -V` 验证是否安装成功，如果输出了类似下面的版本号，则表明 CloudBase CLI 被成功安装到您的计算机中。
 
 ```text
 0.1.5

bin/cloudbase.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+const program = require('commander')
+const chalk = require('chalk')
+const logSymbols = require('log-symbols')
+const updateNotifier = require('update-notifier')
+const pkg = require('../package.json')
+
+const isBeta = pkg.version.indexOf('-') > -1
+
+// 检查更新
+const ONE_DAY = 86400000
+// Beta 版 1 个小时检查一次，稳定版 1 天检查一次
+const CheckInterval = isBeta ? 3600000 : ONE_DAY
+
+const notifier = updateNotifier({
+    pkg,
+    distTag: isBeta ? 'beta' : 'latest',
+    // 检查更新间隔 1 天
+    updateCheckInterval: CheckInterval
+})
+
+notifier.notify({
+    isGlobal: true
+})
+
+// 注册命令
+require('../lib')
+
+program.version(pkg.version)
+
+// 处理无效命令
+program.action(cmd => {
+    console.log(chalk.bold.red('Error: ') + `${cmd} 不是有效的命令！`)
+    console.log(`使用 ${chalk.bold('cloudbase -h')} 查看所有命令~`)
+})
+
+program.on('--help', function() {
+    const tips = `\nTips:
+
+${chalk.gray('–')} 登录
+
+  ${chalk.cyan('$ cloudbase login')}
+
+${chalk.gray('–')} 初始化云开发项目
+
+  ${chalk.cyan('$ cloudbase init')}
+
+${chalk.gray('–')} 部署云函数
+
+  ${chalk.cyan('$ cloudbase functions:deploy')}`
+    console.log(tips)
+})
+
+// 当没有输入任何命令时，显示帮助信息
+if (process.argv.length < 3) {
+    program.outputHelp()
+}
+
+program.parse(process.argv)
+
+function errorHandler(err) {
+    const stackIngoreErrors = ['TencentCloudSDKHttpException', 'TcbError']
+    // 忽略自定义错误的错误栈
+    if (err.stack && !stackIngoreErrors.includes(err.name)) {
+        console.log(err.stack)
+    }
+    // 3 空格，兼容中文字符编码长度问题
+    console.log(logSymbols.error + ' ' + err.message)
+}
+
+process.on('uncaughtException', errorHandler)
+process.on('unhandledRejection', errorHandler)

bin/tcb.js

@@ -1,74 +1,4 @@
 #!/usr/bin/env node
-const ora = require('ora')
-const program = require('commander')
-const chalk = require('chalk')
 const logSymbols = require('log-symbols')
-const updateNotifier = require('update-notifier')
-const pkg = require('../package.json')
 
-const isBeta = pkg.version.indexOf('-') > -1
-
-// 检查更新
-const ONE_DAY = 86400000
-// Beta 版 1 个小时检查一次，稳定版 1 天检查一次
-const CheckInterval = isBeta ? 3600000 : ONE_DAY
-
-const notifier = updateNotifier({
-    pkg,
-    distTag: isBeta ? 'beta' : 'latest',
-    // 检查更新间隔 1 天
-    updateCheckInterval: CheckInterval
-})
-
-notifier.notify({
-    isGlobal: true
-})
-
-// 注册命令
-require('../lib')
-
-program.version(pkg.version)
-
-// 处理无效命令
-program.action(cmd => {
-    console.log(chalk.bold.red('Error: ') + `${cmd} 不是有效的命令！`)
-    console.log(`使用 ${chalk.bold('tcb -h')} 查看所有命令~`)
-})
-
-program.on('--help', function() {
-    const tips = `\nTips:
-
-${chalk.gray('–')} 登录
-
-  ${chalk.cyan('$ tcb login')}
-
-${chalk.gray('–')} 列出环境列表
-
-  ${chalk.cyan('$ tcb env:list')}
-
-${chalk.gray('–')} 部署云函数
-
-  ${chalk.cyan('$ tcb functions:deploy')}`
-    console.log(tips)
-})
-
-// 当没有输入任何命令时，显示帮助信息
-if (process.argv.length < 3) {
-    program.outputHelp()
-}
-
-program.parse(process.argv)
-
-function errorHandler(err) {
-    ora().stop()
-    const stackIngoreErrors = ['TencentCloudSDKHttpException', 'TcbError']
-    // 忽略自定义错误的错误栈
-    if (err.stack && !stackIngoreErrors.includes(err.name)) {
-        console.log(err.stack)
-    }
-    // 3 空格，兼容中文字符编码长度问题
-    console.log(logSymbols.error + ' ' + err.message)
-}
-
-process.on('uncaughtException', errorHandler)
-process.on('unhandledRejection', errorHandler)
+console.log(logSymbols.error + ' ' + '[tcb] 命令已废弃，请使用 [cloudbase] 命令！')

lib/commands/env.js

@@ -50,7 +50,7 @@ async function checkEnvAvailability(envId) {
                 retry++;
             }
             if (retry > MAX_TRY) {
-                reject(new error_1.TcbError('环境初始化查询超时，请稍后通过 tcb env:list 查看环境状态'));
+                reject(new error_1.TcbError('环境初始化查询超时，请稍后通过 cloudbase env:list 查看环境状态'));
             }
         }, 1000);
     });

lib/commands/functions.js

@@ -20,7 +20,7 @@ const StatusMap = {
     UpdateFailed: '更新失败'
 };
 async function getConfigFunctions() {
-    const config = await utils_1.resolveTcbrcConfig();
+    const config = await utils_1.resolveCloudBaseConfig();
     if (!config.functions ||
         !Array.isArray(config.functions) ||
         !config.functions.length) {
@@ -49,7 +49,7 @@ commander_1.default
     .description('创建云函数')
     .action(async function (name, envId, options) {
     const assignEnvId = await utils_1.getEnvId(envId);
-    const config = await utils_1.resolveTcbrcConfig();
+    const config = await utils_1.resolveCloudBaseConfig();
     const functions = await getConfigFunctions();
     const { force } = options;
     let isBatchCreating = false;
@@ -123,7 +123,7 @@ commander_1.default
     .description('创建云函数')
     .action(async function (name, envId) {
     const assignEnvId = await utils_1.getEnvId(envId);
-    const config = await utils_1.resolveTcbrcConfig();
+    const config = await utils_1.resolveCloudBaseConfig();
     const functions = await getConfigFunctions();
     if (!name) {
         throw new error_1.TcbError('请指定函数名称！');
@@ -563,7 +563,7 @@ commander_1.default
 commander_1.default
     .command('functions:copy <functionName> <newFunctionName> [envId] [targentEnvId]')
     .option('--force', '如果目标环境下存在同名函数，覆盖原函数')
-    .description('创建云函数')
+    .description('拷贝云函数')
     .action(async function (functionName, newFunctionName, envId, targentEnvId, options) {
     const assignEnvId = await utils_1.getEnvId(envId);
     const { force } = options;

lib/commands/init.js

@@ -18,7 +18,14 @@ commander_1.default
     .description('创建并初始化一个新的项目')
     .action(async function (cmd) {
     const load = ora_1.default('拉取环境列表').start();
-    const envData = (await env_1.listEnvs()) || [];
+    let envData = [];
+    try {
+        envData = (await env_1.listEnvs()) || [];
+    }
+    catch (e) {
+        load.stop();
+        throw e;
+    }
     load.succeed('获取环境列表成功');
     const envs = envData.map(item => `${item.EnvId}:${item.PackageName}`);
     if (!envs.length) {
@@ -34,7 +41,7 @@ commander_1.default
         type: 'input',
         name: 'name',
         message: '请输入项目名称',
-        default: 'tcb-demo'
+        default: 'cloudbase-demo'
     });
     const templatePath = path_1.default.resolve(__dirname, '../../templates', cmd.server ? 'server/node' : 'faas');
     const projectPath = path_1.default.join(process.cwd(), name);
@@ -54,7 +61,9 @@ commander_1.default
     }
     fs_extra_1.default.copySync(templatePath, projectPath);
     fs_1.default.renameSync(path_1.default.join(projectPath, '_gitignore'), path_1.default.join(projectPath, '.gitignore'));
-    const configFilePath = path_1.default.join(projectPath, 'tcbrc.json');
+    const configFileJSONPath = path_1.default.join(projectPath, 'cloudbaserc.json');
+    const configFileJSPath = path_1.default.join(projectPath, 'cloudbaserc.js');
+    const configFilePath = [configFileJSPath, configFileJSONPath].find(item => fs_1.default.existsSync(item));
     const configContent = fs_1.default.readFileSync(configFilePath).toString();
     fs_1.default.writeFileSync(configFilePath, configContent.replace('{{envId}}', env.split(':')[0]));
     logger_1.successLog(`创建项目 ${name} 成功`);

lib/commands/login.js

@@ -85,12 +85,12 @@ commander_1.default
     try {
         const envs = await env_1.listEnvs();
         if (!envs.length) {
-            logger_1.warnLog('你还没有可用的环境，请使用 tcb env:create alias 创建环境');
+            logger_1.warnLog('你还没有可用的环境，请使用 cloudbase env:create alias 创建环境');
         }
     }
     catch (e) {
         if (e.code === 'ResourceNotFound.UserNotExists') {
-            const initSpin = ora_1.default('初始化 TCB 服务').start();
+            const initSpin = ora_1.default('初始化云开发服务').start();
             await env_1.initTcb(skey);
             initSpin.succeed('初始化成功！');
         }

lib/commands/server.js

@@ -27,7 +27,7 @@ function checkServers(servers) {
     });
 }
 async function getServers(name) {
-    const config = await utils_1.resolveTcbrcConfig();
+    const config = await utils_1.resolveCloudBaseConfig();
     if (!config.servers || !Array.isArray(config.servers)) {
         throw new Error('服务配置错误');
     }

lib/function/_packer.js

@@ -27,7 +27,7 @@ class FunctionPacker {
     }
     async getFileCode() {
         this.validPath(this.funcPath);
-        this.tmpPath = path_1.default.join(this.root, '.tcb_tmp');
+        this.tmpPath = path_1.default.join(this.root, '.cloudbase_tmp');
         this.funcDistPath = path_1.default.join(this.tmpPath, this.name);
         this.clean();
         await make_dir_1.default(this.funcDistPath);

lib/utils/index.js

@@ -90,7 +90,7 @@ async function getCredential() {
             };
         }
     }
-    throw new error_1.TcbError('无有效身份信息，请使用 tcb login 登录');
+    throw new error_1.TcbError('无有效身份信息，请使用 cloudbase login 登录');
 }
 exports.getCredential = getCredential;
 function getSSHConfig() {
@@ -121,25 +121,31 @@ async function getSSH() {
     return sshConfig;
 }
 exports.getSSH = getSSH;
-function getTcbConfig() {
+function getCloudBaseConfig() {
     return configstore_1.configStore.all();
 }
-exports.getTcbConfig = getTcbConfig;
-async function resolveTcbrcConfig() {
+exports.getCloudBaseConfig = getCloudBaseConfig;
+async function resolveCloudBaseConfig() {
     const tcbrcPath = path_1.default.join(process.cwd(), 'tcbrc.json');
-    if (!fs_1.default.existsSync(tcbrcPath)) {
+    if (fs_1.default.existsSync(tcbrcPath)) {
+        throw new error_1.TcbError('tcrbrc.josn 配置文件已废弃，请使用 cloudbaserc.json 或 cloudbaserc.js 配置文件！');
+    }
+    const cloudbaseJSONPath = path_1.default.join(process.cwd(), 'cloudbaserc.json');
+    const cloudbaseJSPath = path_1.default.join(process.cwd(), 'cloudbaserc.js');
+    const cloudbasePath = [cloudbaseJSPath, cloudbaseJSONPath].find(item => fs_1.default.existsSync(item));
+    if (!cloudbasePath || !fs_1.default.existsSync(cloudbasePath)) {
         return {};
     }
-    const tcbrc = await Promise.resolve().then(() => __importStar(require(tcbrcPath)));
-    if (!tcbrc.envId) {
+    const cloudbaseConfig = await Promise.resolve().then(() => __importStar(require(cloudbasePath)));
+    if (!cloudbaseConfig.envId) {
         throw new error_1.TcbError('配置文件无效，配置文件必须包含含环境 Id');
     }
-    return tcbrc;
+    return cloudbaseConfig;
 }
-exports.resolveTcbrcConfig = resolveTcbrcConfig;
+exports.resolveCloudBaseConfig = resolveCloudBaseConfig;
 async function getEnvId(envId) {
-    const tcbrc = await resolveTcbrcConfig();
-    const assignEnvId = envId || tcbrc.envId;
+    const cloudbaseConfig = await resolveCloudBaseConfig();
+    const assignEnvId = envId || cloudbaseConfig.envId;
     if (!assignEnvId) {
         throw new error_1.TcbError('未识别到有效的环境 Id 变量，请在项目根目录进行操作或通过 envId 参数指定环境 Id');
     }