Cloudbase Toolbox

云开发 Node Toolbox，工具合集，仅支持 Node 8.9+ 以上版本。

V2 配置解析器

@cloudbase/toolbox 0.4.0版本起，支持了新的 cloudbaserc 配置文件解析器。

当前配置文件无法满足现阶段的需求（重写配置文件，环境变量支持等），需要对配置文件进行重新设计。

设计目标：

• 具有高扩展性
• 支持模板语法，环境变量
• 支持 CLI 等工具读取、修改文件

新版配置文件 version 为 2.0，只支持 JSON 格式的配置文件，只有 version 声明为 2.0 的配置文件才支持模板变量。

支持字段

version

当期配置文件版本，新版本从 2.0 开始，没有 version 字段的配置文件视为 1.0 版本。

envId

环境 Id

functionRoot

存放函数的根文件夹

functions

云函数配置

engine

模板动态变量

通过模板语法，支持特定的变量，已经用户自定义的环境变量。

模板语法

兼容已存在的项目模板中的语法：

{{variable}}

{
  "envId": "envId",
  "functionRoot": "./functions",
  "functions": []
}

环境变量

通过 .env 文件支持环境变量注入，实现模板中的变量的默认替换。

如 .env 文件中存在以下变量

ENVID=xxx
DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

则可以在配置文件中使用

{
  "envId": "{{env.ENVID}}",
  "functionRoot": "./functions",
  "functions": []
}

兼容性与迁移

向下兼容，当检测到使用的配置文件为 1.0 版本时，给出升级提示。CLI 等工具调用时直接使用新的 ConfigParser 类。

使用方法

使用方法如下：

import { ConfigParser } from '@cloudbase/toolbox'

const configParser = new ConfigParser({
    // 当前工作目录，搜索配置文件，.env 文件，默认为 process.cwd
    cwd: '',
    // 写本地配置时，遇到相同 key 时的处理策略
    cover: false,
    // 直接指定配置文件的路径，否则在 cwd 目录下尝试查找配置文件
    configPath: ''
})

// 获取全部配置文件
await configParser.get()
// 获取 envId
await configParser.get('envId')
// 获取第一个函数的超时时间，如果不存在，则返回默认值 3
await configParser.get('functions[0].timeout', 3)

await configParser.update('functions[0].timeout', 5)

直接使用静态方法

import { ConfigParser } from '@cloudbase/toolbox'

// 获取全部配置文件
await ConfigParser.get()
// 获取 envId
await ConfigParser.get('envId')
// 获取第一个函数的超时时间，如果不存在，则返回默认值 3
await ConfigParser.get('functions[0].timeout', 3)

支持变量

通过 命名空间.变量名 使用，如 {{tcb.envId}}

说明：

• 可以通过 —-env 参数指定需要加载的 .env 文件后缀，如 --env test 加载 .env.test 文件中的变量，默认加载 .env 文件中的变量