Skip to content

docs(slides): 补齐 shortcut 参数说明,修正 +xml-get --output 必填标注 - #2088

Merged
R0bynZhu merged 10 commits into
mainfrom
fix-slides-xml-get-output-path
Jul 29, 2026
Merged

docs(slides): 补齐 shortcut 参数说明,修正 +xml-get --output 必填标注#2088
R0bynZhu merged 10 commits into
mainfrom
fix-slides-xml-get-output-path

Conversation

@R0bynZhu

@R0bynZhu R0bynZhu commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

改动

只动 skills/lark-slides/SKILL.md

  • Shortcuts 表新增 +screenshot:写明 --slide-number(页号从 1 开始、多页重复
    传入、一次最多 10 页)和 --output-dir(CWD 内相对路径,默认
    .lark-slides/screenshots),并提示截图失败时降级到 XML 回读等非截图检查。
  • +xml-get 行补上参数--presentation 指定 xml_presentation_id--output
    落盘(CWD 内相对路径),并说明省略 --output 时 XML 直接返回在 JSON 信封里
    ——该参数自 v1.0.70(07-15)起就是可选的。
  • 「按需再读」改为「调用相关命令前必须读取相关的文档以了解命令的使用方式」
    把命令参考文档从可选阅读提升为调用前必读。
  • Step 4 的回读示例补全 --presentation <xml_presentation_id>,避免残缺命令被照抄。

影响面

纯文档改动,单文件 +4 / -3,不涉及 Go 代码,无行为变更。
references/ 下的文档本轮未改动。

Summary by CodeRabbit

  • Documentation
    • Clarified that users must review the corresponding command documentation before executing steps labeled as “required before running.”
    • Updated the generation/review guidance to require reading the complete presentation XML after creation and to perform/record checklist-based validation (including XML text overlap checks).
    • Expanded +xml-get usage details, including --presentation selection and --output requirements for saving XML to a relative path within the current working directory.

R0bynZhu added 7 commits July 28, 2026 20:49
State the "all local file path args must be CWD-relative (absolute
rejected)" rule once in SKILL.md 权威经验, and trim the per-command
repetitions in media-upload / create / screenshot / xml-presentations-get.
Also fix the stale xml-presentations-get param table: --output is optional
(relative), not required.
- 「调用命令前再读」改为「调用相关命令前必须读取相关的文档以了解命令的使用方式」,
  并把原「按需再读」列表合并进来,去掉可选语义
- 移除 lark-shared 的 CRITICAL 前置阅读要求
- Step 4 回读示例补全 `--presentation <xml_presentation_id>` 参数
- 新增 +screenshot 行:--slide-number 页号(从 1 开始,可重复,一次最多 10 页)、
  --output-dir 保存目录(CWD 内相对路径,默认 .lark-slides/screenshots)
- +xml-get 行补上 --presentation 和 --output(CWD 内相对路径),
  并说明省略 --output 时 XML 返回在 JSON 信封里
@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e632dd77-ef41-4b74-8614-559396bd9ba1

📥 Commits

Reviewing files that changed from the base of the PR and between e5edbee and cc9bbf4.

📒 Files selected for processing (1)
  • skills/lark-slides/SKILL.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/lark-slides/SKILL.md

📝 Walkthrough

Walkthrough

Updated the Slides skill documentation to require command-reference reading, explicit XML validation after generation, and precise +xml-get presentation and output semantics.

Changes

Slides documentation

Layer / File(s) Summary
Workflow and verification guidance
skills/lark-slides/SKILL.md
Requires reading command documentation before execution and validating generated presentations through full XML readback and the validation checklist.
Shortcut parameter semantics
skills/lark-slides/SKILL.md
Documents +xml-get --presentation and requires CWD-relative paths when using --output to save XML locally.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • larksuite/cli#389: Introduced the related Slides skill documentation and creation workflow.
  • larksuite/cli#1887: Refactored related +xml-get shortcut behavior and output handling.
  • larksuite/cli#1933: Updated overlapping Slides skill workflow and +xml-get documentation.

Suggested labels: domain/ccm

Suggested reviewers: fangshuyu-768

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning 描述包含改动和影响面,但未按模板提供 Summary、Changes、Test Plan 和 Related Issues 等必填区块。 请按模板补齐 Summary、Changes、Test Plan 和 Related Issues,并用对应标题组织内容。
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed 标题与变更相关,准确概括了补充 shortcut 参数说明和修正 +xml-get 的说明。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-slides-xml-get-output-path

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.

R0bynZhu added 2 commits July 28, 2026 21:51
把 lark-slides-create.md、lark-slides-media-upload.md、lark-slides-screenshot.md、
lark-slides-xml-presentations-get.md 还原为 main 的版本,本分支只改 SKILL.md。
认证、权限和全局参数以 lark-shared 为准,这条前置阅读不该在本分支被删掉。
@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@cc9bbf4bd2afb0533a689b25d788d803b109fc6c

🧩 Skill update

npx skills add larksuite/cli#fix-slides-xml-get-output-path -y -g

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/lark-slides/SKILL.md`:
- Around line 317-318: Align the +xml-get contract across SKILL.md,
references/lark-slides-xml-presentations-get.md, and the Step 4 example: either
keep --output required and ensure every invocation writes XML to a CWD-relative
local file, or document and implement the CLI behavior that allows omission and
returns a JSON envelope. Preserve consistency with validation-checklist.md and
update all related option descriptions and examples atomically.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4f9d1333-9c24-4a00-ac46-f1f350355204

📥 Commits

Reviewing files that changed from the base of the PR and between b0b1ca4 and e5edbee.

📒 Files selected for processing (1)
  • skills/lark-slides/SKILL.md

Comment thread skills/lark-slides/SKILL.md Outdated
@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.16%. Comparing base (2e0fb9a) to head (cc9bbf4).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2088   +/-   ##
=======================================
  Coverage   75.16%   75.16%           
=======================================
  Files         912      912           
  Lines       96475    96475           
=======================================
  Hits        72517    72517           
  Misses      18381    18381           
  Partials     5577     5577           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@R0bynZhu
R0bynZhu merged commit 358cd06 into main Jul 29, 2026
35 of 42 checks passed
@R0bynZhu
R0bynZhu deleted the fix-slides-xml-get-output-path branch July 29, 2026 02:55
@liangshuo-1 liangshuo-1 mentioned this pull request Jul 29, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants