plugin-types

本仓库存储各 QwQNT 插件的 Typescript 声明文件。

添加流程

1. Fork 本仓库
2. clone 到本地
3. 将你的插件声明文件添加到 types/your-plugin/ 下
4. 依次运行下列命令：

npm run changeset
# pnpm changeset

npm run version
# pnpm run version

5. 向本仓库 main 分支开 PR

约定

types 文件夹下的各包文件夹以有效插件名（即除 qwqnt 外的有意义的插件名）命名。

例：types/hako、types/lite_tools。

各包的包名以 @qwqnt-community 为 scope，后接有效插件名，并以 types 作结。采用 kebab-case 命名风格。

例：@qwqnt-community/hako-types。

各包的 package.json 应包含以下配置项：

{
  "repository": {
    "type": "git",
    "url": "https://github.com/qwqnt-community/plugin-types.git",
    "directory": "types/your-plugin"
  },
  "publishConfig": {
    "access": "restricted"
  },
}

使用

运行下列命令安装对应包：

npm install github:qwqnt-community/plugin-types#xxx --save-dev
# pnpm add github:qwqnt-community/plugin-types#xxx -D

xxx 为有效插件名，你也可以在本仓库中查看 branch 名或 types 路径下对应路径名获得。