# description-to-co-authors

> Parses co-authors from Git/GitHub-style commit messages and issue bodies. ✍️

Latest version **0.3.0** (published 2024-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install description-to-co-authors
pnpm add description-to-co-authors
yarn add description-to-co-authors
bun add description-to-co-authors
```

## Health

**Score 50/100 (C)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2024-08-10 |
| First published | 2024-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.3.0 |
| Dependencies | 0 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 4 |
| Author | JoshuaKGoldberg |
| Maintainers | joshuakgoldberg |

## Links

- npm: https://www.npmjs.com/package/description-to-co-authors
- Repository: https://github.com/JoshuaKGoldberg/description-to-co-authors
- Homepage: https://github.com/JoshuaKGoldberg/description-to-co-authors#readme
- Issues: https://github.com/JoshuaKGoldberg/description-to-co-authors/issues
- npm.io page: https://npm.io/package/description-to-co-authors

## Recent versions

- 0.3.0 (latest) — 2024-08-10
- 0.2.0 — 2024-08-10

## README

<h1 align="center">Description to Co Authors</h1>

<p align="center">Parses co-authors from Git/GitHub-style commit messages and issue bodies. ✍️</p>

<p align="center">
	<!-- prettier-ignore-start -->
	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 1" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-1-21bb42.svg" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
	<!-- prettier-ignore-end -->
	<a href="https://github.com/JoshuaKGoldberg/description-to-co-authors/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
	<a href="https://codecov.io/gh/JoshuaKGoldberg/description-to-co-authors" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/description-to-co-authors?label=%F0%9F%A7%AA%20coverage" /></a>
	<a href="https://github.com/JoshuaKGoldberg/description-to-co-authors/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
	<a href="http://npmjs.com/package/description-to-co-authors"><img alt="📦 npm version" src="https://img.shields.io/npm/v/description-to-co-authors?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
</p>

## Usage

```shell
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`:

```ts
import { descriptionToCoAuthors } from "description-to-co-authors";

descriptionToCoAuthors(`
co-authored-by: @DirectUsername
Co-authored-by: Josh Goldberg <github@joshuakgoldberg.com>
`);
```

```json
[
	{
		"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

<!-- spellchecker: disable -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg"/><br /><sub><b>Josh Goldberg</b></sub></a><br /><a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- spellchecker: enable -->

<!-- You can remove this notice if you don't want it 🙂 no worries! -->

> 💙 This package was templated with [description-to-co-authors](https://github.com/JoshuaKGoldberg/description-to-co-authors).

---
_Source: https://npm.io/package/description-to-co-authors · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._