从Github下载模板

February 6, 2024

由于本地使用了 WattToolkit，通过中间人代理了 Github，导致其它不走系统证书的请求会报证书错误。
例如 npm create astro 下载模板时，它内部使用 giget 请求 Github API 来下载模板。giget 内部又是直接使用 fetch 函数发起请求，最终导致证书错误而失败。

giget 原理是从 Github 下载 tar 包，然后解压其中子目录。因为 Github 是不支持直接下载子目录的。

/**
 * @param input "withastro/starlight#main"
 */
async function getDlLink(input: string) {
    const [owner_repo, ref = ""] = input.split("#");
    const res = await fetch(`https://api.github.com/repos/${owner_repo}/tarball/${ref}`, {
        headers: {
            Accept: "application/vnd.github+json",
            "X-GitHub-Api-Version": "2022-11-28",
        },
        redirect: "manual",
    });
    if (res.status !== 302) throw new Error("unexpected status code");
    return res.headers.get("location")!;
}

getDlLink("withastro/starlight"); // => https://codeload.github.com/withastro/starlight/legacy.tar.gz/refs/heads/main

下面为了简单，直接通过 git clone --depth 实现相同效果，git clone 不会出现证书错误。
给出一段简单的 Bash 脚本

bash

#!/usr/bin/env bash
set -e

this_name=$(basename "${BASH_SOURCE[0]}")

usage() {
    cat <<EOF
Usage:
  $this_name <USER/REPO> -p <project> [-d <sub_dir>]

Example:
  $this_name withastro/astro     -p proj -d examples/basics
  $this_name withastro/starlight -p proj -d examples/basics
  $this_name vitejs/vite         -p proj -d packages/create-vite/template-vanilla-ts
  $this_name hexojs/hexo-starter -p blog -d / -y

Available options:
 -p   Project, the local directory to create
 -d   Sub dir, optional, sub directory of the repository
 -y   Yes    , no prompt for y/n
 -h   Help   , print this help and exit
 -v   Verbose, print script debug info
EOF
    exit
}

msg() {
    echo >&2 -e "\033[0;34m${1-}\033[0m"
}

warn() {
    echo >&2 -e "\033[1;33m${1-}\033[0m"
}

if [ -n "$1" ] && [[ ! "$1" =~ ^- ]]; then
    repo="$1"
    shift
fi

while getopts ":p:d:yhv" opt; do
    case ${opt} in
    p) project_name=$OPTARG ;;
    d) sub_dir=$OPTARG ;;
    y) no_confirm=true ;;
    h) usage ;;
    v) set -x ;;
    \?) warn "Invalid option: $OPTARG" && usage ;;
    :) warn "Option -$OPTARG requires an argument" && usage ;;
    esac
done
shift $((OPTIND - 1))

if [ -z "$repo" ]; then
    msg "Enter USER/REPO     (e.g. withastro/astro):"
    read -r repo
fi

if [ -z "$sub_dir" ]; then
    msg 'Enter sub directory (e.g. examples/basics) enter to skip:'
    read -r sub_dir
fi

[ "$sub_dir" = "/" ] && sub_dir=""

if [ -z "$project_name" ]; then
    msg 'Enter new directory (e.g. my-project):'
    read -r project_name
fi

confirm() {
    if [ -n "$no_confirm" ]; then
        return
    fi

    while true; do
        msg "$1 (y/n):"
        read -r yn
        case $yn in
        [Yy]*) return 0 ;;
        [Nn]*) return 1 ;;
        *) warn "Please enter y OR n" ;;
        esac
    done
}

random_string=$(tr -dc 'a-zA-Z0-9' </dev/urandom | head -c 4)
tmp_dir="tmp_${random_string}_$(echo "$repo/$sub_dir" | sed 's/\//_/g')"

confirm "Will copy from \"https://github.com/$repo/tree/main/$sub_dir\"\nTo \"$project_name\", Is it correct?" || (warn "Aborted" && exit 1)

git clone --depth=1 "https://mirror.ghproxy.com/https://github.com/$repo" "$tmp_dir"
cp -r "$tmp_dir/$sub_dir" "$project_name"
rm -rf "$project_name/.git"
rm -rf "$tmp_dir"

保存为 gitget.sh，直接运行 ./gitget.sh withastro/starlight -p proj -d examples/basics -y 即可复制模板

←Back to home

This work is licensed under CC BY-NC-SA 4.0