Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🚀 更好的 ClipCC 扩展开发框架,基于 esbuild + TypeScript 。

License

makeccx/makeccx

 
 

Repository files navigation

makeccx

🚀 更好的 ClipCC 扩展开发框架,基于 esbuild + TypeScript

开始

  1. 确认您正在访问 https://github.com/bddjr/makeccx ,而不是别人的扩展仓库。

  2. 确保电脑已安装以下软件

    Git
    Node.js
    pnpm
    VSCode

  3. 点击右上角的绿色 Use this template 按钮,
    然后点击 Create a new repository 创建仓库。

    请按照规范命名仓库,例如 clipcc-extension-example

  4. 使用 git clone 命令,将仓库下载到本地。

git clone <此处填写仓库的网址>
  1. 使用 VSCode 打开文件夹。
    请安装扩展 JavaScript and TypeScript Nightly ,确保正常使用 TypeScript 。

  2. 请按照规范更改 src/info.json 文件。

  3. 在 VSCode 里新建终端,然后运行以下命令安装依赖。

pnpm i
  1. 运行以下命令构建 ccx 文件,结果在 dist 文件夹。
pnpm build
  1. README.md 清空。
    您可以使用以下格式重写 README.md
# Example
简单介绍一下扩展。  

## 下载并构建扩展
```
git clone <此处填写仓库的网址>
cd <此处填写文件夹名称>
pnpm i
pnpm build
```
  1. 使用 Git 提交并推送。
    您可以使用 VSCode 左侧的 “源代码管理” 完成操作,也可以手动运行以下命令
git add .
git commit -m "此处填写commit的标题"
git push

配置

构建器配置参数在 makeccx.config.ts 文件。

请按照指定的类型修改选项,不得删除任何一项。


有何不同

  • 代码和语言文件无需完整 id 。

  • 自带多个 category 的友好支持,开箱即用。

  • 使用 defineBlock 创建积木,TypeScript 会自动识别 functionargs 里面有哪些参数,并在 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

  • 使用 esbuild 构建代码,使用 JSZip 创建 ccx 文件,构建过程不经过 build 文件夹。

  • 结果不包含整个 assets 文件夹,只根据 src/info.jsonicon 属性和 inset_icon 属性,添加对应的文件。

  • 结果自动包含 LICENSE.txt 文件,遵守 MIT 许可证。

如果想了解更多不同的地方,请看代码。


结尾

您可以根据自己的喜好,随意更改 src 文件夹的内容,它们不会影响构建器本身。

本项目的 src 文件夹内容略有更改,ClipCC 官方文档仅供参考,请以实际情况为准。

本项目并非 ClipCC 官方项目,作者不属于 Clip Team 。

About

🚀 更好的 ClipCC 扩展开发框架,基于 esbuild + TypeScript 。

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •