docs: drop Miaoda brand word from apps command help text#1399
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR standardizes product-specific wording to vendor-neutral "app" or "lark" across shortcuts/apps: descriptions, flag help, DryRun strings, init commit subjects, tests, comments, and git-credential messages; credential validation gains a nil-issued check. No runtime behavior changed. ChangesTerminology Update Across App Shortcuts
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
fdb5a37 to
cdbfe33
Compare
cdbfe33 to
83947a6
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1399 +/- ##
=======================================
Coverage 72.83% 72.83%
=======================================
Files 732 732
Lines 69140 69140
=======================================
Hits 50356 50356
Misses 15003 15003
Partials 3781 3781 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@e7674e022e901ecac1668ba638cf6794b3e55262🧩 Skill updatenpx skills add larksuite/cli#docs/apps-help-drop-miaoda -y -g |
There was a problem hiding this comment.
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 `@shortcuts/apps/apps_init_test.go`:
- Around line 1470-1494: This test
(TestRunScaffold_SubprocessFailureIsExternalTool) appears unrelated to the PR's
stated scope (removing "Miaoda" wording); either remove the test from this PR or
move it to a separate PR focused on error-handling changes, and if the test is
intentionally included because runScaffold (in apps_init.go) was refactored,
update the PR description and commit message to explain the
runScaffold/error-classification changes; reference the test function name
TestRunScaffold_SubprocessFailureIsExternalTool and the runScaffold function so
reviewers can locate and validate the change.
🪄 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
Run ID: f1188c5f-a25e-4d3c-a2c7-10e96ec9801e
📒 Files selected for processing (19)
shortcuts/apps/apps_access_scope_get.goshortcuts/apps/apps_access_scope_set.goshortcuts/apps/apps_create.goshortcuts/apps/apps_db_execute.goshortcuts/apps/apps_db_table_get.goshortcuts/apps/apps_html_publish.goshortcuts/apps/apps_init.goshortcuts/apps/apps_init_test.goshortcuts/apps/apps_release_create.goshortcuts/apps/apps_release_get.goshortcuts/apps/apps_release_list.goshortcuts/apps/apps_session_create.goshortcuts/apps/apps_session_list.goshortcuts/apps/apps_update.goshortcuts/apps/common.goshortcuts/apps/git_credential.goshortcuts/apps/git_credential_test.goshortcuts/apps/gitcred/helper.goshortcuts/apps/html_publish_client.go
✅ Files skipped from review due to trivial changes (13)
- shortcuts/apps/apps_session_list.go
- shortcuts/apps/apps_access_scope_set.go
- shortcuts/apps/apps_release_list.go
- shortcuts/apps/apps_release_create.go
- shortcuts/apps/html_publish_client.go
- shortcuts/apps/common.go
- shortcuts/apps/apps_html_publish.go
- shortcuts/apps/apps_db_execute.go
- shortcuts/apps/apps_session_create.go
- shortcuts/apps/apps_db_table_get.go
- shortcuts/apps/apps_update.go
- shortcuts/apps/apps_init.go
- shortcuts/apps/git_credential.go
🚧 Files skipped from review as they are similar to previous changes (5)
- shortcuts/apps/apps_release_get.go
- shortcuts/apps/git_credential_test.go
- shortcuts/apps/gitcred/helper.go
- shortcuts/apps/apps_access_scope_get.go
- shortcuts/apps/apps_create.go
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
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 `@shortcuts/apps/apps_init_test.go`:
- Around line 1470-1494: This test
(TestRunScaffold_SubprocessFailureIsExternalTool) appears unrelated to the PR's
stated scope (removing "Miaoda" wording); either remove the test from this PR or
move it to a separate PR focused on error-handling changes, and if the test is
intentionally included because runScaffold (in apps_init.go) was refactored,
update the PR description and commit message to explain the
runScaffold/error-classification changes; reference the test function name
TestRunScaffold_SubprocessFailureIsExternalTool and the runScaffold function so
reviewers can locate and validate the change.
🪄 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
Run ID: f1188c5f-a25e-4d3c-a2c7-10e96ec9801e
📒 Files selected for processing (19)
shortcuts/apps/apps_access_scope_get.goshortcuts/apps/apps_access_scope_set.goshortcuts/apps/apps_create.goshortcuts/apps/apps_db_execute.goshortcuts/apps/apps_db_table_get.goshortcuts/apps/apps_html_publish.goshortcuts/apps/apps_init.goshortcuts/apps/apps_init_test.goshortcuts/apps/apps_release_create.goshortcuts/apps/apps_release_get.goshortcuts/apps/apps_release_list.goshortcuts/apps/apps_session_create.goshortcuts/apps/apps_session_list.goshortcuts/apps/apps_update.goshortcuts/apps/common.goshortcuts/apps/git_credential.goshortcuts/apps/git_credential_test.goshortcuts/apps/gitcred/helper.goshortcuts/apps/html_publish_client.go
✅ Files skipped from review due to trivial changes (13)
- shortcuts/apps/apps_session_list.go
- shortcuts/apps/apps_access_scope_set.go
- shortcuts/apps/apps_release_list.go
- shortcuts/apps/apps_release_create.go
- shortcuts/apps/html_publish_client.go
- shortcuts/apps/common.go
- shortcuts/apps/apps_html_publish.go
- shortcuts/apps/apps_db_execute.go
- shortcuts/apps/apps_session_create.go
- shortcuts/apps/apps_db_table_get.go
- shortcuts/apps/apps_update.go
- shortcuts/apps/apps_init.go
- shortcuts/apps/git_credential.go
🚧 Files skipped from review as they are similar to previous changes (5)
- shortcuts/apps/apps_release_get.go
- shortcuts/apps/git_credential_test.go
- shortcuts/apps/gitcred/helper.go
- shortcuts/apps/apps_access_scope_get.go
- shortcuts/apps/apps_create.go
🛑 Comments failed to post (1)
shortcuts/apps/apps_init_test.go (1)
1470-1494:
⚠️ Potential issue | 🟡 Minor | ⚡ Quick winWell-written test, but appears unrelated to PR's stated purpose.
The test correctly asserts typed error metadata (Category/Subtype) and cause preservation per coding guidelines. However, this PR's objective is to remove "Miaoda" brand wording from user-facing text, commit subjects, and messages. This test verifies error classification for external tool failures, which seems unrelated to the terminology changes described in the PR objectives and layer description.
If this test accompanies a refactor of error handling in
runScaffold(apps_init.go) that wasn't mentioned in the PR description, that context would help explain its inclusion. Otherwise, consider moving this improvement to a separate PR focused on error handling.🤖 Prompt for 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. In `@shortcuts/apps/apps_init_test.go` around lines 1470 - 1494, This test (TestRunScaffold_SubprocessFailureIsExternalTool) appears unrelated to the PR's stated scope (removing "Miaoda" wording); either remove the test from this PR or move it to a separate PR focused on error-handling changes, and if the test is intentionally included because runScaffold (in apps_init.go) was refactored, update the PR description and commit message to explain the runScaffold/error-classification changes; reference the test function name TestRunScaffold_SubprocessFailureIsExternalTool and the runScaffold function so reviewers can locate and validate the change.
Summary
lark-cli appscommand help, runtime hints, and error messages embedded the pinyin brand word "Miaoda". When a user upgraded lark-cli but not the lark-apps skill (or the AI did not load it), the AI would "helpfully" mistranslate "Miaoda" into wrong Chinese names. Per the product team decision, the external product term is just "app", so this PR removes the "Miaoda" brand word across all apps command text (e.g. "Miaoda app" becomes "app"), removing the trigger for mistranslation.Changes
shortcuts/apps/: ShortcutDescription, flagDesc, the cobraShort, dry-run.Desc(...),hintconstants, andoutput.Errorf/gitCredentialLocalErrormessages (apps_create.go,apps_html_publish.go,git_credential.go,gitcred/helper.go,apps_db_*.go,apps_release_*.go,apps_session_*.go,apps_list.go,apps_update.go,apps_access_scope_*.go,common.go,html_publish_client.go, etc.)apps +initcommit-message constants inapps_init.go(initialize app config/initialize app repository)git_credential_test.go,apps_init_test.go)@lark-apaas/miaoda-cli, themiaoda-clitool references,https://miaoda.feishu.cnURLs, and existing Chinese text. These are identifiers/paths/localized strings, not the brand word in English help text.Test Plan
make unit-testpassed (go test ./shortcuts/apps/...green, incl. gitcred subpackage)apps --helpand subcommand help show "app", wording natural)apps +create --help/apps +html-publish --helpcontain no "Miaoda". After merging main,grep -rin miaoda shortcuts/apps/ tests/cli_e2e/apps/returns only identifier-class matches (npm package@lark-apaas/miaoda-cli, themiaoda.feishu.cnURL, and test-fixture URLs) -- no brand-word text in any help/hint/error/comment.Related Issues
N/A
Summary by CodeRabbit