Skip to content

docs: drop Miaoda brand word from apps command help text#1399

Merged
liangshuo-1 merged 4 commits into
mainfrom
docs/apps-help-drop-miaoda
Jun 13, 2026
Merged

docs: drop Miaoda brand word from apps command help text#1399
liangshuo-1 merged 4 commits into
mainfrom
docs/apps-help-drop-miaoda

Conversation

@raistlin042

@raistlin042 raistlin042 commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

lark-cli apps command 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

  • Remove the "Miaoda" brand word (so "Miaoda app" becomes "app") in all user/AI-facing English text under shortcuts/apps/: Shortcut Description, flag Desc, the cobra Short, dry-run .Desc(...), hint constants, and output.Errorf / gitCredentialLocalError messages (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.)
  • Update code comments in the same files for consistency
  • Rename the two apps +init commit-message constants in apps_init.go (initialize app config / initialize app repository)
  • Update test assertions that referenced the old strings (git_credential_test.go, apps_init_test.go)
  • Deliberately NOT changed: the npm package identifier @lark-apaas/miaoda-cli, the miaoda-cli tool references, https://miaoda.feishu.cn URLs, and existing Chinese text. These are identifiers/paths/localized strings, not the brand word in English help text.

Test Plan

  • make unit-test passed (go test ./shortcuts/apps/... green, incl. gitcred subpackage)
  • validate passed (build / vet / unit / integration)
  • local-eval passed (cli_e2e apps regression green; skillave N/A in lite mode)
  • acceptance-reviewer passed (2/2: apps --help and subcommand help show "app", wording natural)
  • manual verification: apps +create --help / apps +html-publish --help contain 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, the miaoda.feishu.cn URL, and test-fixture URLs) -- no brand-word text in any help/hint/error/comment.

Related Issues

N/A

Summary by CodeRabbit

  • Style
    • Standardized user-facing terminology: replaced product-specific references with vendor-neutral wording ("app" or "lark") across commands, help text, flag descriptions, dry‑run/descriptive strings, commit message hints, error messages, and tests covering app creation, listing, updating, DB operations, HTML publish, releases, sessions, git credentials, and related flows.

@raistlin042 raistlin042 added the documentation Improvements or additions to documentation label Jun 11, 2026
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

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

Changes

Terminology Update Across App Shortcuts

Layer / File(s) Summary
Core shortcut descriptions & DryRun text
shortcuts/apps/apps_access_scope_*.go, shortcuts/apps/apps_create.go, shortcuts/apps/apps_list.go, shortcuts/apps/apps_update.go, shortcuts/apps/apps_release_*.go, shortcuts/apps/apps_session_*.go
Access-scope, create, list, update, release, and session shortcuts update Description, flag help, and DryRun strings to use generic "app" or "lark".
DB, HTML publish, and flags
shortcuts/apps/apps_db_*.go, shortcuts/apps/apps_html_publish.go
DB env/create/execute/table-get/table-list and HTML publish shortcuts update descriptions and --app-id flag help to "app" / "lark app".
AppsInit wording & tests
shortcuts/apps/apps_init.go, shortcuts/apps/apps_init_test.go
Init commit-subject constants, AppsInit Description, flag help, DryRun steps, in-file comments, and tests updated to new wording.
Git credential commands & validation
shortcuts/apps/git_credential.go, shortcuts/apps/git_credential_test.go, shortcuts/apps/gitcred/helper.go
Git credential init/remove/list descriptions, flags, DryRun text, local error prefixes, helper Short, parsing error messages, and validation messages updated; validateIssuedCredential now returns an error when issued credential is nil.
Common comments & types
shortcuts/apps/common.go, shortcuts/apps/gitcred/types.go, shortcuts/apps/html_publish_client.go
Package-level comments and explanatory notes reworded from product-specific to "lark" context; no code or exported values changed.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • larksuite/cli#1002: Earlier terminology/shortcut definitions touching the same app shortcuts.

