Skip to content

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

License

Notifications You must be signed in to change notification settings

JoshuaKGoldberg/commit-to-co-authors

Repository files navigation

commit-to-co-authors

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

All Contributors: 1 👪 Codecov Test Coverage Contributor Covenant License: MIT Style: Prettier TypeScript: Strict npm package version

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 <[email protected]>
`);
[
	{
		"username": "DirectUsername"
	},
	{
		"email": "[email protected]",
		"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
Josh Goldberg

🔧 🐛 💻 🚧 👀 📖 🚇

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

About

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

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published