🚀 更好的 ClipCC 扩展开发框架,基于 esbuild + TypeScript 。
npm create makeccx@latest
- 安装依赖。
使用 VSCode 打开文件夹,然后新建终端,运行下方命令
npm i
- 构建
ccx文件。
运行下方命令,然后在dist文件夹查看构建结果。
npm run build
- 扩展的源代码在
src文件夹。
构建器配置参数在 makeccx.config.ts 或 makeccx.config.js 文件。
有关配置参数,请参考 makeccx/export.ts 。
-
代码和语言文件无需完整 id 。
-
自带多个
category的友好支持,开箱即用。 -
使用
defineBlock创建积木,TypeScript 会自动识别function的args里面有哪些参数,并在 VSCode 里给予相关提示。
defineBlock({
id: 'abc',
type: type.BlockType.REPORTER,
param: {
a: {
type: type.ParameterType.STRING,
defaultValue: '1',
},
},
function(args, util): any {
return args.a
}
}),- 语言文件支持多层写法,结构更清晰。
{
"name": "ClipCC Extension",
"description": "description",
"hello": {
"": "Hello",
"hello": "Say hello",
"abc": {
"": "abc[a]",
"a": {
"item1": "a",
"item2": "b"
}
}
}
}-
语法略有更改,参考类型文件
src/global.d.ts -
结果不包含整个
assets文件夹,只根据src/info.json的icon属性和inset_icon属性,添加对应的文件。 -
结果自动包含 LICENSE 文件(如果有)。
-
自带
.github/workflows/main.yml文件,构建结果可以直接在Actions里下载。
如果想了解更多不同的地方,请看代码。
- 安装依赖
pnpm i makeccx --save-dev
- 修改
package.json的scripts字段
"scripts": {
"build": "tsc && makeccx build"
},- 删除
makeccx.config.ts文件,或重写为以下格式
import { defineConfig } from 'makeccx'
export default defineConfig({
})- (可选)删除
makeccx文件夹。
源代码在 makeccx 文件夹,而不是 src 文件夹。
git clone https://github.com/makeccx/makeccx
cd makeccx
npm i
npm run build
git clone https://github.com/makeccx/create-makeccx
cd create-makeccx
npm i
npm run build
本项目的 src 文件夹内容略有更改,ClipCC 官方文档仅供参考,请以实际情况为准。
本项目并非 ClipCC 官方项目,作者不属于 Clip Team 。