Documentation
¶
Overview ¶
Package selfupdate handles installation detection, npm-based updates, skills updates, and platform-specific binary replacement for the CLI self-update flow.
Index ¶
- Constants
- func Truncate(s string, maxLen int) string
- type DetectResult
- type InstallMethod
- type NpmResult
- type Updater
- func (u *Updater) CanRestorePreviousVersion() bool
- func (u *Updater) CleanupStaleFiles()
- func (u *Updater) DetectInstallMethod() DetectResult
- func (u *Updater) FetchSkillsIndex(source string) *NpmResult
- func (u *Updater) InstallAllSkills(source string) *NpmResult
- func (u *Updater) InstallLocalSuite(path string) *NpmResult
- func (u *Updater) InstallSkills(source string, nameList []string) *NpmResult
- func (u *Updater) ListGlobalSkills() *NpmResult
- func (u *Updater) ListGlobalSkillsJSON() *NpmResult
- func (u *Updater) PrepareSelfReplace() (restore func(), err error)
- func (u *Updater) RemoveGlobalSkills(names []string) *NpmResult
- func (u *Updater) RunNpmInstall(version string) *NpmResult
- func (u *Updater) RunPnpmInstall(version string) *NpmResult
- func (u *Updater) SkillsSources() []string
- func (u *Updater) StageSuite(source, dir string) *NpmResult
- func (u *Updater) VerifyBinary(expectedVersion string) error
Constants ¶
const (
NpmPackage = "@larksuite/cli"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type DetectResult ¶
type DetectResult struct {
Method InstallMethod
ResolvedPath string
NpmAvailable bool
PnpmAvailable bool
}
DetectResult holds installation detection results.
func (DetectResult) CanAutoUpdate ¶
func (d DetectResult) CanAutoUpdate() bool
CanAutoUpdate returns true if the CLI can update itself automatically.
func (DetectResult) ManualReason ¶
func (d DetectResult) ManualReason() string
ManualReason returns a human-readable explanation of why auto-update is unavailable.
type InstallMethod ¶
type InstallMethod int
InstallMethod describes how the CLI was installed.
const ( InstallNpm InstallMethod = iota InstallPnpm InstallManual )
type NpmResult ¶
NpmResult holds the result of an npm install or skills update execution.
func (*NpmResult) CombinedOutput ¶
CombinedOutput returns stdout + stderr concatenated.
type Updater ¶
type Updater struct {
// Brand selects the skills index/source endpoints (zero value = feishu).
Brand core.LarkBrand
DetectOverride func() DetectResult
NpmInstallOverride func(version string) *NpmResult
PnpmInstallOverride func(version string) *NpmResult
SkillsIndexFetchOverride func() *NpmResult
SkillsCommandOverride func(args ...string) *NpmResult
SkillsCommandInDirOverride func(dir string, args ...string) *NpmResult
VerifyOverride func(expectedVersion string) error
RestoreAvailableOverride func() bool
// contains filtered or unexported fields
}
Updater manages self-update operations. Platform-specific methods (PrepareSelfReplace, CleanupStaleFiles) are in updater_unix.go and updater_windows.go.
Override DetectOverride / NpmInstallOverride / SkillsCommandOverride / VerifyOverride / RestoreAvailableOverride for testing.
func (*Updater) CanRestorePreviousVersion ¶
CanRestorePreviousVersion reports whether PrepareSelfReplace created a restorable backup for the current update attempt.
func (*Updater) CleanupStaleFiles ¶
func (u *Updater) CleanupStaleFiles()
CleanupStaleFiles is a no-op on Unix (no .old files are created).
func (*Updater) DetectInstallMethod ¶
func (u *Updater) DetectInstallMethod() DetectResult
DetectInstallMethod determines how the CLI was installed and whether the owning package manager is available for auto-update.
func (*Updater) FetchSkillsIndex ¶ added in v1.0.88
func (*Updater) InstallAllSkills ¶ added in v1.0.41
func (*Updater) InstallLocalSuite ¶ added in v1.0.88
func (*Updater) InstallSkills ¶ added in v1.0.88
func (*Updater) ListGlobalSkills ¶ added in v1.0.35
func (*Updater) ListGlobalSkillsJSON ¶ added in v1.0.48
func (*Updater) PrepareSelfReplace ¶
PrepareSelfReplace is a no-op on Unix. Unix allows overwriting a running executable via inode semantics.
func (*Updater) RemoveGlobalSkills ¶ added in v1.0.88
func (*Updater) RunNpmInstall ¶
RunNpmInstall executes npm install -g @larksuite/cli@<version>.
func (*Updater) RunPnpmInstall ¶ added in v1.0.66
RunPnpmInstall executes pnpm add -g @larksuite/cli@<version>.
func (*Updater) SkillsSources ¶ added in v1.0.88
SkillsSources returns the brand-specific v0.2 source first, followed by the other brand's source. Falling back must not change the configured brand.
func (*Updater) StageSuite ¶ added in v1.0.88
func (*Updater) VerifyBinary ¶
VerifyBinary checks that the installed binary reports the expected version by running "lark-cli --version" and comparing the version token exactly. Output format is "lark-cli version X.Y.Z"; the last field is extracted and compared against expectedVersion (both stripped of any "v" prefix).
Source Files