@ljharb/coauthors 1.0.0 → 2.0.1

package/CHANGELOG.md

@@ -5,6 +5,38 @@ 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
+
+- [Refactor] use `pargs` package [`4b46ee9`](https://github.com/ljharb/coauthors/commit/4b46ee9f6ddefe5b936190d32bff54bd46eb45f2)
+- [Dev Deps] update `@ljharb/eslint-config`, `@ljharb/tsconfig@latest`, `@types/node`, `@types/tape`, `auto-changelog`, `c8`, `esmock`, `tape` [`caede0a`](https://github.com/ljharb/coauthors/commit/caede0a44cc1ce0076e8ac01d5a5d75c92e43234)
+- [Dev Deps] update `@types/node`, `esmock` [`09becac`](https://github.com/ljharb/coauthors/commit/09becacad05b12e30206f82f95a2f052789a05d7)
+- [meta] fix binary name [`9db7fac`](https://github.com/ljharb/coauthors/commit/9db7fac087158cc3b5fe9476c670e04aa9546f76)
+- [Tests] replace `aud` with `npm audit` [`59ad63a`](https://github.com/ljharb/coauthors/commit/59ad63aaeafb10492ba1ea010809b314e3942a8a)
+- [Dev Deps] update `@types/node` [`00ffe27`](https://github.com/ljharb/coauthors/commit/00ffe270c1c21fceecb79424eeedc122a8ade21b)
+- [Breaking] tighten engines requirements [`e33b6b0`](https://github.com/ljharb/coauthors/commit/e33b6b0e188aff796d7bc75ec7e62d804b759811)
+- [Dev Deps] add missing peer dep [`5c5483b`](https://github.com/ljharb/coauthors/commit/5c5483b245b47e39beb5ff8e6799039442ba0a28)
+
 ## v1.0.0 - 2024-07-16
 
 ### Commits

package/README.md

@@ -20,7 +20,7 @@ coauthors # if installed and in the PATH
 ```sh
 $ coauthors --help
 Usage:
-commit-to-co-authors <remote>
+co-authors <remote>
 
 `remote` defaults to `origin`.
 ```

package/bin.mjs

@@ -1,52 +1,27 @@
 #! /usr/bin/env node
 
-import { readFile } from 'fs/promises';
-import path from 'path';
-
 import validateRemote from './validateRemote.mjs';
 import getResults from './results.mjs';
 
-import pargs from './pargs.mjs';
-
-async function getHelpText() {
-	return `${await readFile(path.join(import.meta.dirname, './help.txt'), 'utf-8')}`;
-}
+import pargs from 'pargs';
 
 const {
-	values: { help },
+	help,
 	positionals,
 	errors,
-} = await pargs(
-	import.meta.filename,
-	{
-		options: {
-			help: { type: 'boolean' },
-		},
-		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}`;
 }
 
-if (help || errors.length > 0) {
-	const helpText = await getHelpText();
-	if (errors.length === 0) {
-		console.log(helpText);
-	} else {
-		console.error(`${helpText}${errors.length === 0 ? '' : '\n'}`);
-
-		process.exitCode ||= parseInt('1'.repeat(errors.length), 2);
-		errors.forEach((error) => console.error(error));
-	}
-
-	process.exit();
-}
+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": "1.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,12 +11,12 @@
 		"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'",
 		"test": "npm run tests-only",
-		"posttest": "aud --production",
+		"posttest": "npx npm@\">= 10.2\" audit --production",
 		"version": "auto-changelog && git add CHANGELOG.md",
 		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
 	},
@@ -38,39 +38,27 @@
 	},
 	"homepage": "https://github.com/ljharb/coauthors#readme",
 	"dependencies": {
-		"commit-to-co-authors": "^0.1.0"
+		"commit-to-co-authors": "^0.1.0",
+		"pargs": "^1.4.2"
 	},
 	"engines": {
-		"node": ">= 22.4"
+		"node": "^22.20 || ^24.10 || >= 25"
 	},
 	"devDependencies": {
-		"@ljharb/eslint-config": "^21.1.1",
-		"@ljharb/tsconfig": "^0.2.0",
-		"@types/node": "^20.14.10",
-		"@types/tape": "^5.6.4",
-		"aud": "^2.0.4",
-		"auto-changelog": "^2.4.0",
-		"c8": "^10.1.2",
-		"eslint": "^8.8.0",
-		"esmock": "^2.6.6",
+		"@ljharb/eslint-config": "^22.2.3",
+		"@ljharb/tsconfig": "^0.3.2",
+		"@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.8.1",
+		"tape": "^5.10.2",
 		"typescript": "next"
 	},
-	"c8": {
-		"all": true,
-		"reporters": [
-			"html",
-			"text",
-			"lcov"
-		],
-		"exclude": [
-			"coverage",
-			"./pargs.mjs"
-		]
-	},
 	"auto-changelog": {
 		"output": "CHANGELOG.md",
 		"template": "keepachangelog",
@@ -82,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:
-commit-to-co-authors <remote>
-
-`remote` defaults to `origin`.

package/pargs.mjs

@@ -1,119 +0,0 @@
-import { parseArgs } from 'util';
-import { realpathSync } from 'fs';
-
-/** @typedef {import('util').ParseArgsConfig} ParseArgsConfig */
-
-/** @typedef {(Error | TypeError) & { code: 'ERR_PARSE_ARGS_UNKNOWN_OPTION' | 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE' | 'ERR_INVALID_ARG_TYPE' | 'ERR_INVALID_ARG_VALUE' | 'ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL'}} ParseArgsError */
-
-/** @type {(e: unknown) => e is ParseArgsError} */
-function isParseArgsError(e) {
-	return !!e
-		&& typeof e === 'object'
-		&& 'code' in e
-		&& (
-			e.code === 'ERR_PARSE_ARGS_UNKNOWN_OPTION'
-			|| e.code === 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
-			|| e.code === 'ERR_INVALID_ARG_TYPE'
-			|| e.code === 'ERR_INVALID_ARG_VALUE'
-			|| e.code === 'ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL'
-		);
-}
-/** @typedef {Omit<ParseArgsConfig, 'args' | 'strict' | 'allowPositionals'> & { allowPositionals?: boolean | number }} PargsConfig */
-
-/** @type {(entrypointPath: ImportMeta['filename'], obj: PargsConfig) => Promise<{ errors: string[] } & ReturnType<typeof parseArgs>>} */
-export default async function pargs(entrypointPath, obj) {
-	const argv = process.argv.flatMap((arg) => {
-		try {
-			const realpathedArg = realpathSync(arg);
-			if (
-				realpathedArg === process.execPath
-				|| realpathedArg === entrypointPath
-			) {
-				return [];
-			}
-		} catch (e) { /**/ }
-		return arg;
-	});
-
-	if ('help' in obj) {
-		throw new TypeError('The "help" option is reserved');
-	}
-
-	/** @type {ParseArgsConfig & { tokens: true }} */
-	const newObj = {
-		args: argv,
-		...obj,
-		options: {
-			...obj.options,
-			help: {
-				default: false,
-				type: 'boolean',
-			},
-		},
-		tokens: true,
-		// @ts-expect-error blocked on @types/node v22
-		allowNegative: true,
-		allowPositionals: typeof obj.allowPositionals !== 'undefined',
-		strict: true,
-	};
-
-	const errors = [];
-
-	try {
-		const { tokens, ...results } = parseArgs(newObj);
-
-		const posCount = typeof obj.allowPositionals === 'number' ? obj.allowPositionals : obj.allowPositionals ? Infinity : 0;
-		if (results.positionals.length > posCount) {
-			errors.push(`Only ${posCount} positional arguments allowed; got ${results.positionals.length}`);
-		}
-
-		/** @typedef {Extract<typeof tokens[number], { kind: 'option' }>} OptionToken */
-		const optionTokens = tokens.filter(/** @type {(token: typeof tokens[number]) => token is OptionToken} */ (token) => token.kind === 'option');
-
-		const bools = obj.options ? Object.entries(obj.options).filter(([, { type }]) => type === 'boolean') : [];
-		const boolMap = new Map(bools);
-		for (let i = 0; i < optionTokens.length; i += 1) {
-			const { name, value } = optionTokens[i];
-			if (boolMap.has(name) && typeof value !== 'boolean' && typeof value !== 'undefined') {
-				errors.push(`Error: Argument --${name} must be a boolean`);
-			}
-		}
-
-		const passedArgs = new Set(optionTokens.map(({ name, rawName }) => (rawName === '--no-help' ? rawName : name)));
-
-		const groups = Object.groupBy(passedArgs, (x) => x.replace(/^no-/, ''));
-		for (let i = 0; i < bools.length; i++) {
-			const [key] = bools[i];
-			if ((groups[key]?.length ?? 0) > 1) {
-				errors.push(`Error: Arguments \`--${key}\` and \`--no-${key}\` are mutually exclusive`);
-			}
-			if (passedArgs.has(`no-${key}`)) {
-				// @ts-expect-error
-				results.values[key] = !results.values[`no-${key}`];
-			}
-			// @ts-expect-error
-			delete results.values[`no-${key}`];
-		}
-
-		const knownOptions = obj.options ? Object.keys(obj.options) : [];
-		const unknownArgs = knownOptions.length > 0 ? passedArgs.difference(new Set(knownOptions)) : passedArgs;
-		if (unknownArgs.size > 0) {
-			errors.push(`Error: Unknown option(s): ${Array.from(unknownArgs, (x) => `\`${x}\``).join(', ')}`);
-		}
-
-		return {
-			errors,
-			...results,
-			...obj.tokens && { tokens },
-		};
-	} catch (e) {
-		if (isParseArgsError(e)) {
-			return {
-				values: {},
-				positionals: [],
-				errors: [`Error: ${e.message}`],
-			};
-		}
-		throw e;
-	}
-}