feat: rename function to descriptionToCoAuthors

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Description to Co Authors</h1>
 
-<p align="center">Parses co-authors from Git/GitHub-style commit messages. ✍️</p>
+<p align="center">Parses co-authors from Git/GitHub-style commit messages and issue bodies. ✍️</p>
 
 <p align="center">
 	<!-- prettier-ignore-start -->
@@ -22,14 +22,14 @@
 npm i description-to-co-authors
 ```
 
-Pass any variant of Git/GitHub-style commit message string to this package's exported `commitToCoAuthors`.
+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 { commitToCoAuthors } from "description-to-co-authors";
+import { descriptionToCoAuthors } from "description-to-co-authors";
 
-commitToCoAuthors(`
+descriptionToCoAuthors(`
 co-authored-by: @DirectUsername
 Co-authored-by: Josh Goldberg <github@joshuakgoldberg.com>
 `);

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "description-to-co-authors",
 	"version": "0.2.0",
-	"description": "Parses co-authors from Git/GitHub-style commit messages. ✍️",
+	"description": "Parses co-authors from Git/GitHub-style commit messages and issue bodies. ✍️",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/JoshuaKGoldberg/description-to-co-authors"

src/index.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, it } from "vitest";
 
-import { commitToCoAuthors } from "./index.js";
+import { descriptionToCoAuthors } from "./index.js";
 
-describe("commitToCoAuthors", () => {
+describe("descriptionToCoAuthors", () => {
 	it.each([
 		["", []],
 		["unrelated", []],
@@ -35,6 +35,6 @@ describe("commitToCoAuthors", () => {
 			[{ email: "abc@def.ghi", name: "Three Full Names" }],
 		],
 	])("%s", (input, expected) => {
-		expect(commitToCoAuthors(input)).toEqual(expected);
+		expect(descriptionToCoAuthors(input)).toEqual(expected);
 	});
 });

src/index.ts

@@ -4,10 +4,10 @@ export interface CoAuthor {
 	username?: string;
 }
 
-export function commitToCoAuthors(commit: string) {
+export function descriptionToCoAuthors(description: string) {
 	const coAuthors: CoAuthor[] = [];
 
-	for (const match of commit.match(/co-authored-by:.+/gi) ?? []) {
+	for (const match of description.match(/co-authored-by:.+/gi) ?? []) {
 		const split = match.trim().split(/\s+/);
 		if (split.length < 2) {
 			continue;