general

Documentation

Index

• Constants
• Variables
• func CloneRepoViaSSH(repoPath, URL, username, repoName string, publicKeys *ssh.PublicKeys) (*git.Repository, error)
• func CompareFile(file1Path string, file2Path string) (bool, error)
• func CreateDir(dirPath string) error
• func CreateFile(filePath string) error
• func CreateLocalBranch(repo *git.Repository, branchs []fs.FileInfo) []string
• func Delay(second float32)
• func DeleteFile(filePath string) error
• func FileEmpty(filePath string) bool
• func FileExist(filePath string) bool
• func FolderEmpty(filePath string) bool
• func GetAbsPath(filePath string) string
• func GetCurrentUserInfo() (*user.User, error)
• func GetHostname() string
• func GetLocalRepoSubmoduleInfo(worktree *git.Worktree) (git.Submodules, error)
• func GetPublicKeysByGit(pemFile string) (*ssh.PublicKeys, error)
• func GetPublicKeysBySSH(pemFile string) (transport.AuthMethod, error)
• func GetRepoBranchInfo(worktree *git.Worktree, which string) ([]fs.FileInfo, error)
• func GetUserInfoById(userId int) (*user.User, error)
• func GetUserInfoByName(userName string) (*user.User, error)
• func GetVariable(key string) string
• func GoToDir(dirPath string) error
• func IsLocalRepo(path string) (bool, *git.Repository)
• func ProgramInfo() map[string]string
• func PullRepo(repo *git.Repository, publicKeys *ssh.PublicKeys) (worktree *git.Worktree, leftCommit, rightCommit *object.Commit, err error)
• func ReadFileCount(file, key string) int
• func ReadFileKey(file, key string) string
• func ReadFileLine(file string, line int) string
• func RunCommand(command string, args []string) error
• func RunCommandGetResult(command string, args []string) (string, error)
• func SetVariable(key, value string) error
• func WriteFile(filePath string, content string) error

Constants

const (
	Name    string = "Curator"                 // 程序名
	Version string = "v0.12.4"                 // 程序版本
	Project string = "github.com/yhyj/curator" // 项目地址
)

Variables

var (
	FgBlack   = color.FgBlack.Render   // 前景色 - 黑色
	FgWhite   = color.FgWhite.Render   // 前景色 - 白色
	FgGray    = color.FgGray.Render    // 前景色 - 灰色
	FgRed     = color.FgRed.Render     // 前景色 - 红色
	FgGreen   = color.FgGreen.Render   // 前景色 - 绿色
	FgYellow  = color.FgYellow.Render  // 前景色 - 黄色
	FgBlue    = color.FgBlue.Render    // 前景色 - 蓝色
	FgMagenta = color.FgMagenta.Render // 前景色 - 品红
	FgCyan    = color.FgCyan.Render    // 前景色 - 青色

	BgBlack   = color.BgBlack.Render   // 背景色 - 黑色
	BgWhite   = color.BgWhite.Render   // 背景色 - 白色
	BgGray    = color.BgGray.Render    // 背景色 - 灰色
	BgRed     = color.BgRed.Render     // 背景色 - 红色
	BgGreen   = color.BgGreen.Render   // 背景色 - 绿色
	BgYellow  = color.BgYellow.Render  // 背景色 - 黄色
	BgBlue    = color.BgBlue.Render    // 背景色 - 蓝色
	BgMagenta = color.BgMagenta.Render // 背景色 - 品红
	BgCyan    = color.BgCyan.Render    // 背景色 - 青色

	InfoText      = color.Info.Render      // Info 文本
	NoteText      = color.Note.Render      // Note 文本
	LightText     = color.Light.Render     // Light 文本
	ErrorText     = color.Error.Render     // Error 文本
	DangerText    = color.Danger.Render    // Danger 文本
	NoticeText    = color.Notice.Render    // Notice 文本
	SuccessText   = color.Success.Render   // Success 文本
	CommentText   = color.Comment.Render   // Comment 文本
	PrimaryText   = color.Primary.Render   // Primary 文本
	WarnText      = color.Warn.Render      // Warn 文本
	QuestionText  = color.Question.Render  // Question 文本
	SecondaryText = color.Secondary.Render // Secondary 文本
)

