CPTProgrammer/ModReleaser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update placeholder syntax in template string documentation

Browse Source
This commit is contained in:
CPTProgrammer 2026-07-08 04:55:53 +08:00
parent db9e9c3d05
commit a0cf0f9d93
No known key found for this signature in database
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/frontend.md
View File

@ -107,7 +107,7 @@
| 字段 | 控件 | 说明 | | 字段 | 控件 | 说明 |
|------|------|------| |------|------|------|
| `project_id` | InputNumber | 项目 ID（数字）。输入后使用 Ant Design 防抖 hook 自动查询项目名称并显示在输入框下方以供确认 | | `project_id` | InputNumber | 项目 ID（数字）。输入后使用 Ant Design 防抖 hook 自动查询项目名称并显示在输入框下方以供确认 |
| `version_name` | Input | 模板字符串，含占位符。默认 `"${filename_format}"`。使用防抖自动显示匹配到的版本数量 | | `version_name` | Input | 模板字符串，含占位符。默认 `"#{filename_format}"`。使用防抖自动显示匹配到的版本数量 |
| `environment` | Select（多选） | 选项从 Game Version Types API（Environment 类型）获取 | | `environment` | Select（多选） | 选项从 Game Version Types API（Environment 类型）获取 |
| `loaders` | Select（多选） | 选项从 Game Version Types API（Modloader 类型）获取 | | `loaders` | Select（多选） | 选项从 Game Version Types API（Modloader 类型）获取 |
| `relations` | 动态列表 | 每项含 `slug`（Input）和 `type`（Select：embeddedLibrary/incompatible/optionalDependency/requiredDependency/tool） | | `relations` | 动态列表 | 每项含 `slug`（Input）和 `type`（Select：embeddedLibrary/incompatible/optionalDependency/requiredDependency/tool） |

9
docs/workflow.md
View File

@ -32,7 +32,7 @@
}, },
"curseforge": { "curseforge": {
"project_id": 123456, "project_id": 123456,
"version_name": "${filename_format}", "version_name": "#{filename_format}",
"environment": ["Client", "Server"], "environment": ["Client", "Server"],
"loaders": ["fabric"], "loaders": ["fabric"],
"relations": { "relations": {
@ -60,7 +60,7 @@
| `modrinth.dependencies` | object[] | 依赖列表，无依赖填 `[]` | | `modrinth.dependencies` | object[] | 依赖列表，无依赖填 `[]` |
| `curseforge` | object | CurseForge 配置 | | `curseforge` | object | CurseForge 配置 |
| `curseforge.project_id` | number | CurseForge 项目 ID | | `curseforge.project_id` | number | CurseForge 项目 ID |
| `curseforge.version_name` | string | 版本名称模板，`${filename_format}` 引用 config 中 `filename_format` 字段 | | `curseforge.version_name` | string | 版本名称模板，如 `"#{filename_format}"` |
| `curseforge.environment` | string[] | 运行环境 | | `curseforge.environment` | string[] | 运行环境 |
| `curseforge.loaders` | string[] | 加载器列表 | | `curseforge.loaders` | string[] | 加载器列表 |
| `curseforge.relations` | object | 关联项目，格式 `{ projects: [...] }` | | `curseforge.relations` | object | 关联项目，格式 `{ projects: [...] }` |
@ -71,7 +71,10 @@
| `filename_format` | string | 构建产物文件名模板，用于反向解析 `${version}` 和 `${mc_version}` | | `filename_format` | string | 构建产物文件名模板，用于反向解析 `${version}` 和 `${mc_version}` |
| `source_filename_format` | string | 源码 jar 文件名模板，用于正向生成文件名 | | `source_filename_format` | string | 源码 jar 文件名模板，用于正向生成文件名 |
> **递归解析规则**：所有含 `${...}` 的模板字符串，正向 format 或反向解析后，若结果仍包含 `${...}` 占位符，则需继续解析，直至结果中不再有占位符为止。`${...}` 中的变量首先从 config 同级字段取值，例如 `${filename_format}` 引用 config 中的 `filename_format` 字段。 > **递归解析规则**：所有含占位符的模板字符串，正向 format 或反向解析后，若结果仍包含占位符，则需继续解析，直至结果中不再有占位符为止。
>
> - `#{...}` — 引用占位符，如 `#{filename_format}` 表示此处将引用解析后的值
> - `${...}` — 模板变量，由运行时填入实际值，如 `${version}`、`${mc_version}`
## 运行时流程 ## 运行时流程