-
Notifications
You must be signed in to change notification settings - Fork 23
docs: update extension create command path parameter description #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update extension create command path parameter description #41
Conversation
|
@People-Sea is attempting to deploy a commit to the deathsatan's projects Team on Vercel. A member of the Team first needs to authorize it. |
❌ Deploy Preview for super-cobbler-53ff65 failed. Why did it fail? →
|
Walkthrough在中文插件命令文档中,移除 Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/zh/plugin/command.md (2)
93-93: “path” 行的默认值/备注列混用,路径格式表述不够清晰,建议规范化将“必填”从“默认值”列移至“备注”列,并明确路径的规范与示例,读者更易理解。
应用以下 diff 优化该行:
-| path | string | 无,必填 | 创建路径,例如 zds/app-store (用户名)/(插件目录名) | +| path | string | 无 | 必填;创建路径,格式为 用户名/插件目录名(例如:zds/app-store) |
94-94: 可选类型的枚举展示建议统一标点与空格,提升可读性在中文语境下,用顿号或加空格的英文逗号都可,建议与全篇保持一致。
应用以下 diff:
-| --type | string | mixed | 插件类型 可选类型: mixed,frontend,backend | +| --type | string | mixed | 插件类型,可选:mixed, frontend, backend |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/zh/plugin/command.md(1 hunks)
🔇 Additional comments (1)
docs/zh/plugin/command.md (1)
95-96: 将“可选”从“默认值”列移到“备注”,并把 minejson 改为 mine.json核实:mine-extension:create 支持 --author 与 --description,path 为必填的位置参数,且参数会写入 mine.json 的 author 与 description 字段。请按下方 diff 修正文档(统一空格/标点、将“可选”移至备注列并修正字段名)。
文件:docs/zh/plugin/command.md 行 95-96
-| --author | string| 无,可选 | 作者名称,此值会填充到 minejson.author 中 | -| --description | string| 无,可选 | 插件介绍,此值会填充到 minejson.description 中 | +| --author | string | 无 | 可选;作者名称,此值会填充到 mine.json.author 中 | +| --description | string | 无 | 可选;插件介绍,此值会填充到 mine.json.description 中 |在提交中确认 CLI 帮助输出:--author/--description 是否存在;path 是否为位置参数;参数是否确实写入 mine.json.author / mine.json.description(author 是否为数组对象)。若 path 为位置参数,使用方案 A 示例;否则使用方案 B 并注明交互式输入或通过选项提供 path。
Summary by CodeRabbit