var (
	RunFlag        = "🐙"  // 运行状态符号 - 运行中
	UnmodifiedFlag = "•"  // 运行状态符号 - 未修改
	SuccessFlag    = "✅"  // 运行状态符号 - 成功
	WarningFlag    = "⚠️" // 运行状态符号 - 警告
	ErrorFlag      = "❌"  // 运行状态符号 - 失败
)

var (
	BranchFlag    = "🌿" // Git 符号 - 分支
	SubmoduleFlag = "📦" // Git 符号 - 子模块
)

var (
	JoinerIng    = "├──" // 条目连接符号 - 中间条目
	JoinerFinish = "└──" // 条目连接符号 - 最后条目
)

var (
	GitCommitHash string = "Unknown" // Git 提交 Hash
	BuildTime     string = "Unknown" // 编译时间
	BuildBy       string = "Unknown" // 编译者
)

var Arch = runtime.GOARCH // 系统架构

var Platform = runtime.GOOS // 操作系统

var UserInfo, _ = GetUserInfoByName(UserName) // 用户信息

var UserName = func() string {
	if GetVariable("SUDO_USER") != "" {
		return GetVariable("SUDO_USER")
	}
	return GetVariable("USER")
}()

用户名，当程序提权运行时，使用 SUDO_USER 变量获取提权前的用户名

Functions

func CloneRepoViaSSH

func CloneRepoViaSSH(repoPath, URL, username, repoName string, publicKeys *ssh.PublicKeys) (*git.Repository, error)

CloneRepoViaSSH 使用 SSH 协议将远端仓库克隆到本地

参数：

• repoPath: 本地仓库路径
• URL: 远端仓库地址（仅包括主地址，例如：github.com）
• username: 远端仓库用户名
• repoName: 远端仓库名称
• publicKeys: ssh 公钥

返回：

• 本地仓库对象
• 错误信息

func CompareFile

func CompareFile(file1Path string, file2Path string) (bool, error)

CompareFile 并发比较两个文件是否相同

参数：

• file1Path: 文件1路径
• file2Path: 文件2路径

返回：

• 文件相同返回 true，出错或不同返回 false

func CreateDir

func CreateDir(dirPath string) error

CreateDir 创建文件夹

参数：

• dirPath: 文件夹路径

返回：

• 错误信息

func CreateFile

func CreateFile(filePath string) error

CreateFile 创建文件，包括其父目录

参数：

• filePath: 文件路径

返回：

• 错误信息

func CreateLocalBranch

func CreateLocalBranch(repo *git.Repository, branchs []fs.FileInfo) []string

CreateLocalBranch 本地仓库根据远程分支创建本地分支

• 远程分支 refs/remotes/${remote}/<remoteBranchName>
• 本地分支 refs/heads/<localBranchName>

参数：

• repo: 本地仓库对象
• branchs: 远程分支信息

返回：

• 错误信息切片

func Delay

func Delay(second float32)

Delay 延时

参数：

• second: 延时秒数

func DeleteFile

func DeleteFile(filePath string) error

DeleteFile 删除文件

参数：

• filePath: 文件路径

返回：

• 错误信息

func FileEmpty

func FileEmpty(filePath string) bool

FileEmpty 判断文件是否为空

• 无法判断文件夹

参数：

• filePath: 文件路径

返回：

• 文件为空返回 true，否则返回 false

func FileExist

func FileExist(filePath string) bool

FileExist 判断文件是否存在

参数：

• filePath: 文件路径

返回：

• 文件存在返回 true，否则返回 false

func FolderEmpty

func FolderEmpty(filePath string) bool

FolderEmpty 判断文件夹是否为空

• 包括隐藏文件

参数：

• filePath: 文件夹路径

返回：

• 文件夹为空返回 true，否则返回 false

func GetAbsPath

func GetAbsPath(filePath string) string

GetAbsPath 获取指定文件的绝对路径

参数：

• filePath: 文件路径

返回：

• 文件的绝对路径

func GetCurrentUserInfo

func GetCurrentUserInfo() (*user.User, error)

GetCurrentUserInfo 获取当前用户信息

返回：

• 用户信息
• 错误信息

func GetHostname

func GetHostname() string

GetHostname 获取系统 HOSTNAME

返回：

