commit-to-co-authors

Parses co-authors from Git/GitHub-style commit messages. ✍️

Usage

1npm i commit-to-co-authors

Pass any variant of Git/GitHub-style commit message string to this package's exported commitToCoAuthors. It will collect data from each case-insensitive co-authored-by: match. Data may include email, name, and/or username:

1import { commitToCoAuthors } from "commit-to-co-authors";
2
3commitToCoAuthors(`
4co-authored-by: @DirectUsername
5Co-authored-by: Josh Goldberg <github@joshuakgoldberg.com>
6`);

1[
2	{
3		"username": "DirectUsername"
4	},
5	{
6		"email": "github@joshuakgoldberg.com",
7		"name": "Josh Goldberg"
8	}
9]

[!NOTE] Proper Co-authored-by attributions should use the name <email> format, not @username. The @username extension is only there as a friendly compatibility layer for GitHub users who don't allow seeing their email. Please don't use it unless you absolutely need to.

Contributors

Josh Goldberg 🔧 🐛 💻 🚧 👀 📖 🚇

💙 This package was templated with create-typescript-app.