Skip to content

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

Open
raistlin042 wants to merge 2 commits into
mainfrom
docs/apps-help-drop-miaoda
Open

docs: drop Miaoda brand word from apps command help text#1399
raistlin042 wants to merge 2 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", grep -i miaoda empty, wording natural)
  • manual verification: apps +create --help / apps +html-publish --help contain no "Miaoda"; grep -rn "Miaoda" shortcuts/apps/ returns empty

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 for 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4949f1f3-0d13-45d3-891a-6b191818b2ef

📥 Commits

Reviewing files that changed from the base of the PR and between 83947a6 and 90fdfbd.

📒 Files selected for processing (2)
  • shortcuts/apps/git_credential.go
  • shortcuts/apps/git_credential_test.go
✅ Files skipped from review due to trivial changes (1)
  • shortcuts/apps/git_credential_test.go
🚧 Files skipped from review as they are similar to previous changes (1)
  • shortcuts/apps/git_credential.go

📝 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
Access-scope, create, list, and update shortcuts update Description, 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.
Release & session shortcuts
shortcuts/apps/apps_release_*.go, shortcuts/apps/apps_session_*.go
Release create/get/list and session create/list comments, descriptions, flags, and DryRun/help text updated to "lark" or generic "app".
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

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 31.25% 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 clearly and concisely summarizes the main change: removing the 'Miaoda' brand word from apps command help text documentation.
Description check ✅ Passed The description includes all required sections with appropriate detail: a clear summary explaining the motivation, a comprehensive list of changes, a thorough test plan with multiple verification steps completed, and related issues noted.
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.

✏️ 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.28571% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.83%. Comparing base (e53f9d9) to head (90fdfbd).

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         731      731           
  Lines       69111    69111           
=======================================
  Hits        50335    50335           
  Misses      14999    14999           
  Partials     3777     3777           

☔ 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

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs/apps-help-drop-miaoda -y -g

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.

1 participant