diff --git a/README.md b/README.md index 8ecd335..672241b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ pnpm install 接下来下面所有的示例链接都基于 `username/subscription`, 请自行替换后打开 +`pnpm install` 用于安装依赖, 如果您的 [./package.json](./package.json) 发生变化, 则需要再次运行 `pnpm install` + 如果您无法初始化 nodejs 环境, 那可以直接使用 github 网页编辑文件后在线提交, 点击下面链接即可在线编辑 @@ -45,56 +47,6 @@ pnpm install 另外您必须修改 订阅详情 [./src/subscription.ts](./src/subscription.ts) 下的 id 字段, 否则可能会和其它订阅冲突, 填一个较大的随机数字即可 -## 配置文件 - -你可以在 [./package.json](./package.json) 下添加 gkd 属性配置自定义构建选项 - -```json -{ - "gkd": { - "outDir": "dist", - "file": "gkd.json5", - "versionFile": "gkd.version.json5", - "changelog": "CHANGELOG.md", - "README.md": "README.md" - } -} -``` - -这个 gkd 属性的类型如下 - -```ts -/** - * @default package.json.gkd - */ -type GkdConfig = { - /** - * @default 'dist' - */ - outDir?: string; - /** - * @default 'gkd.json5' - */ - file?: string; - /** - * @default 'gkd.version.json5' - */ - versionFile?: string; - /** - * @default 'CHANGELOG.md' - */ - changelog?: string; - /** - * @default 'README.md' - */ - readme?: string; -}; -``` - -如果不想写配置文件, 也可以将这个参数直接传递给 `@gkd-kit/tools` 的 `updateDist` 函数 - -手动传递参数的时候, 你必须显式将路径(非文件名)参数传递给 [./.github/workflows/build_release.yml](./.github/workflows/build_release.yml) 下的 `updatePkgVersion` 和 `stdoutGkdVersion` 函数 - ## 格式修复 我们使用 [prettier](https://github.com/prettier/prettier) 来格式化代码 和 [eslint](https://github.com/eslint/eslint) 来检测并修复代码错误 @@ -166,3 +118,55 @@ https://registry.npmmirror.com/gkd-subscription-xxxx/latest/files/dist/gkd.json5 ``` 注: 将 gkd-subscription-xxxx 换成您的包名 + +## 自定义配置文件 + +注意: **大多数情况下, 你不需要自定义, 使用默认配置时, 下面此节教程无需了解** + +你可以在 [./package.json](./package.json) 下添加 gkd 属性配置自定义构建选项 + +```json +{ + "gkd": { + "outDir": "dist", + "file": "gkd.json5", + "versionFile": "gkd.version.json5", + "changelog": "CHANGELOG.md", + "README.md": "README.md" + } +} +``` + +这个 gkd 属性的类型如下 + +```ts +/** + * @default package.json.gkd + */ +type GkdConfig = { + /** + * @default 'dist' + */ + outDir?: string; + /** + * @default 'gkd.json5' + */ + file?: string; + /** + * @default 'gkd.version.json5' + */ + versionFile?: string; + /** + * @default 'CHANGELOG.md' + */ + changelog?: string; + /** + * @default 'README.md' + */ + readme?: string; +}; +``` + +如果不想写配置文件, 也可以将这个参数直接传递给 `@gkd-kit/tools` 的 `updateDist` 函数 + +手动传递参数的时候, 你必须显式将路径(非文件名)参数传递给 [./.github/workflows/build_release.yml](./.github/workflows/build_release.yml) 下的 `updatePkgVersion` 和 `stdoutGkdVersion` 函数