• HOSTNAME 或空字符串

func GetLocalRepoSubmoduleInfo

func GetLocalRepoSubmoduleInfo(worktree *git.Worktree) (git.Submodules, error)

GetLocalRepoSubmoduleInfo 获取本地仓库子模块信息

参数：

• worktree: 仓库的 git 工作树对象

返回：

• 子模块信息
• 错误信息

func GetPublicKeysByGit

func GetPublicKeysByGit(pemFile string) (*ssh.PublicKeys, error)

GetPublicKeysByGit 使用 go-git 自带的方法获取 ssh 公钥

参数：

• pemFile: 私钥文件路径

返回：

• ssh 公钥
• 错误信息

func GetPublicKeysBySSH

func GetPublicKeysBySSH(pemFile string) (transport.AuthMethod, error)

GetPublicKeysBySSH 使用 crypto/ssh 模块获取 ssh 公钥

参数：

• pemFile: 私钥文件路径

返回：

• ssh 公钥
• 错误信息

func GetRepoBranchInfo

func GetRepoBranchInfo(worktree *git.Worktree, which string) ([]fs.FileInfo, error)

GetRepoBranchInfo 获取本地仓库的[本地|远程]分支信息

参数：

• worktree: 仓库的 git 工作树对象
• which: 'local' or 'remote'，指定要获取的是本地分支还是远程分支

返回：

• 分支信息
• 错误信息

func GetUserInfoById

func GetUserInfoById(userId int) (*user.User, error)

GetUserInfoById 根据 ID 获取用户信息

参数：

• userId: 用户 ID

返回：

• 用户信息
• 错误信息

func GetUserInfoByName

func GetUserInfoByName(userName string) (*user.User, error)

GetUserInfoByName 根据用户名获取用户信息

参数：

• userName: 用户名

返回：

• 用户信息
• 错误信息

func GetVariable

func GetVariable(key string) string

GetVariable 获取环境变量

参数：

• key: 变量名

返回：

• 变量值

func GoToDir

func GoToDir(dirPath string) error

GoToDir 进到指定文件夹

参数：

• dirPath: 文件夹路径

返回：

• 错误信息

func IsLocalRepo

func IsLocalRepo(path string) (bool, *git.Repository)

IsLocalRepo 检测是不是本地仓库，是的话返回本地仓库对象

参数：

• path: 本地仓库路径

返回：

• 是否本地仓库
• 本地仓库对象

func ProgramInfo

func ProgramInfo() map[string]string

ProgramInfo 返回程序信息

返回：

• 程序信息

func PullRepo

func PullRepo(repo *git.Repository, publicKeys *ssh.PublicKeys) (worktree *git.Worktree, leftCommit, rightCommit *object.Commit, err error)

PullRepo 拉取远端仓库的更改到本地

参数：

• repo: 本地仓库对象

返回：

• 拉取到的更改的提交信息
• 错误信息

func ReadFileCount

func ReadFileCount(file, key string) int

ReadFileCount 获取文件包含关键字的行的计数

参数：

• file: 文件路径
• key: 关键字

返回：

• 包含关键字的行的数量

func ReadFileKey

func ReadFileKey(file, key string) string

ReadFileKey 读取文件包含关键字的行

参数：

• file: 文件路径
• key: 关键字

返回：

• 包含关键字的行的内容

func ReadFileLine

func ReadFileLine(file string, line int) string

ReadFileLine 读取文件指定行

参数：

• file: 文件路径
• line: 行号

返回：

• 指定行的内容

func RunCommand

func RunCommand(command string, args []string) error

RunCommand 运行命令不返回命令的输出

参数：

• command: 命令
• args: 命令参数

返回：

• 错误信息

func RunCommandGetResult

func RunCommandGetResult(command string, args []string) (string, error)

RunCommandGetResult 运行命令并返回命令的输出

参数：

• command: 命令
• args: 命令参数

返回：

• 命令的输出
• 错误信息

func SetVariable

func SetVariable(key, value string) error

SetVariable 设置环境变量

参数：

• key: 变量名
• value: 变量值

返回：

• 错误信息

func WriteFile

func WriteFile(filePath string, content string) error

WriteFile 写入内容到文件

参数：

• filePath: 文件路径
• content: 内容

返回：

• 错误信息