sofa-git-helper v1.0.0

sofa-git

封装了sofa中所有与git打交道的方式方法

checkGitInstall

• 功能：检查Git是否安装;
• 参数：无
• 返回：{boolean} 是否安装
• 示例：checkGitInstall();

checkGitLogin

• 功能：检测用户是否登录
• 参数：无
• 返回：{boolean} userGitInfo 是否登录
• 示例：checkGitLogin();

getGitUserInfo

• 功能：收集Git登录用户信息
• 参数：无
• 返回：{object || null} userGitInfo 用户信息
• 示例：getGitUserInfo();

checkAndLinkedSubmodule

• 功能：检查模板中是否存在子模块,如若存在，则需要将子模块重新关联至新⽣成项⽬，并将⼦模块代码拉取⾄本地。
• 返回：{boolean} 是否成功
• 实现：检查 .gitsubmodule
• checkAndLinkedSubmodule();

gitClone

• 功能：克隆某个仓库的、某个版本(某个tag)的代码，在存在⼦模块的情况下，将子模块代码完成初始化
• 参数1：{string} rep 需要克隆的git仓库地址
• 参数2：{string} tag git tag
• 返回：{boolean | string} success 返回true 或返回错误信息（如:缺失tag字段）
• 实现：git clone; 检测是否存在子模块； git install
• 示例：gitClone();

resetAsNewGit

• 功能：重新初始化为⼀个Git为空的新仓库
• 返回：{boolean | string} success 返回true 或返回错误信息（如:缺失tag字段）

setGitTag

• 功能：对于publish、update等进行写模板的操作，需要每次运行时，针对版本打Tag;
• 参数1：{string} tag git tag
• 返回：{boolean | string} success 返回true 或返回错误信息
• 实现：git tag -a v1.0 （ -a 选项意为"创建一个带注解的标签"）
• 示例：setGitTag('v1.0.1'');

checkGitClean

• 功能：检查当前仓库是否clean
• 返回：{boolean} 是否clean
• 示例：checkGitClean();

getGitRemote

• 功能：获取远程仓库地址
• 返回：{string} 远程仓库地址
• 示例：getGitRemote();

缺少story2:添加子模块等子模块相关内容