Skip to content

feat(lark-shared): document relative-path-only file arguments#1319

Merged
liangshuo-1 merged 1 commit into
larksuite:mainfrom
GeekyMax:feat/lark-shared-path
Jun 8, 2026
Merged

feat(lark-shared): document relative-path-only file arguments#1319
liangshuo-1 merged 1 commit into
larksuite:mainfrom
GeekyMax:feat/lark-shared-path

Conversation

@GeekyMax

@GeekyMax GeekyMax commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

lark-cli rejects absolute file paths for path arguments with an unsafe file path error, but the lark-shared skill never documented this constraint, so agents repeatedly hit it. This adds a one-line rule under the shared security section so every domain skill inherits the guidance.

Changes

  • Add a relative-path-only rule to the 安全规则 section in skills/lark-shared/SKILL.md, covering --file / --output / --output-dir / @file and steering large/data input to stdin

Test Plan

  • skipped: make unit-test — docs-only change, no Go code touched
  • skipped: validate / local-eval / acceptance-reviewer — single-line guidance addition to an existing skill section, no command examples added
  • manual verification: reviewed rendered skills/lark-shared/SKILL.md — new bullet sits at the end of ## 安全规则, no structural/frontmatter change

Related Issues

N/A

Summary by CodeRabbit

  • Documentation
    • New safety guidelines added for path parameters. Path-based arguments now only accept relative paths from the current working directory, with absolute paths resulting in an error. Documentation also recommends using stdin for data input to reduce complexity and potential issues related to path handling and escaping.

Change-Id: I33692186481670dcf7baeaf0a5b5cff2fb18dce9
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a single line to the skill documentation clarifying a file path safety constraint. The change specifies that file and output path parameters must use relative paths relative to the current working directory, with absolute paths triggering an unsafe file path error. It also recommends using stdin for large data inputs.

Changes

File Path Safety Documentation

Layer / File(s) Summary
File path safety constraint guidance
skills/lark-shared/SKILL.md
A safety rule is added clarifying that --file, --output, --output-dir, and @file parameters accept only relative paths (relative to cwd); absolute paths error with unsafe file path. The guidance recommends using stdin for large data inputs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • larksuite/cli#1279: Skill documentation update strengthening path restrictions and validation for --file and related input parameters, enforcing local/relative paths and warning against unsafe or invalid paths.

Suggested labels

size/M

Suggested reviewers

  • wittam-01
  • fangshuyu-768

Poem

🐰 A safety rule hops into view,
Path constraints, both clear and true,
No absolutes allowed today—
Just relative paths light the way,
And stdin flows where data play! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: documenting the relative-path-only constraint for file arguments in the lark-shared skill.
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.
Description check ✅ Passed The PR description is well-structured and covers all required template sections with clear details about the motivation, changes made, and testing approach.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Jun 8, 2026
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add GeekyMax/cli#feat/lark-shared-path -y -g

@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.14%. Comparing base (e40ef66) to head (6f5acd5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1319   +/-   ##
=======================================
  Coverage   71.14%   71.14%           
=======================================
  Files         685      685           
  Lines       65770    65770           
=======================================
  Hits        46793    46793           
  Misses      15326    15326           
  Partials     3651     3651           

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

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.

3 participants