devbox
Cpp五条
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

git submodule使用 解决同频操作分支难点_git submodule branch

作者：Cpp五条 | 2024-04-20 21:00:32

赞

踩

git submodule branch


git submodule、git subtree 介绍及差异见：  submodule、subtree方案详解
 

一、子仓库难点，分支操作不同频

        子仓库分支与主仓库分支不会主动关联，不便管理，开发中需要较为小心
 

二、解决方式        

         增加node脚本，支持主仓库子仓库同频分支操作，保证主、子分支的一致性

        

三、同频操作分支源码及使用介绍
 

  •  介绍

    支持分支创建、切换、合并、拉取、创建Tags的同频操作
     

  • 操控面板

    ​

  • 脚本目录结构

    ​

  •  ⚠️使用步骤

    • 初始化子仓库
      git submodule add [子仓库git地址]

    • 增加packagen.json的script配置

      1. "scripts": {
      2.     "branch": "node bin/branch.js"
      3.  },

    • 修改bin/branchMode/index.js 内的submoduleName变量
      替换为子仓库的文件夹名称

    • 运行脚本

      npm run branch

  • bin/branch.js

    1. /**
    2.  * 用于主仓库 & 子仓库 的分支同步
    3.  */
    4.  
    5. const {
    6.   checkGitStatus,
    7.   slcBranchType,
    8.   BRANCH_CHECKOUT_TYPE
    9. } = require('./branchMode/index')
    10. const createBranch = require('./branchMode/createBranch.js')
    11. const toggleBranch = require('./branchMode/toggleBranch.js')
    12. const mergeBranch = require('./branchMode/mergeBranch.js')
    13. const pullBranch = require('./branchMode/pullBranch.js')
    14. const createBranchTags = require('./branchMode/createBranchTags.js')
    15.  
    16. /**
    17.  * 二、branch操作
    18.  */
    19. const main = async() => {
    20.   // 工作空间干净才允许执行操作
    21.   await checkGitStatus()
    22.   // git操作类型选择
    23.   const featType = await slcBranchType()
    24.   switch (featType) {
    25.     // 创建
    26.     case BRANCH_CHECKOUT_TYPE.create:
    27.       createBranch()
    28.       break
    29.     // 切换
    30.     case BRANCH_CHECKOUT_TYPE.toggle:
    31.       toggleBranch()
    32.       break
    33.     // 合并
    34.     case BRANCH_CHECKOUT_TYPE.merge:
    35.       mergeBranch()
    36.       break
    37.     // 拉取
    38.     case BRANCH_CHECKOUT_TYPE.pull:
    39.       pullBranch()
    40.       break
    41.     // 创建Tags
    42.     case BRANCH_CHECKOUT_TYPE.pushTags:
    43.       createBranchTags()
    44.       break
    45.     default:
    46.       break
    47.   }
    48. }
    49.  
    50. module.exports = main()

  • bin/util.js

    1. const inquirer = require('inquirer')
    2. const execa = require('execa')
    3.  
    4. function log() {
    5.   const str = [...arguments].join(', ')
    6.   console.warn(
    7.     `\n\u001b[33m ${str} \u001b[39m\n`
    8.   )
    9. }
    10.  
    11. function logGreen() {
    12.   const str = [...arguments].join(', ')
    13.   console.warn(
    14.     `\n\u001b[32m ${str} \u001b[0m\n`
    15.   )
    16. }
    17.  
    18. function inputPrompt(msg, backup = null) {
    19.   return inquirer.prompt([{
    20.     name: 'detail',
    21.     type: 'input',
    22.     default: backup,
    23.     message: msg
    24.   }]).then(({ detail }) => detail)
    25. }
    26.  
    27. function confirmPrompt(msg, backup = true) {
    28.   return inquirer.prompt([{
    29.     name: 'yes',
    30.     type: 'confirm',
    31.     default: backup,
    32.     message: msg
    33.   }]).then(({ yes }) => yes)
    34. }
    35.  
    36. function selectPrompt(msg, list = [], backup = 0) {
    37.   return inquirer.prompt([{
    38.     name: 'select',
    39.     type: 'list',
    40.     choices: [
    41.       new inquirer.Separator(' '),
    42.       ...list,
    43.       new inquirer.Separator(' ')
    44.     ],
    45.     default: backup,
    46.     message: msg
    47.   }]).then(({ select }) => select)
    48. }
    49.  
    50. /**
    51.  * 获取本地分支列表
    52.  * @param {Boolean} isOrigin 查看远程分支
    53.  * @param {String} cwd 执行路径
    54.  * @returns branchList
    55.  */
    56. const getBranchList = async(isOrigin = false, cwd = '') => {
    57.   if (isOrigin) await execa.command('git fetch origin', { ...(cwd ? { cwd } : {}) })
    58.   const currentBranch = execa.commandSync('git rev-parse --abbrev-ref HEAD', { ...(cwd ? { cwd } : {}) }).stdout
    59.   let branchList = execa.commandSync(`git branch ${isOrigin ? '-r' : ''}`, { ...(cwd ? { cwd } : {}) }).stdout
    60.   branchList = branchList.split('\n').map(item => {
    61.     return item.split(' ').slice(-1)[0]
    62.   })
    63.   branchList = branchList.filter(item => item !== currentBranch)
    64.   return branchList
    65. }
    66.  
    67. const returnLog = (text = '') => {
    68.   log(text)
    69.   process.exit()
    70. }
    71.  
    72. // 同步for运行Command
    73. const awaitForCommand = async(commandList = []) => {
    74.   for (let i = 0; i < commandList.length; i++) {
    75.     const item = commandList[i]
    76.     await execa.command(item[0], { ...(item[1] ? { cwd: item[1] } : {}) })
    77.   }
    78. }
    79.  
    80. /**
    81.  * 查看文件修改状态
    82.  * @param {String} type 指定类型
    83.  */
    84. const getStatusList = (type = '') => {
    85.   let statusList = execa.commandSync('git status -s').stdout
    86.   statusList = statusList.split('\n').map(item => {
    87.     return item.split(' ').filter(item => item)
    88.   })
    89.   if (type) {
    90.     statusList = statusList.filter(item => {
    91.       return item?.[0]?.toUpperCase() === type.toUpperCase()
    92.     })
    93.   }
    94.   return statusList
    95. }
    96.  
    97. module.exports = {
    98.   log,
    99.   logGreen,
    100.   inputPrompt,
    101.   confirmPrompt,
    102.   selectPrompt,
    103.   getBranchList,
    104.   returnLog,
    105.   awaitForCommand,
    106.   getStatusList
    107. }

  • bin/branchMode/index.js

    1. const execa = require('execa')
    2. const {
    3.   selectPrompt,
    4.   returnLog
    5. } = require('../util')
    6.  
    7. // 子仓库目录
    8. const submoduleName = 'child-ui'
    9.  
    10. // 当前分支
    11. const currentBranch = execa.commandSync('git rev-parse --abbrev-ref HEAD').stdout
    12.  
    13. // 分支切换类型
    14. const BRANCH_CHECKOUT_TYPE = {
    15.   create: 1,
    16.   toggle: 2,
    17.   merge: 3,
    18.   pull: 4,
    19.   pushTags: 5
    20. }
    21.  
    22. // 枚举是否
    23. const ISOK_ENMU = {
    24.   yes: 1,
    25.   no: 2
    26. }
    27.  
    28. // 选择是否
    29. const ISOK_OPTIONS = [
    30.   { name: '是', value: ISOK_ENMU.yes },
    31.   { name: '否', value: ISOK_ENMU.no }
    32. ]
    33.  
    34. // （1）、检测当前工作空间是否有未提交的文件
    35. const checkGitStatus = async() => {
    36.   const gitStatus = await execa.command('git status')
    37.   if (!gitStatus.stdout.includes('nothing to commit')) {
    38.     returnLog('检测到主仓库代码未提交, 请自行检查！')
    39.   }
    40.   const childStatus = await execa.command('git status', { cwd: `./${submoduleName}` })
    41.   if (!childStatus.stdout.includes('nothing to commit')) {
    42.     returnLog('检测到子仓库代码未提交, 请自行检查！')
    43.   }
    44. }
    45.  
    46. // （2）、选择分支操作类型
    47. const slcBranchType = async() => {
    48.   const selectProjectName = await selectPrompt('branch操作类型选择',
    49.     [
    50.       { name: '创建', value: BRANCH_CHECKOUT_TYPE.create },
    51.       { name: '切换', value: BRANCH_CHECKOUT_TYPE.toggle },
    52.       { name: '合并', value: BRANCH_CHECKOUT_TYPE.merge },
    53.       { name: '拉取', value: BRANCH_CHECKOUT_TYPE.pull },
    54.       ...(
    55.         currentBranch === 'master' ? [{ name: '创建Tags', value: BRANCH_CHECKOUT_TYPE.pushTags }] : []
    56.       )
    57.     ]
    58.   )
    59.   return selectProjectName
    60. }
    61.  
    62. // (3)、子分支切换 & pull
    63. const toggleChildBranch = async(customBranch = currentBranch) => {
    64.   const childBranch = execa.commandSync('git rev-parse --abbrev-ref HEAD', { cwd: `./${submoduleName}` }).stdout
    65.   if (childBranch !== customBranch) {
    66.     await execa.command(`git checkout ${customBranch}`, { cwd: `./${submoduleName}` })
    67.   }
    68.   await execa.command('git pull', { cwd: `./${submoduleName}` })
    69. }
    70.  
    71. module.exports = {
    72.   submoduleName,
    73.   currentBranch,
    74.   BRANCH_CHECKOUT_TYPE,
    75.   ISOK_ENMU,
    76.   ISOK_OPTIONS,
    77.   checkGitStatus,
    78.   slcBranchType,
    79.   toggleChildBranch
    80. }

  •  bin/branchMode/createBranch.js

    1. /**
    2.  * 创建分支（主 + 子）
    3.  */
    4. const {
    5.   logGreen,
    6.   inputPrompt,
    7.   getBranchList,
    8.   returnLog,
    9.   awaitForCommand
    10. } = require('../util')
    11. const {
    12.   submoduleName,
    13.   checkGitStatus,
    14.   toggleChildBranch
    15. } = require('./index')
    16.  
    17. const createBranch = async() => {
    18.   // (1) 子分支切换 & pull
    19.   await toggleChildBranch()
    20.   // (1.1) 主pull
    21.   await awaitForCommand([['git pull']])
    22.   // (2) 检测暂存区
    23.   await checkGitStatus()
    24.   // (3) 输入分支名
    25.   const createName = await inputPrompt(`请输入分支名：`)
    26.   if (!createName) return
    27.   const localBranchList = await getBranchList()
    28.   if (localBranchList.includes(createName)) {
    29.     returnLog('分支已存在')
    30.   }
    31.   // (4) 创建主分支
    32.   const parentOriginList = await getBranchList(true)
    33.   // (4.1) 远程分支存在，创建本地 & 关联远程
    34.   if (parentOriginList.includes(`origin/${createName}`)) {
    35.     await awaitForCommand([[`git checkout -b ${createName} origin/${createName}`]])
    36.   // (4.2) 创建分支 & 推至远程
    37.   } else {
    38.     await awaitForCommand([
    39.       [`git checkout -b ${createName}`],
    40.       [`git push --set-upstream origin ${createName}`]
    41.     ])
    42.   }
    43.   // (5) 创建子分支
    44.   const childLocalList = await getBranchList(false, `./${submoduleName}`)
    45.   const childOriginList = await getBranchList(true, `./${submoduleName}`)
    46.   // (5.1) 本地存在
    47.   if (childLocalList.includes(createName)) {
    48.     await awaitForCommand([[`git checkout ${createName}`, `./${submoduleName}`]])
    49.   // (5.2) 远程存在
    50.   } else if (childOriginList.includes(`origin/${createName}`)) {
    51.     await awaitForCommand([[`git checkout -b ${createName} origin/${createName}`, `./${submoduleName}`]])
    52.   // (5.3) 都不存在
    53.   } else {
    54.     await awaitForCommand([
    55.       [`git checkout -b ${createName}`, `./${submoduleName}`],
    56.       [`git push --set-upstream origin ${createName}`, `./${submoduleName}`]
    57.     ])
    58.   }
    59.   logGreen('已成功创建')
    60. }
    61.  
    62. module.exports = createBranch

  •  bin/branchMode/mergeBranch.js

    1. 1/**
    2.  * 合并分支（主 + 子）
    3.  */
    4. const {
    5.   logGreen,
    6.   selectPrompt,
    7.   getBranchList,
    8.   awaitForCommand,
    9.   getStatusList
    10. } = require('../util')
    11. const {
    12.   submoduleName,
    13.   currentBranch,
    14.   checkGitStatus,
    15.   toggleChildBranch
    16. } = require('./index')
    17.  
    18. const mergeBranch = async() => {
    19.   // (1) 主拉取
    20.   await awaitForCommand([
    21.     [`git pull`]
    22.   ])
    23.   // (2) 子分支切换 & pull
    24.   await toggleChildBranch(currentBranch)
    25.   // (3) 检测暂存区
    26.   await checkGitStatus()
    27.   // (4) 分支选择
    28.   const localBranchList = await getBranchList()
    29.   const branchKey = await selectPrompt('请选择合并分支', localBranchList)
    30.   // (5) 主分支合并
    31.   try {
    32.     await awaitForCommand([[`git merge ${branchKey}`]])
    33.   } catch (error) {
    34.     // log(`主仓库merge异常: ${error}`)
    35.   }
    36.   // (6) 子分支合并
    37.   await awaitForCommand([[`git merge ${branchKey}`, `./${submoduleName}`]])
    38.   // (7) 自动提交commit同步文件
    39.   const statusList = getStatusList()
    40.   if (
    41.     statusList.length === 1 &&
    42.     // 暂存区 || 冲突
    43.     ['M', 'UU'].includes(statusList?.[0]?.[0]?.toUpperCase()) &&
    44.     statusList[0][1] === submoduleName
    45.   ) {
    46.     await awaitForCommand([
    47.       [`git add ${submoduleName}`],
    48.       [`git commit -m fix:子仓库commit同步`]
    49.     ])
    50.   }
    51.   // (8) 提交远程
    52.   await awaitForCommand([
    53.     [`git push`, `./${submoduleName}`],
    54.     [`git push`]
    55.   ])
    56.  
    57.   logGreen('已合并')
    58.   await checkGitStatus()
    59. }
    60.  
    61. module.exports = mergeBranch

  •  bin/branchMode/pullBranch.js

    1. /**
    2.  * 拉取分支（主 + 子）
    3.  */
    4. const { logGreen, awaitForCommand } = require('../util')
    5. const { currentBranch, checkGitStatus, toggleChildBranch } = require('./index')
    6.  
    7. const pullBranch = async() => {
    8.   await awaitForCommand([
    9.     [`git pull`],
    10.     [`git submodule update`]
    11.   ])
    12.   // 子分支切换 & pull
    13.   await toggleChildBranch(currentBranch)
    14.   logGreen(`git pull 成功`)
    15.   await checkGitStatus()
    16. }
    17.  
    18. module.exports = pullBranch

  •  bin/branchMode/toggleBranch.js

    1. /**
    2.  * 切换分支（主 + 子）
    3.  */
    4. const { logGreen, selectPrompt, getBranchList, awaitForCommand } = require('../util')
    5. const { submoduleName, checkGitStatus, toggleChildBranch } = require('./index')
    6.  
    7. const toggleBranch = async() => {
    8.   const localBranchList = await getBranchList()
    9.   const branchKey = await selectPrompt('请选择分支', localBranchList)
    10.   // (1) 切换分支
    11.   await awaitForCommand([
    12.     [`git checkout ${branchKey}`],
    13.     [`git checkout ${branchKey}`, `./${submoduleName}`]
    14.   ])
    15.   // (2) 检测暂存区
    16.   await checkGitStatus()
    17.   await awaitForCommand([
    18.     [`git pull`],
    19.     [`git submodule update`]
    20.   ])
    21.   // (3) 子分支切换 & pull
    22.   await toggleChildBranch(branchKey)
    23.  
    24.   logGreen(`切换分支：${branchKey} 成功, 并执行git pull`)
    25.   await checkGitStatus()
    26. }
    27.  
    28. module.exports = toggleBranch

  •  bin/branchMode/createBranchTags.js

    1. /**
    2.  * 创建Tags（主 + 子）
    3.  */
    4. const { logGreen, selectPrompt, inputPrompt, awaitForCommand } = require('../util')
    5. const { submoduleName, ISOK_ENMU, ISOK_OPTIONS } = require('./index')
    6.  
    7. const createBranchTags = async() => {
    8.   // (1) 主仓库Tags选择
    9.   // const isTags = await selectPrompt('是否需要打Tags', ISOK_OPTIONS)
    10.   // if (isTags !== ISOK_ENMU.yes) return
    11.  
    12.   // (2) 输入TagsName
    13.   let tagsName = await inputPrompt(`请输入Tags名称：`)
    14.   if (!tagsName) return
    15.   tagsName = `tags/${tagsName}`
    16.  
    17.   // (3) 创建主仓库Tags
    18.   await awaitForCommand([
    19.     [`git tag ${tagsName}`],
    20.     [`git push origin ${tagsName}`]
    21.   ])
    22.   logGreen(`主仓库Tags已推: ${tagsName}`)
    23.  
    24.   // (4) 创建子仓库Tags
    25.   const isChildTags = await selectPrompt('子仓库是否需要打Tags', ISOK_OPTIONS)
    26.   if (isChildTags !== ISOK_ENMU.yes) return
    27.   await awaitForCommand([
    28.     [`git tag ${tagsName}`, `./${submoduleName}`],
    29.     [`git push origin ${tagsName}`, `./${submoduleName}`]
    30.   ])
    31.   logGreen(`子仓库Tags已推: ${tagsName}`)
    32. }
    33.  
    34. module.exports = createBranchTags


        到这里就大工告成了，有用的话麻烦关注收藏一下~

        欢迎留言探讨

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Cpp五条/article/detail/459346
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。