@ljharb/coauthors 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v2.0.1](https://github.com/ljharb/coauthors/compare/v2.0.0...v2.0.1) - 2026-06-18
+
+### Commits
+
+- [types] clean up some annotations [`5c56964`](https://github.com/ljharb/coauthors/commit/5c56964c94ec43d0c593b8e82a3759267c940e22)
+- [Dev Deps] update `eslint` [`e39c67a`](https://github.com/ljharb/coauthors/commit/e39c67ad57b9de9c9d627ca8ac729d1472d152b7)
+- [Tests] extract coverage config to file [`b13990e`](https://github.com/ljharb/coauthors/commit/b13990e8049a070dee35d6d9b3c3ce4d242f53ba)
+- [actions] update workflows [`a4bb6ef`](https://github.com/ljharb/coauthors/commit/a4bb6ef475b80587431ed03400a850bf22c15709)
+- [Tests] increase coverage [`b980162`](https://github.com/ljharb/coauthors/commit/b9801621dc9bcf2d2d0c00f2a252f89bf89a8791)
+- [Dev Deps] update `@ljharb/eslint-config`, `@types/node`, `auto-changelog`, `esmock`, `tape` [`7562264`](https://github.com/ljharb/coauthors/commit/7562264c14baf865411f03b5f3a31d8451bdf0c5)
+- [Deps] update `pargs` [`9be2a35`](https://github.com/ljharb/coauthors/commit/9be2a35b70f1ad771cc1bfb743cde7c48702ca4c)
+- [Dev Deps] update `@ljharb/eslint-config`, `@types/node`, `eslint`, `npmignore` [`78926c8`](https://github.com/ljharb/coauthors/commit/78926c848b5644ab3a08693b8a28d85171bd7e06)
+- [Dev Deps] update `@ljharb/eslint-config`, `@types/node` [`4316fe4`](https://github.com/ljharb/coauthors/commit/4316fe4f0975e1472af8a857666e82b5c6f4fc9a)
+- [Deps] update `pargs` [`0bd17fb`](https://github.com/ljharb/coauthors/commit/0bd17fb53c0b1b8058f8d5d47d3b53ffe9c55ff8)
+- [Deps] update `pargs` [`9cbfea5`](https://github.com/ljharb/coauthors/commit/9cbfea509bd39b6dfa020818169bfd7499fbf761)
+- [Deps] update `pargs` [`f036877`](https://github.com/ljharb/coauthors/commit/f0368774d195dfaf96356e8ce6e8ac4173a55485)
+- [Dev Deps] update `c8` [`ce1d62e`](https://github.com/ljharb/coauthors/commit/ce1d62e3613fc31ed8ee6a0bb4a213264b976c75)
+- [Deps] update `pargs` [`edb1de1`](https://github.com/ljharb/coauthors/commit/edb1de1ffb208b503e1ac06a1a2c55ef289a8bd5)
+
 ## [v2.0.0](https://github.com/ljharb/coauthors/compare/v1.0.0...v2.0.0) - 2025-10-29
 
 ### Commits

package/bin.mjs

@@ -9,17 +9,19 @@ const {
 	help,
 	positionals,
 	errors,
-} = await pargs(import.meta.filename, { allowPositionals: 1 });
+} = await pargs(import.meta.filename, {
+	allowPositionals: 1,
+	positionals: [{ description: 'the git remote to read co-authors from (default: origin)', name: 'remote' }],
+});
 
 const remote = validateRemote(positionals[0] ?? 'origin');
 
 if (typeof remote !== 'string') {
-	errors.push(remote.error);
+	errors[errors.length] = `${remote}`;
 }
 
 await help();
 
-// eslint-disable-next-line no-extra-parens
-const results = Array.from(getResults(/** @type {string} */ (remote)), (x) => `Co-authored-by: ${x}`);
+const results = Array.from(getResults(`${remote}`), (x) => `Co-authored-by: ${x}`);
 
 console.log(results.join('\n'));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ljharb/coauthors",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"description": "A cli to generate a complete git co-authors list, including existing co-authors, for use in a commit message.",
 	"bin": "./bin.mjs",
 	"exports": {
@@ -11,7 +11,7 @@
 		"prepack": "npmignore --auto --commentLines=autogenerated",
 		"prepublish": "not-in-publish || npm run prepublishOnly",
 		"prepublishOnly": "safe-publish-latest",
-		"lint": "eslint --ext=js,mjs .",
+		"lint": "eslint .",
 		"postlint": "tsc",
 		"pretest": "npm run lint",
 		"tests-only": "c8 tape 'test/**/*.*js'",
@@ -39,39 +39,26 @@
 	"homepage": "https://github.com/ljharb/coauthors#readme",
 	"dependencies": {
 		"commit-to-co-authors": "^0.1.0",
-		"pargs": "^1.0.0"
+		"pargs": "^1.4.2"
 	},
 	"engines": {
 		"node": "^22.20 || ^24.10 || >= 25"
 	},
 	"devDependencies": {
-		"@ljharb/eslint-config": "^21.2.0",
+		"@ljharb/eslint-config": "^22.2.3",
 		"@ljharb/tsconfig": "^0.3.2",
-		"@types/node": "^22.18.13",
-		"@types/tape": "^5.8.1",
-		"auto-changelog": "^2.5.0",
-		"c8": "^10.1.3",
-		"encoding": "^0.1.13",
-		"eslint": "^8.8.0",
-		"esmock": "^2.7.3",
+		"@types/node": "^22.19.21",
+		"auto-changelog": "^2.6.0",
+		"c8": "^11.0.0",
+		"eslint": "^10.5.0",
+		"esmock": "^2.7.6",
 		"in-publish": "^2.0.1",
-		"npmignore": "^0.3.1",
+		"jiti": "^0.0.0",
+		"npmignore": "^0.3.5",
 		"safe-publish-latest": "^2.0.0",
-		"tape": "^5.9.0",
+		"tape": "^5.10.2",
 		"typescript": "next"
 	},
-	"c8": {
-		"all": true,
-		"reporters": [
-			"html",
-			"text",
-			"lcov"
-		],
-		"exclude": [
-			"coverage",
-			"./pargs.mjs"
-		]
-	},
 	"auto-changelog": {
 		"output": "CHANGELOG.md",
 		"template": "keepachangelog",
@@ -83,7 +70,8 @@
 	"publishConfig": {
 		"ignore": [
 			".github/workflows",
-			".eslintrc",
+			"eslint.config.mjs",
+			".nycrc",
 			"test"
 		]
 	}

package/results.mjs

@@ -4,19 +4,18 @@ import { commitToCoAuthors } from 'commit-to-co-authors';
 
 import getDefaultBranch from './getDefaultBranch.mjs';
 
-/** @type {(remote: string) => Set<string>} */
+/** @param {string} remote */
 export default function getResults(remote) {
 	const defaultBranch = getDefaultBranch(remote);
 
 	const logCommitters = `${execSync(`git shortlog -sne ${remote}/${defaultBranch}..HEAD`)}`;
 	const mappedLogCommitters = logCommitters.matchAll(/\t(?<author>.*)$/gm)
-	// @ts-expect-error waiting on https://github.com/microsoft/TypeScript/pull/58222
-		.map(/** @type {(m: { groups: { author: string } }) => string} */ ({ groups: { author } }) => author);
-	/** @type {Set<string>} */
+		// @ts-expect-error TODO: file TS bug about `groups` always being present when a group is in the regex
+		.map((x) => x.groups.author);
+
 	const fromLogs = new Set(mappedLogCommitters);
 
 	const logText = `${execSync(`git log --no-expand-tabs --pretty=full ${remote}/${defaultBranch}..HEAD`)}`;
-	/** @type {Set<string>} */
 	const fromMsgs = new Set(commitToCoAuthors(logText).map(({ name, email }) => `${name} <${email}>`));
 
 	return fromMsgs.union(fromLogs);

package/validateRemote.mjs

@@ -1,21 +1,21 @@
 import { execSync } from 'child_process';
 
-/** @type {(remote: string, cwd?: string) => string | { __proto__: null, error: string }} */
+/** @type {(remote: string, cwd?: string) => string | { toString(): string }} */
 export default function validateRemote(remote, cwd = process.cwd()) {
 	if (remote === '' || remote.includes(' ')) {
-		return {
+		return /** @type {{ toString(): string }} */ ({
 			__proto__: null,
-			error: 'Remote name must not be empty, nor contain spaces.',
-		};
+			toString() { return 'Remote name must not be empty, nor contain spaces.'; },
+		});
 	}
 
 	const allRemotes = `${execSync('git remote', { cwd })}`.split('\n');
 
 	if (!allRemotes.includes(remote)) {
-		return {
+		return /** @type {{ toString(): string }} */ ({
 			__proto__: null,
-			error: `Remote \`${remote}\` does not exist; check \`git remote\` output`,
-		};
+			toString() { return `Remote \`${remote}\` does not exist; check \`git remote\` output`; },
+		});
 	}
 
 	return remote;

package/help.txt

@@ -1,4 +0,0 @@
-Usage:
-co-authors <remote>
-
-`remote` defaults to `origin`.