This package has been deprecated

Author message:

Renamed to description-to-co-authors. This will work for GitHub issue bodies too.

commit-to-co-authors

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

Usage

npm 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:

import { commitToCoAuthors } from "commit-to-co-authors";

commitToCoAuthors(`
co-authored-by: @DirectUsername
Co-authored-by: Josh Goldberg <[e-mail]>
`);

[
	{
		"username": "DirectUsername"
	},
	{
		"email": "[e-mail]",
		"name": "Josh Goldberg"
	}
]

[!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.