description-to-co-authors
v0.3.0
Published
Parses co-authors from Git/GitHub-style commit messages and issue bodies. ✍️
Downloads
8,705
Readme
Usage
npm i description-to-co-authors
Pass any variant of Git/GitHub-style commit message or issue body string to this package's exported descriptionToCoAuthors
.
It will collect data from each case-insensitive co-authored-by:
match.
Data may include email
, name
, and/or username
:
import { descriptionToCoAuthors } from "description-to-co-authors";
descriptionToCoAuthors(`
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 thename <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
💙 This package was templated with description-to-co-authors.