快速克隆Company 的 gitlab 上的项目

背景

最近有个痛点，公司项目有几百个，自己需要查看负责的项目又非常的多，比如前端是多应用的存在，就会有：前台、后台、npm包

项目目录	个数
后台	36
npm包	30
前台	80
...	...

这么庞大的代码目录，自己一个个的clone，需要浪费很多的时间和精力。就会有人问：为啥要一次性拉取这么多代码呢，自己根据需要，使用开发的时候再去拉取好了。是的这个提问非常的好，这样符合的大部分同学的需要，但是就是有些人有些时候有需要将所有的项目目录进行拉取，方便查找问题进行全局搜索，。为了满足这部分同学的需要，最近就打算使用脚本实现一个命令拉取自己想要的目录下面的代码，节省时间提高效率。

先来看下脚本的使用：

// 安装
npm install <your npm package> -g

// 执行
<your npm package name> clone -t <your token> -g <groupName>

// your token 这个是你gitlab的access token 可以参考下面的教程进行生成
// groupName 是你想clone的代码的目录后者groupid

1、生成Access Token

打开 gitlab 地址：【gitlab 域名地址】 找到右侧头像的地方打开 【Edit profile】

打开之后找到 【Access Tokens】然后填写名称和勾选api的权限，生成token

操作之后可以看到生成的token 点击右侧进行复制，自己保存起来

2、安装脚本之后，打开 命令行工具，切到你的文档目录（自己可以新建一个自己想要的名字）

<your npm package name> clone -t <your token> -g <groupName>

填写你刚才生成的token 和你想要clone的项目目录名称，接下来就会执行clone操作，将该目录下所有的仓库下载下来。

执行结束就可以了，会将当前目录和子目录下面所有的代码clone下来咯，剩下的就是自己去代码的海洋里玩耍吧。

脚本实现：

使用的是gitlab api进行获取目录分组下的代码信息，然后根据返回值判断是项目目录分组还是仓库，递归执行git clone

1、根据分组获取分组下的代码仓库地址，进行clone

const shelljs = require('shelljs')
const request = require('request')

const GITLAB_URL = '' // 这里是gitlab仓库地址
const apiToken = '' // 这里就是在gitlab 新建的token的值
// 根据分组名称或者id获取代码仓库地址
const cloneProjectByGroupName = async (groupName: string) => {
  return new Promise((resolve, reject) => {
    const url = `${GITLAB_URL}/api/v4/groups/${groupName}/projects?per_page=100&page=1`;
    const options = {
        url: url,
        method: "GET",
        headers: {
            'Content-Type': 'application/json;charset=UTF-8',
            'Authorization': `Bearer ${apiToken}`,
        },
        rejectUnauthorized: true,
        contentType: 'json',
        dataType: 'json',
    }
    
    request(options, async function(error: any, response: any, res: any) {
      if (!error) {
        const data = JSON.parse(res)
        let count = 0
        for(let i = 0; i < data.length; i++) {
          const result =  shelljs.exec(`git clone --recursive ${data[i]['http_url_to_repo']} ${data[i]['path']}`)
          if(result.code === 0) {
            count++
          }
        }
        if(count >= data.length) {
          resolve(true)
        }
      } else {
        console.log(error);
      }
    })
  })
}

2、如果分组里面有子目录再进一级进行执行

const getChildrenProjectByGroupName = (groupName: string) => {
  const url = `${GITLAB_URL}/api/v4/groups/${groupName}/subgroups`;
  const options = {
      url: url,
      method: "GET",
      headers: {
          'Content-Type': 'application/json;charset=UTF-8',
          'Authorization': `Bearer ${apiToken}`,
      },
      rejectUnauthorized: true,
      contentType: 'json',
      dataType: 'json',
  }
  
  const res = request(options, async function(error: any, response: any, res: any) {
    if (!error) {
      const data = JSON.parse(res)
      if(data.length > 0) {
        data.forEach(async (item: any) => {
          shelljs.mkdir(item.path);
          shelljs.cd(item.path);
          const result = await cloneProjectByGroupName(item.id) as any
          if(result) {
            shelljs.cd('../');
          }
        })
      }
    } else {
      chalk.red(error);
    }
  })
}

然后就是将脚本发布到npm 就可以自己安装使用了。

至此，此文章结束，感谢阅览

书写不易，未经授权禁止转载，感谢配合