编程语言

• Node.js

快速开始

创建项目

npm create cle-plugins hello

这条命令会在当前目录下创建一个 cle-plugin-hello 目录。进入项目目录并安装开发需要的依赖包。

cd cle-plugin-hello
npm i

编译及打包

npm run build
npm run pack

执行上述命令后，会生成一个 cle-plugin-hello-3.0.0.cp 文件。

安装插件

cle plugins i release/cle-plugin-hello-3.0.0.cp

执行测试命令

cle plugins test cle-plugin-hello

项目结构

.
├── src
│   ├── lib
│   ├── config.ts
│   ├── i18n.ts
│   ├── index.ts
│   └── status.ts
├── doc.md
├── package.json
├── tsconfig.json
└── webpack.config.js

index.ts

插件入口。需要导出 init，test，config，i18n, status 5 个属性。可选导出 initHttp, docs 属性。

|属性|类型|说明| |---|---|---| |init|function|初始化函数。CLE 运行时会调用此函数。| |test|function|测试函数。运行 cle plugins test 命令时调用此函数。| |config|object|配置模板。建议只在 config.ts 中修改。| |i18n|object|多语言支持。建议只在 i18n.ts 中修改。| |initHttp|function|初始化函数。CLE 初始化 HTTP 服务时会调用此函数。| |docs|object|文档。建议只在 doc.md 中修改。|

config.ts

配置模板。需要导出 description，fields 2 个属性。

|属性|类型|说明| |---|---|---| |description|string|会在 Dashboard 插件配置页面显示。| |fields|Array|配置属性。|

可以在 init，test 函数中读取配置。例：

export async function test(self: Plugin, utils: Utils) {
  const config = await utils.loadConfig(self);
  console.log(config);
}

i18n.ts

多语言支持。

status.ts

状态显示。