Suggested reviewers

  • liangshuo-1
  • liuxinyanglxy

Poem

🐰 Hopping through the code with a tidy clap,
I swapped names so the messages map,
Flags and DryRun, comments and tests,
Commits aligned and wording dressed,
A neat little hop — now everything's apt!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 37.50% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: drop Miaoda brand word from apps command help text' accurately summarizes the main change: removing vendor branding terminology from user-facing documentation.
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 comprehensively covers all required template sections with clear explanations of motivation, detailed change list, thorough test plan results, and proper acknowledgment of intentionally unchanged components.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/apps-help-drop-miaoda

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 11, 2026
@raistlin042
raistlin042 force-pushed the docs/apps-help-drop-miaoda branch from fdb5a37 to cdbfe33 Compare June 11, 2026 07:33
@raistlin042
raistlin042 force-pushed the docs/apps-help-drop-miaoda branch from cdbfe33 to 83947a6 Compare June 11, 2026 07:38
@raistlin042 raistlin042 changed the title docs: rename Miaoda to lark app in apps command help text docs: drop Miaoda brand word from apps command help text Jun 11, 2026
@raistlin042 raistlin042 reopened this Jun 11, 2026
@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 89.65517% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.83%. Comparing base (33e459a) to head (e7674e0).
⚠️ Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
shortcuts/apps/apps_access_scope_get.go 0.00% 1 Missing ⚠️
shortcuts/apps/apps_access_scope_set.go 0.00% 1 Missing ⚠️
shortcuts/apps/apps_update.go 0.00% 1 Missing ⚠️
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.
📢 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.

@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs/apps-help-drop-miaoda -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 `@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

📥 Commits

Reviewing files that changed from the base of the PR and between 90fdfbd and 039b886.

📒 Files selected for processing (19)
  • shortcuts/apps/apps_access_scope_get.go
  • shortcuts/apps/apps_access_scope_set.go
  • shortcuts/apps/apps_create.go
  • shortcuts/apps/apps_db_execute.go
  • shortcuts/apps/apps_db_table_get.go
  • shortcuts/apps/apps_html_publish.go
  • shortcuts/apps/apps_init.go
  • shortcuts/apps/apps_init_test.go
  • shortcuts/apps/apps_release_create.go
  • shortcuts/apps/apps_release_get.go
  • shortcuts/apps/apps_release_list.go
  • shortcuts/apps/apps_session_create.go
  • shortcuts/apps/apps_session_list.go
  • shortcuts/apps/apps_update.go
  • shortcuts/apps/common.go
  • shortcuts/apps/git_credential.go
  • shortcuts/apps/git_credential_test.go
  • shortcuts/apps/gitcred/helper.go
  • shortcuts/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

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 90fdfbd and 039b886.

📒 Files selected for processing (19)
  • shortcuts/apps/apps_access_scope_get.go
  • shortcuts/apps/apps_access_scope_set.go
  • shortcuts/apps/apps_create.go
  • shortcuts/apps/apps_db_execute.go
  • shortcuts/apps/apps_db_table_get.go
  • shortcuts/apps/apps_html_publish.go
  • shortcuts/apps/apps_init.go
  • shortcuts/apps/apps_init_test.go
  • shortcuts/apps/apps_release_create.go
  • shortcuts/apps/apps_release_get.go
  • shortcuts/apps/apps_release_list.go
  • shortcuts/apps/apps_session_create.go
  • shortcuts/apps/apps_session_list.go
  • shortcuts/apps/apps_update.go
  • shortcuts/apps/common.go
  • shortcuts/apps/git_credential.go
  • shortcuts/apps/git_credential_test.go
  • shortcuts/apps/gitcred/helper.go
  • shortcuts/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 win

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

@liangshuo-1
liangshuo-1 merged commit 0fbfe68 into main Jun 13, 2026
21 checks passed
@liangshuo-1
liangshuo-1 deleted the docs/apps-help-drop-miaoda branch June 13, 2026 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation 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