git-workspace 🚀

如果你的公司有很多仓库，而且你的工作需要在这些仓库之间跳转，那么 git-workspace 可以通过以下方式节省你一些时间

• 轻松地将你的项目目录与 Github、Gitlab.com 或 Gitlab自托管 同步 🔧
• 保持项目名称一致，并位于正确的路径下 📁
• 自动设置分叉的上游 ⚡
• 将删除的仓库移动到存档目录 💾
• 让你能够立即访问任何仓库 :shipit
• 并行地对所有项目执行 git fetch :godmode

这可能听起来没什么用，但“登录到你的Git提供程序，浏览到项目，复制克隆URL，设计一个合适的路径来克隆它”的舞蹈可能是一个很大的减速。这里唯一的明显解决方案是花比你在一生中花在做这件事上更多的时间，用Rust编写一个工具来为你做这件事。

目录

• 安装 💿
  • Homebrew (MacOS Linux)
  • Nix (MacOS Linux)
  • AUR (ArchLinux)
  • 二进制文件 (Windows)
  • Cargo
• 用法 🎷
  • 定义你的工作空间
  • 提供者凭证
  • 添加提供者
  • 更新你的工作空间
  • 获取所有更改
• 切换项目 🔁
  • Fish，与fzf一起
• 贡献 🐛

安装 💿

Homebrew (MacOS + Linux)

brewinstall git-workspace

Nix (MacOS + Linux)

nix-shell

nix-shell -p git-workspace

nix shell (Flakes)

nix shell nixpkgs#git-workspace

home-manager (home.nix)

{
  home.packages = with pkgs; [
    git-workspace
  ];
}

NixOS (configuration.nix)

{
  environment.systemPackages = with pkgs; [
    git-workspace
  ];
}

AUR (ArchLinux)

paru-S git-workspace

二进制文件 (Windows)

从GitHub发行页面下载最新版本。解压并将其移动到你的 PATH 目录。

Cargo

不要这样做，这非常慢：cargo install git-workspace

用法 🎷

Git真的很烦人，并且篡改了子命令的--help标志。因此，要获取帮助，请使用git-workspace --help，而不是git workspace --help

$ git-workspace --help
git-workspace 1.1.0
Tom Forbes <[email protected]>
Manage and update personal and work git repos from multiple providers

USAGE:
    git-workspace --workspace <workspace> <SUBCOMMAND>

FLAGS:
    -h, --help
            Prints help information

    -V, --version
            Prints version information


OPTIONS:
    -w, --workspace <workspace>
             [env: GIT_WORKSPACE=/Users/tom/PycharmProjects/]


SUBCOMMANDS:
    add                Add a provider to the configuration
    archive            Archive repositories that don't exist in the workspace anymore
    fetch              Fetch new commits for all repositories in the workspace
    help               Prints this message or the help of the given subcommand(s)
    list               List all repositories in the workspace
    lock               Fetch all repositories from configured providers and write the lockfile
    run                Run a git command in all repositories
    switch-and-pull    Pull new commits on the primary branch for all repositories in the workspace
    update             Update the workspace, removing and adding any repositories as needed

定义你的工作空间

工作空间是git-workspace将为您管理的目录，用您提供者的项目填充它。要配置此设置，只需设置一个指向空目录的GIT_WORKSPACE环境变量。例如

export GIT_WORKSPACE=~/projects

提供者凭证

GitHub和Gitlab都需要个人访问令牌才能访问其GraphQL端点。在此处创建访问令牌

• Github: https://github.com/settings/tokens（只需repo范围）

• Gitlab: https://gitlab.com/profile/personal_access_tokens（只需api范围）

将这些令牌作为GITHUB_TOKEN和GITLAB_TOKEN导出到您的shell中。

添加提供者

您可以使用git workspace add快速将条目添加到您的workspace.toml

• 克隆用户或组织的所有GitHub仓库

  • gitworkspace add github[USER OR ORG NAME]

• 排除特定仓库

  • gitworkspace add github[USER OR ORG NAME] --exclude="foo.*bar$" --exclude="(abc|def)"

• 从Gitlab克隆命名空间或用户

  • gitworkspace add gitlab gitlab-ce/gitlab-services

• 从自托管gitlab/github实例克隆

  • gitworkspace add gitlab my-company-group --url=https://internal-gitlab.company.com
  • gitworkspace add github user-or-org-name --url=https://internal-github.company.com/api/graphql

多个配置

Git工作空间将读取您$GIT_WORKSPACE目录下的任何workspace*.toml文件。

# ~/.config/fish/functions/open-project.fish
function open-project -d "Open a project"
  set filter "$argv"
  set chosen_project (git workspace list | fzf -q "$filter")
  if string length -q -- $chosen_project
     $EDITOR $GIT_WORKSPACE/$chosen_project
     pushd $GIT_WORKSPACE/$chosen_project
  end
end

function project {
	local filter="$@"
	local chosen_project=$(git workspace list | fzf -q "$filter")
	if [[ -n $chosen_project ]]; then
		pushd "$GIT_WORKSPACE/$chosen_project"
	fi
}

#!/bin/sh
# shellcheck shell=sh # Written to comply with IEEE Std 1003.1-2017 for standard POSIX environment

###! # WorkSPace (wsp)
###! Switches to specified git-workspace project directory
###! - Requires git and fzf
wsp() {
    # Check for required non-standard commands
    for command in ${FZF:-"fzf"} ${GIT:-"git"}; do
        ${COMMAND:-"command"} -v "$command" || { ${PRINTF:-"printf"} "FATAL: %s\\n" "Command '$command' is not executable"; ${EXIT:-"exit"} 127 ;}
    done
    
    # shellcheck disable=SC2086 # Harmless warning about missing double-quotes that are not expected to allow parsing multiple arguments
    wsp_path="${1:-"${GTT_WORKSPACE:-"$PWD"}/$(${GIT:-"git"} workspace list | ${FZF:-"fzf"} ${fzf_arg:-"-q"} "$@")"}" # Path to the git workspace directory
    
    # Change directory
    ${CD:-"cd"} "$wsp_path" || { printf "FATAL: %s\\n" "Unable to change directory to '$wsp_path'";}
}