# Functions
AskUser 询问用户
参数: - question: 问题 - standardAnswers: 期望回答的切片(最后一个选项是默认值),例如 [y, N] 代表期望输入 y 或 n,最后一个选项是默认值(大写为了提示用户其为默认值)
返回: - 回答 - 错误信息.
CheckoutBranch 切换到指定分支
参数: - worktree: 存储库的 git 工作树对象 - branchName: 分支名
返回: - 错误信息.
CloneRepoViaSSH 使用 SSH 协议将远端存储库克隆到本地
参数: - repoPath: 本地存储库路径 - URL: 远端存储库地址(仅包括主地址,例如:github.com) - username: 远端存储库用户名 - repoName: 远端存储库名称 - publicKeys: ssh 公钥
返回: - 本地存储库对象 - 错误信息.
CreateFile 创建文件,包括其父目录
参数: - file: 文件路径
返回: - 错误信息.
CreateLocalBranch 本地存储库根据远程分支创建本地分支
- 远程分支 refs/remotes/${remote}/<remoteBranchName> - 本地分支 refs/heads/<localBranchName>
参数: - repo: 本地存储库对象 - branchs: 远程分支信息
返回: - 错误信息切片.
Delay 延时
参数: - second: 延时秒数.
DeleteFile 删除文件,如果目标是文件夹则包括其下所有文件
参数: - filePath: 文件路径
返回: - 错误信息.
FileExist 判断文件是否存在
参数: - filePath: 文件路径
返回: - 文件存在返回 true,否则返回 false.
FolderEmpty 判断文件夹是否为空
- 包括隐藏文件
参数: - dir: 文件夹路径
返回: - 文件夹为空返回 true,否则返回 false.
GetCallerInfo 获取调用者信息
返回: - 调用者所在文件名(不带后缀) - 调用者所在行号.
GetCurrentUserInfo 获取当前用户信息
返回: - 用户信息 - 错误信息.
GetDefaultBranchName 获取默认分支名
参数: - repo: 本地存储库对象 - publicKeys: ssh 公钥
返回: - 默认分支名 - 错误信息切片.
GetHostname 获取系统 HOSTNAME
返回: - HOSTNAME 或空字符串.
GetLanguage 获取系统语言
返回: - 系统语言,目前仅支持 zh 或 en.
GetLocalRepoSubmoduleInfo 获取本地存储库子模块信息
参数: - worktree: 存储库的 git 工作树对象
返回: - 子模块信息 - 错误信息.
GetPublicKeysByGit 使用 go-git 自带的方法获取 ssh 公钥
参数: - pemFile: 私钥文件路径
返回: - ssh 公钥 - 错误信息.
GetPublicKeysBySSH 使用 crypto/ssh 模块获取 ssh 公钥
参数: - pemFile: 私钥文件路径
返回: - ssh 公钥 - 错误信息.
GetRepoBranchInfo 获取本地存储库的[本地|远程]分支信息
参数: - worktree: 存储库的 git 工作树对象 - isSubmodule: 该存储库是否作为子模块 - submoduleName: 当该存储库作为子模块时需要存储库名 - which: 'local' or 'remote',指定要获取的是本地分支还是远程分支
返回: - 分支信息 - 错误信息.
GetRepoHeadRef 获取本地存储库对象 HEAD 指向的引用
参数: - repo: 本地存储库对象
返回: - HEAD 引用.
GetTomlConfig 读取 toml 配置文件
参数: - filePath: toml 配置文件路径
返回: - toml 配置树 - 错误信息.
GetUserInfoById 根据 ID 获取用户信息
参数: - userId: 用户 ID
返回: - 用户信息 - 错误信息.
GetUserInfoByName 根据用户名获取用户信息
参数: - userName: 用户名
返回: - 用户信息 - 错误信息.
GetVariable 获取环境变量
参数: - key: 变量名
返回: - 变量值.
IsLocalRepo 检测是不是本地存储库,是的话返回本地存储库对象及其 HEAD 指向的引用
参数: - path: 本地存储库路径
返回: - 是否本地存储库 - 本地存储库对象 - HEAD 引用.
LoadConfigToStruct 将 Toml 配置树加载到结构体
参数: - configTree: 解析 toml 配置文件得到的配置树
返回: - 结构体 - 错误信息.
ModifyGitConfig 修改 .git/config 文件,确保 [remote "origin"] 的 url 字段是以 'git@' 开头,并添加两行 pushurl
参数: - configFile: .git/config 文件路径 - originalLink: 需要替换的原始链接 - newLink: 替换上去的新链接
返回: - 错误信息.
MultipleSelectionFilter 多选筛选器,接受一个可选项切片,返回一个已选项切片,允许全选
参数: - choices: 可选项 - highlights: 高亮项 - negatives: 希望选择器在运行后输出的信息
返回: - 已选项 - 错误信息.
Notification 显示通知.
ProgramInfo 返回程序信息
返回: - 程序信息.
PullRepo 拉取远端存储库的更改到本地
参数: - repo: 本地存储库对象
返回: - 存储库的 git 工作树对象 - 拉取前本地最新 Commit 的 Hash 值 - 拉取后本地最新 Commit 的 Hash 值 - 错误信息.
RunCommandToBuffer 运行命令,将命令的 Stdout 和 Stderr 定向到字节缓冲区
- 命令的 Stdout 和 Stderr 末尾自带的换行符已去除
参数: - command: 命令 - args: 命令参数(每个以空格分隔的参数作为切片的一个元素)
返回: - Stdout 缓冲区内容 - Stderr 缓冲区内容 - 错误信息.
RunCommandToOS 运行命令,将命令的 Stdin, Stdout 和 Stderr 定向到系统标准输入、标准输出和标准错误
参数: - command: 命令 - args: 命令参数(每个以空格分隔的参数作为切片的一个元素)
返回: - 错误信息.
SetVariable 设置环境变量
参数: - key: 变量名 - value: 变量值
返回: - 错误信息.
UpperFirstChar 最大化字符串的第一个字母
参数: - str: 需要处理的字符串
返回: - 处理后的字符串.
WriteTomlConfig 写入 toml 配置文件
参数: - filePath: toml 配置文件路径
返回: - 写入的字节数 - 错误信息.
# Variables
系统架构.
背景色 - 黑色.
背景色 - 蓝色.
背景色 - 青色.
背景色 - 灰色.
背景色 - 绿色.
背景色 - 亮蓝色.
背景色 - 亮青色.
背景色 - 亮绿色.
背景色 - 亮品红.
背景色 - 亮红色.
背景色 - 亮白色.
背景色 - 亮黄色.
背景色 - 品红.
背景色 - 红色.
背景色 - 白色.
背景色 - 黄色.
Git 符号 - 分支.
编译者.
编译时间.
Comment 文本.
配置文件路径.
选择器符号 - 光标不在.
选择器符号 - 光标所在.
Danger 文本.
默认延时.
运行状态符号 - 失败.
身份符号 - 报错信息.
Error 文本.
前景色 - 黑色.
前景色 - 蓝色.
前景色 - 青色.
前景色 - 灰色.
前景色 - 绿色.
前景色 - 亮蓝色.
前景色 - 亮青色.
前景色 - 亮绿色.
前景色 - 亮品红.
前景色 - 亮红色.
前景色 - 亮白色.
前景色 - 亮黄色.
前景色 - 品红.
前景色 - 红色.
前景色 - 白色.
前景色 - 黄色.
Git 提交 Hash.
分隔符 - 指示器.
Info 文本.
条目连接符号 - 最后条目.
条目连接符号 - 中间条目.
提示词 - 按键.
系统语言.
运行状态符号 - 已是最新.
Light 文本.
标识符号 - 代表未实现.
提示词 - 多选.
标识符号 - 代表已实现.
Note 文本.
Notice 文本.
通知器.
提示词 - 文件已存在是否覆写.
操作系统.
Primary 文本.
Question 文本.
运行状态符号 - 运行中.
Secondary 文本.
选择器符号 - 全选.
提示词 - 全选.
选择器符号 - 已选中.
路径分隔符.
分隔符 - 1级.
分隔符 - 2级.
分隔符 - 3级.
分隔符基础长度.
提示词 - 单选.
Git 符号 - 子模块.
运行状态符号 - 成功.
Success 文本.
选择器符号 - 已选中.
用户信息.
用户名,当程序提权运行时,使用 SUDO_USER 变量获取提权前的用户名.
等待动画.
运行状态符号 - 警告.
Warn 文本.
# Structs
用于转换 Toml 配置树的结构体.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author