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(only bool) 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 ¶
View Source
const ( Name string = "Curator" // 程序名 Version string = "v0.11.4" // 程序版本 Project string = "github.com/yhyj/curator" // 项目地址 )
Variables ¶
View Source
var ( RegelarFormat = "%s\n" // 常规输出格式 常规输出: <输出内容> Regelar2PFormat = "%s%s\n" // 常规输出格式 常规输出·2部分: <输出内容1><输出内容2> TitleH1Format = "\n\x1b[36;3m%s\x1b[0m\n\n" // 标题输出格式 H1级别标题: <标题文字> LineHiddenFormat = "\x1b[30m%s\x1b[0m\n" // 分隔线输出格式 隐性分隔线: <分隔线> LineShownFormat = "\x1b[30m%s\x1b[0m\n" // 分隔线输出格式 显性分隔线: <分隔线> SliceTraverseFormat = "\x1b[32m%s\x1b[0m\n" // Slice输出格式 切片遍历: <切片内容> SliceTraverseSuffixFormat = "\x1b[32m%s\x1b[0m%s%s\n" // Slice输出格式 带后缀的切片遍历: <切片内容><分隔符><后缀> SliceTraverse2PFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m\n" // Slice输出格式 切片遍历·2部分: <切片内容1><分隔符><切片内容2> SliceTraverse2PNoNewLineFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m" // Slice输出格式 切片遍历·2部分·不换行: <切片内容1><分隔符><切片内容2> SliceTraverse2PSuffixFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s%s\n" // Slice输出格式 带后缀的切片遍历·2部分: <切片内容1><分隔符><切片内容2><分隔符><后缀> SliceTraverse2PSuffixNoNewLineFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s" // Slice输出格式 带后缀的切片遍历·2部分·不换行: <切片内容1><分隔符><切片内容2><后缀> SliceTraverse3PSuffixFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s\x1b[33m%s\x1b[0m%s%s\n" // Slice输出格式 带后缀的切片遍历·3部分: <切片内容1><分隔符><切片内容2><分隔符><切片内容3><分隔符><后缀> SliceTraverse4PFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s\x1b[33m%s\x1b[0m%s\x1b[35m%s\x1b[0m\n" // Slice输出格式 切片遍历·4部分: <切片内容1><分隔符><切片内容2><分隔符><切片内容3><分隔符><切片内容4> SliceTraverse4PSuffixFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s\x1b[33m%s\x1b[0m%s\x1b[35m%s\x1b[0m%s%s\n" // Slice输出格式 带后缀的切片遍历·4部分: <切片内容1><分隔符><切片内容2><分隔符><切片内容3><分隔符><切片内容4><分隔符><后缀> SliceTraverse5PFormat = "\x1b[32m%s\x1b[0m%s\x1b[34m%s\x1b[0m%s\x1b[33m%s\x1b[0m%s\x1b[33m%s\x1b[0m%s\x1b[35m%s\x1b[0m\n" // Slice输出格式 切片遍历·5部分: <切片内容1><分隔符><切片内容2><分隔符><切片内容3><分隔符><切片内容4><分隔符><切片内容5> AskFormat = "\x1b[34m%s\x1b[0m" // 问询信息输出格式 问询信息: <问询信息> SuccessFormat = "\x1b[32m%s\x1b[0m\n" // 成功信息输出格式 成功信息: <成功信息> SuccessDarkFormat = "\x1b[36m%s\x1b[0m\n" // 成功信息输出格式 暗色成功信息: <成功信息> SuccessNoNewLineFormat = "\x1b[32m%s\x1b[0m" // 成功信息输出格式 成功信息·不换行: <成功信息> SuccessBlueNoNewLineFormat = "\x1b[34m%s\x1b[0m" // 成功信息输出格式 蓝色成功信息·不换行: <成功信息> SuccessSuffixFormat = "\x1b[32m%s\x1b[0m%s%s\n" // 成功信息输出格式 带后缀的成功信息: <成功信息><分隔符><后缀> SuccessSuffixNoNewLineFormat = "\x1b[32m%s\x1b[0m%s%s" // 成功信息输出格式 带后缀的成功信息·不换行: <成功信息><分隔符><后缀> TipsPrefixFormat = "%s%s\x1b[32;1m%s\x1b[0m\n" // 提示信息输出格式 带前缀的提示信息: <前缀><分隔符><提示信息> TipsPrefixSuffixFormat = "%s%s\x1b[32;1m%s\x1b[0m%s%s\n" // 提示信息输出格式 带前后缀的提示信息: <前缀><分隔符><提示信息><分隔符><后缀> Tips2PSuffixNoNewLineFormat = "\x1b[32m%s\x1b[0m%s\x1b[36m%s\x1b[0m%s%s" // 提示信息输出格式 带后缀的提示信息·2部分·不换行: <提示信息1><分隔符><提示信息2><分隔符><后缀> InfoFormat = "\x1b[33m%s\x1b[0m\n" // 展示信息输出格式 展示信息: <展示信息> Info2PFormat = "\x1b[33m%s%s\x1b[0m\n" // 展示信息输出格式 展示信息·2部分: <展示信息> Info2PNoNewLineFormat = "\x1b[35m%s%s\x1b[0m" // 展示信息输出格式 展示信息·2部分·不换行: <展示信息> InfoPrefixFormat = "%s%s\x1b[33m%s\x1b[0m\n" // 展示信息输出格式 带前缀的展示信息: <前缀><分隔符><展示信息> Info2PPrefixFormat = "%s%s\x1b[33m%s\x1b[0m%s\x1b[35m%s\x1b[0m\n" // 展示信息输出格式 带前缀的展示信息·2部分: <前缀><分隔符><展示信息1><分隔符><展示信息2> InfoSuffixFormat = "\x1b[33m%s\x1b[0m%s%s\n" // 展示信息输出格式 带后缀的展示信息: <展示信息><分隔符><后缀> InfoPrefixSuffixFormat = "%s%s\x1b[33m%s\x1b[0m%s%s\n" // 展示信息输出格式 带前后缀的展示信息: <前缀><分隔符><展示信息><分隔符><后缀> InfoPrefixSuffixNoNewLineFormat = "%s%s\x1b[35m%s\x1b[0m%s%s" // 展示信息输出格式 带前后缀的展示信息·不换行: <前缀><分隔符><展示信息><分隔符><后缀> ErrorBaseFormat = "\x1b[31m%s\x1b[0m\n" // 错误信息输出格式 基础错误: <错误信息> ErrorPrefixFormat = "%s%s\x1b[31m%s\x1b[0m\n" // 错误信息输出格式 带前缀的错误: <前缀><分隔符><错误信息> ErrorSuffixFormat = "\x1b[31m%s\x1b[0m%s%s\n" // 错误信息输出格式 带后缀的错误: <错误信息><分隔符><后缀> )
View Source
var ( Run = "➤" Dot = "•" Yes = "✔" No = "✘" )
View Source
var ( GitCommitHash string = "Unknown" // git 提交 Hash BuildTime string = "Unknown" // 编译时间 BuildBy string = "Unknown" // 编译者 )
View Source
var Arch = runtime.GOARCH // 系统架构
View Source
var Platform = runtime.GOOS // 操作系统
View Source
var UserInfo, _ = GetUserInfoByName(UserName) // 用户信息
View Source
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 ¶
CompareFile 并发比较两个文件是否相同
参数：
- file1Path: 文件1路径
- file2Path: 文件2路径
返回：
- 文件相同返回 true，出错或不同返回 false
func CreateLocalBranch ¶
CreateLocalBranch 本地仓库根据远程分支创建本地分支
- 远程分支 refs/remotes/${remote}/<remoteBranchName>
- 本地分支 refs/heads/<localBranchName>
参数：
- repo: 本地仓库对象
- branchs: 远程分支信息
返回：
- 错误信息切片
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 ¶
GetRepoBranchInfo 获取本地仓库的[本地|远程]分支信息
参数：
- worktree: 仓库的 git 工作树对象
- which: 'local' or 'remote'，指定要获取的是本地分支还是远程分支
返回：
- 分支信息
- 错误信息
func PullRepo ¶ added in v0.11.0
func PullRepo(repo *git.Repository, publicKeys *ssh.PublicKeys) (worktree *git.Worktree, leftCommit, rightCommit *object.Commit, err error)
PullRepo 拉取远端仓库的更改到本地
参数：
- repo: 本地仓库对象
返回：
- 拉取到的更改的提交信息
- 错误信息
func RunCommandGetResult ¶
RunCommandGetResult 运行命令并返回命令的输出
参数：
- command: 命令
- args: 命令参数
返回：
- 命令的输出
- 错误信息
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.