Skip to content

Conversation

@People-Sea
Copy link
Member

@People-Sea People-Sea commented Sep 14, 2025

Summary by CodeRabbit

  • 文档
    • 更新“创建一个插件”命令说明:移除 --name,新增 --author 与 --description(分别映射到插件元数据的作者与描述字段),并调整参数表结构以提高清晰度(--type 保留但调整顺序)。
    • 明确 path 为必填,格式为 用户名/插件目录名(例如:zds/app-store),默认值改为 无;其余文档内容保持不变。

@vercel
Copy link

vercel bot commented Sep 14, 2025

@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.

@netlify
Copy link

netlify bot commented Sep 14, 2025

Deploy Preview for super-cobbler-53ff65 failed. Why did it fail? →

Name Link
🔨 Latest commit c9fba51
🔍 Latest deploy log https://app.netlify.com/projects/super-cobbler-53ff65/deploys/68c7b8b27cfb4600085e1fd0

@coderabbitai
Copy link

coderabbitai bot commented Sep 14, 2025

Walkthrough

在中文插件命令文档中,移除 --name 选项,新增加 --author--description;将 path 描述扩展为 用户名/插件目录名(例如:zds/app-store);相应调整参数表结构,其余内容未变更。

Changes

Cohort / File(s) Summary
Docs: 插件命令参数更新
docs/zh/plugin/command.md
更新参数表:移除 --name,新增 --author(映射为 minejson.author)与 --description(映射为 minejson.description);将 path 描述改为“用户/插件目录名(例如:zds/app-store)”,默认改为 ,并标注为必填;重排表格结构;其他内容保持不变。

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

我是仓中跃动的兔,嗅得新页鲜,
旧名退场,作者与描书肩并肩。
路径添了门牌:用户名/插件目录明,
表格重排静待手,文档轻翻又一面。
胡萝卜笑了,版本小步又前缘。

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed 标题“docs: update extension create command path parameter description”直接且准确地反映了变更集中对 docs/zh/plugin/command.md 中路径参数描述的主要修改,表述简洁明了,便于团队快速理解主要改动;尽管 PR 还包含新增 --author/--description 与移除 --name 的次要调整,但标题聚焦于最重要的变更是合理的。
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03ef18e and c9fba51.

📒 Files selected for processing (1)
  • docs/zh/plugin/command.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/zh/plugin/command.md

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@People-Sea People-Sea marked this pull request as ready for review September 15, 2025 06:16
Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between a9be75b and 03ef18e.

📒 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。

@People-Sea People-Sea requested a review from zds-s September 15, 2025 07:13
@People-Sea People-Sea merged commit b84c1a8 into mineadmin:main Sep 15, 2025
2 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants