commit-to-co-authors

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

0.1.0
latest
Source
npm

Version published: last year

Maintainers: 1

Created: last year

Source

commit-to-co-authors

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

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 <github@joshuakgoldberg.com>
`);

[
	{
		"username": "DirectUsername"
	},
	{
		"email": "github@joshuakgoldberg.com",
		"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.

FAQs

What is commit-to-co-authors?

Is commit-to-co-authors well maintained?

Package last updated on 24 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install