npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

git-mob

v3.2.0

Published

CLI tool for adding co-authors to commits.

Downloads

381

Readme

Git Mob - Co-author commits

npm downloads npm version

A command-line tool for social coding

Add co-authors to commits when you collaborate on code. Use when pairing with a buddy or mobbing with your team.

✨ Git Mob VS Code extension

gif showing example usage of git-mob

Install

git-mob is a CLI tool, so you'll need to install the package globally.

npm i -g git-mob

By default git-mob will use the global config .gitmessage template to append co-authors.

Workflow / Usage

With git-mob, the primary author will always be the primary user of the computer. Set your author info in git if you haven't done so before.

$ git config --global user.name "Jane Doe"
$ git config --global user.email "[email protected]"

To keep track of co-authors git-mob uses a JSON file called .git-coauthors, and will try to find it in the following directories:

  1. If GITMOB_COAUTHORS_PATH environment variable is set this will override any other settings.
  2. If the current Git repository has a .git-coauthors file in the root directory.
  3. The default is the users home directory at ~/.git-coauthors.

Here's a template of its structure:

{
  "coauthors": {
    "<initials>": {
      "name": "<name>",
      "email": "<email>"
    }
  }
}

Start by adding a few co-authors that you work with. Also see add co-author command.

$ cat <<-EOF > ~/.git-coauthors
{
  "coauthors": {
    "ad": {
      "name": "Amy Doe",
      "email": "[email protected]"
    },
    "bd": {
      "name": "Bob Doe",
      "email": "[email protected]"
    }
  }
}
EOF

You're ready to create your mob. Tell git-mob you're pairing with Amy by using her initials. git mob ad

$ git mob ad
Jane Doe <[email protected]>
Amy Doe <[email protected]>

Commit like you normally would. You should see Co-authored-by: Amy Doe <[email protected]> appear at the end of the commit message.

Let's add Bob to the group to create a three-person mob.

$ git mob ad bd
Jane Doe <[email protected]>
Amy Doe <[email protected]>
Bob Doe <[email protected]>

Once you're done mobbing, switch back to developing solo.*

$ git solo
Jane Doe <[email protected]>

Selected co-authors are stored globally meaning when switching between projects your co-authors stay the same*.

*Note: If you've set a local commit template in your config then that template will be updated. However, not when you switch projects and you will see a warning. You can run git mob to update the commit template. Read more here

Add co-author from GitHub

Provide the GitHub username to generate their co-author details. The anonymous GitHub email is used. You need to enable it see config.

$ git mob rkotze
Jane Doe <[email protected]>
Richard Kotze <[email protected]>

Custom setup

Using git commit -m setup

How to append co-authors to the message when using message flag - git commit -m "commit message"?

  1. Add prepare-commit-msg hook file in .git/hooks dir. See hook-examples
  2. The hook will need to be executable chmod +x prepare-commit-msg

prepare-commit-msg will need a script to read the co-authors, which can be done via git mob-print. See hook-examples folder for working scripts.

The command git mob-print will output to stdout the formatted co-authors.

Note: > v1.1.0 git mob --installTemplate and git mob --uninstallTemplate has been removed.

Using pre-commit to install

You can install the git hook using [pre-commit](https://pre-commit.com/). Add the following to your pre-commit-config.yaml

repos:
  - repo: https://github.com/rkotze/git-mob
    rev: { tag-version }
    hooks:
      - id: add-coauthors
        stages: ['prepare-commit-msg']

And install with: pre-commit install --hook-type prepare-commit-msg.

Removing the above snippet and running git commit will uninstall the pre-commit hook

Revert back to default setup

  1. Remove relevant scripts prepare-commit-msg file

Git Mob config

Git Mob config is a section in the Git config.

Use local commit template

If you are using a local commit template and want to remove the warning message then set this option to true. Only reads from the local git config.

type: Boolean, scope: local, version: 2.2.0

git config --local git-mob-config.use-local-template true

Enable GitHub author fetch

To fetch authors from GitHub you need to enable it using the config.

type: Boolean, scope: global, version: 2.3.3

git config --global git-mob-config.github-fetch true

More commands

List all co-authors

Check which co-authors you have available in your .git-coauthors file.

$ git mob --list
jd Jane Doe [email protected]
ad Amy Doe [email protected]
bd Bob Doe [email protected]

Overwrite the main author

Overwrite the current author which could be useful for pairing on different machines

If the current author is: Bob Doe

$ git mob -o jd ad
jd Jane Doe [email protected]
ad Amy Doe [email protected]

Now the author has changed to Jane Doe.

Add co-author

Add a new co-author to your .git-coauthors file.

$ git add-coauthor bb "Barry Butterworth" [email protected]

Delete co-author

Delete a co-author from your .git-coauthors file.

$ git delete-coauthor bb

Edit co-author

Edit a co-author's details in your .git-coauthors file.

$ git edit-coauthor bb --name="Barry Butterworth" --email="[email protected]"
$ git edit-coauthor bb --name="Barry Butterworth"
$ git edit-coauthor bb --email="[email protected]"

Suggest co-authors

Suggest co-authors to save based on contributors to the current Git repo.

Optional author filter by name or email.

$ git suggest-coauthors [author name | author email]

Path to .git-coauthors

Print out path to .git-coauthors file.

git mob -p

Help

Find out more.

git mob -h

Add initials of current mob to your prompt

Bash

Add the initials to PS1, in ~/.bashrc

function git_initials {
  local initials=$(git mob-print --initials)
  if [[ -n "${initials}" ]]; then
    echo " [${initials}]"
  fi
}

export PS1="\$(pwd)\$(git_initials) -> "

Fish

Add the following functions to .config/fish/config.fish

function git_initials --description 'Print the initials for who I am currently pairing with'
  set -lx initials (git mob-print --initials)
  if test -n "$initials"
    printf ' [%s]' $initials
  end
end

function fish_prompt
  printf "%s%s ->" (pwd) (git_initials)
end

More info

See git-mob discussions

Read our blog post to find out why git-mob exists: Co-author commits with Git Mob

* If you have git-duet installed, you'll need to uninstall it since it conflicts with the git-solo command.