mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
c5b5aece33
* refactor: retire legacy error envelopes and enforce typed contract
Consolidate all command error reporting onto the typed errs.* contract, remove
the legacy error surface that predated it, and tighten the lint guards so the
contract holds across the whole repository going forward.
Every failure now reaches stderr as one envelope shape: a category, an
optional subtype, a human- and agent-readable message, and a recovery hint,
with invalid parameters listed under `params`. The legacy ExitError envelope,
its constructors, and the boundary bridge that promoted untyped config and
authorization errors are deleted, leaving a single path from error to wire.
Predicate commands keep their silent-exit behavior through a dedicated signal
that carries only an exit code.
Infrastructure paths that still emitted ad-hoc envelopes — flag parsing,
unknown commands and subcommands, plugin and policy guards, confirmation
prompts, and auth/config failures — now classify into the same taxonomy.
Business, API, auth, and config exit codes are preserved; the one behavioral
change is that Cobra usage failures (missing required flag, unknown command,
bad arguments) now emit the typed validation envelope and exit 2, matching the
explicit flag and subcommand guards, instead of Cobra's plain-text exit 1.
Enforcement is repo-wide rather than per-path:
- The errscontract guards run by default everywhere instead of through a
migration allowlist, so legacy envelopes cannot be reintroduced anywhere.
- errorlint runs across the whole repository: every error wrap must use %w and
every comparison must use errors.Is/errors.As, so interior wraps stay legal
but can no longer break the chain the typed boundary relies on.
- The errs-no-bare-wrap guard is keyed by structural prefix instead of an
explicit per-domain allowlist, so new shortcut domains are covered without
editing a list. It runs where forbidigo is enabled (the shortcut domains and
the auth/config/service command groups); repo-wide chain integrity for the
remaining command paths is carried by errorlint above.
* test: align cli_e2e success assertions to the ok envelope
The api and service success path now emits the {"ok":true} envelope, so the
cli_e2e workflow assertions that still expected the old {"code":0} shape via
AssertStdoutStatus(t, 0) fail once they run with live credentials. Switch those
workflow assertions to AssertStdoutStatus(t, true); the fake-payload helper test
in core_test.go keeps its code-shape assertion.
113 lines
3.8 KiB
Go
113 lines
3.8 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
||
// SPDX-License-Identifier: MIT
|
||
|
||
package config
|
||
|
||
import (
|
||
"errors"
|
||
|
||
"github.com/charmbracelet/huh"
|
||
|
||
"github.com/larksuite/cli/errs"
|
||
"github.com/larksuite/cli/internal/cmdutil"
|
||
"github.com/larksuite/cli/internal/i18n"
|
||
"github.com/larksuite/cli/internal/output"
|
||
)
|
||
|
||
type initMsg struct {
|
||
SelectAction string
|
||
CreateNewApp string
|
||
ConfigExistingApp string
|
||
Platform string
|
||
SelectPlatform string
|
||
Feishu string
|
||
// TTY (interactive) variants
|
||
ScanQRCode string // header shown above QR code
|
||
ScanOrOpenLink string // post-QR alt link prompt ("or open...")
|
||
WaitingForScan string // active polling indicator
|
||
// Non-TTY (AI / non-interactive) variants — preserve original copy
|
||
OpenLinkNonTTY string // primary link prompt
|
||
WaitingForScanNonTTY string // passive waiting indicator
|
||
DetectedLarkTenant string
|
||
AppCreated string
|
||
ConfigSaved string
|
||
|
||
// LangPreferenceSet is printed to stderr after a successful init when the
|
||
// user explicitly passed --lang. Format: language code.
|
||
LangPreferenceSet string
|
||
}
|
||
|
||
var initMsgZh = &initMsg{
|
||
SelectAction: "选择操作",
|
||
CreateNewApp: "一键配置应用 (推荐) ",
|
||
ConfigExistingApp: "手动输入应用凭证",
|
||
Platform: "平台",
|
||
SelectPlatform: "选择平台",
|
||
Feishu: "飞书",
|
||
ScanQRCode: "\n使用飞书 / Lark 扫码配置应用：\n\n",
|
||
ScanOrOpenLink: "\n或打开以下链接完成配置：\n",
|
||
WaitingForScan: "正在获取你的应用配置结果...",
|
||
OpenLinkNonTTY: "\n打开以下链接配置应用:\n\n",
|
||
WaitingForScanNonTTY: "等待配置应用...",
|
||
DetectedLarkTenant: "[lark-cli] 检测到 Lark 租户，切换端点重试...",
|
||
AppCreated: "应用配置成功! App ID: %s",
|
||
ConfigSaved: "应用配置成功! App ID: %s",
|
||
LangPreferenceSet: "语言偏好已设置：%s",
|
||
}
|
||
|
||
var initMsgEn = &initMsg{
|
||
SelectAction: "Select action",
|
||
CreateNewApp: "Set up your app with one click (Recommended)",
|
||
ConfigExistingApp: "Enter app credentials yourself",
|
||
Platform: "Platform",
|
||
SelectPlatform: "Select platform",
|
||
Feishu: "Feishu",
|
||
ScanQRCode: "\nScan the QR code with Feishu/Lark:\n\n",
|
||
ScanOrOpenLink: "\nOr open the link below in your browser:\n",
|
||
WaitingForScan: "Fetching configuration results...",
|
||
OpenLinkNonTTY: "\nOpen the link below to configure app:\n\n",
|
||
WaitingForScanNonTTY: "Waiting for app configuration...",
|
||
DetectedLarkTenant: "[lark-cli] Detected Lark tenant, switching endpoint...",
|
||
AppCreated: "App configured! App ID: %s",
|
||
ConfigSaved: "App configured! App ID: %s",
|
||
LangPreferenceSet: "Language preference set to: %s",
|
||
}
|
||
|
||
// getInitMsg picks the zh/en TUI bundle; non-English falls back to zh.
|
||
func getInitMsg(lang i18n.Lang) *initMsg {
|
||
if lang.IsEnglish() {
|
||
return initMsgEn
|
||
}
|
||
return initMsgZh
|
||
}
|
||
|
||
// promptLangSelection shows the 中文/English picker and returns the chosen locale.
|
||
func promptLangSelection() (i18n.Lang, error) {
|
||
lang := i18n.LangZhCN
|
||
form := huh.NewForm(
|
||
huh.NewGroup(
|
||
huh.NewSelect[i18n.Lang]().
|
||
Title("Language / 语言").
|
||
Options(
|
||
huh.NewOption("中文", i18n.LangZhCN),
|
||
huh.NewOption("English", i18n.LangEnUS),
|
||
).
|
||
Value(&lang),
|
||
),
|
||
).WithTheme(cmdutil.ThemeFeishu())
|
||
|
||
if err := form.Run(); err != nil {
|
||
return "", err
|
||
}
|
||
return lang, nil
|
||
}
|
||
|
||
// langSelectionError maps a promptLangSelection failure to its exit surface:
|
||
// user abort exits bare with code 1; any other failure is internal.
|
||
func langSelectionError(err error) error {
|
||
if errors.Is(err, huh.ErrUserAborted) {
|
||
return output.ErrBare(1)
|
||
}
|
||
return errs.NewInternalError(errs.SubtypeUnknown, "language selection failed: %v", err).WithCause(err)
|
||
}
|