san-cli-utils/downloadRepo.js

San CLI 中所用到的工具类函数：

/**
 * Copyright (c) Baidu Inc. All rights reserved.
 *
 * This source code is licensed under the MIT license.
 * See LICENSE file in the project root for license information.
 *
 * @file 下载 github/icode repo
 */

const gitclone = require('git-clone');
const fse = require('fs-extra');
const {getDebugLogger} = require('./ttyLogger');
const {getGitUser} = require('./env');
const {chalk} = require('./ttyLogger');

const debug = getDebugLogger('init:download-repo');

module.exports = (repo, dest, options) => {
    repo = normalize(repo, options);
    const {url, checkout = '', timeout = 60e3} = repo;
    const {template, appName} = options;
    const rm = fse.removeSync;
    // 先删除
    rm(dest);
    return new Promise((resolve, reject) => {
        debug('url: %s, dest: %s, branch: %s', url, dest, checkout);
        let tid;
        if (timeout && timeout > 10e3) {
            tid = setTimeout(() => {
                clearTimeout(tid);
                reject(
                    getErrorMessage('Download timeout', {
                        repo,
                        url,
                        dest,
                        checkout,
                        template,
                        appName
                    })
                );
            }, timeout);
        }
        gitclone(url, dest, {checkout, shallow: checkout === 'master' || !checkout}, err => {
            tid && clearTimeout(tid);

            if (!err) {
                rm(`${dest}/.git`);
                resolve({url, dest, checkout});
            }
            else {
                reject(
                    getErrorMessage(err.message, {
                        repo,
                        url,
                        dest,
                        checkout,
                        template,
                        appName
                    })
                );
            }
        });
    });
};
function getErrorMessage(reason, gitInfo) {
    let {url, appName} = gitInfo;
    const isSSH = /^((?:ssh:\/\/|git@).+?)(?:#(.+))?$/.test(url);
    const cmd = 'init';
    const info = `${isSSH
        ? `Fail to pull \`${url}\` with SSH, please use HTTPS/HTTP instead and try again, or check if you can use SSH.
A simple way to check if you can use SSH is running the command: git clone ${url}`
        : `Fail to pull \`${url}\`, please check the network, or use SSH instead and try again.
A simple way to check the network is running the command: git clone ${url}`}
If the methods above do not work, please check the path of ${chalk.cyan(url)}

Fail message: ${chalk.cyan(reason)}.

san init <template> <app-name>, for example:
    san ${cmd} ${chalk.cyan('yourname/template')} ${appName}
    san ${cmd} ${chalk.cyan('https://github.com/yourname/template.git')} ${appName}
    san ${cmd} ${chalk.cyan('github:yourname/template')} ${appName}
    san ${cmd} ${chalk.cyan('icode:baidu/path/template')} ${appName}
    san ${cmd} ${chalk.cyan('coding:yourname/template')} ${appName}
    san ${cmd} ${chalk.cyan('template#branch1')} ${appName}

Default template is ${chalk.cyan('ksky521/san-project')}, Use ${chalk.cyan('san init -h')} for more information.`;

    return info;
    // if (/failed with status 128/.test(reason)) {
    //     return info;
    // }
}
function normalize(repo, opts) {
    // https://username@icode.baidu.com/baidu/foo/bar
    // ssh://username@icode.baidu.com:8235/baidu/foo/bar
    // ssh://git@icode.baidu.com:8235/baidu/foo/bar
    // 如果是完整地址，直接返回，无需标准化
    const tRegex = /^((?:ssh:\/\/|https?:\/\/|git@).+?)(?:#(.+))?$/;
    if (tRegex.test(repo)) {
        const match = tRegex.exec(repo);
        return {
            url: match[1],
            checkout: match[2] || ''
        };
    }
    // 公司名/目录名/repo#分支
    const regex = /^(?:(icode|github|gitlab|bitbucket|coding):)?(?:(baidu)\/)?(?:([^/]+)\/)?([^#]+)(?:#(.+))?$/;
    const useSSH = opts.ssh || false;
    const {name, isBaidu} = getGitUser();
    // 如果是 是百度，则强制使用百度账号
    const user = isBaidu ? name : opts.username !== '' && opts.username ? opts.username : 'git';

    const match = regex.exec(repo);
    if (!match) {
        return {
            url: repo,
            checkout: ''
        };
    }
    // TODO 这里要不要创建个 san-projects/san-templates 的用户放一些标准的项目脚手架？没有之前，product 默认写 ksky521吧~
    // eslint-disable-next-line no-unused-vars
    const [_, source = 'github', baidu = 'baidu', product = 'ksky521', repoName, checkout = ''] = match;
    let url = repo;
    switch (source) {
        case 'icode':
            if (!useSSH) {
                // https://username@icode.baidu.com/baidu/foo/bar
                url = `https://${user}@icode.baidu.com/${baidu}/${product}/${repoName}`;
            }
            else {
                url = `ssh://${user}@icode.baidu.com:8235/${baidu}/${product}/${repoName}`;
            }
            break;
        case 'github':
        case 'gitlab':
        case 'bitbucket':
            if (!useSSH) {
                // https://github.com/ksky521/san-webpack.git
                url = `https://${source}.com/${product}/${repoName}.git`;
            }
            else {
                // git@github.com:ksky521/san-webpack.git
                url = `git@${source}.com:${product}/${repoName}.git`;
            }
            break;
        case 'coding':
            if (!useSSH) {
                url = `https://git.coding.net/${product}/${repoName}.git`;
            }
            else {
                url = `git@git.coding.net:${product}/${repoName}.git`;
            }
            break;
    }
    return {
        url,
        checkout
    };
}