Function cleanCommitMessage

source/helpers/clean-commit-message.ts:5–42

(
	message: string,
	closingKeywords = false,
	excludeUsers: string[] = [],
)

}

export default function cleanCommitMessage(
	message: string,
	closingKeywords = false,
	excludeUsers: string[] = [],
): string {
	const preservedContent = new Set();

	// This method ensures that "Co-authored-by" capitalization doesn't affect deduplication.
	// Also drops co-authors whose GitHub privacy email username is in `excludeUsers`.
	for (const match of message.matchAll(/co-authored-by: (?<author>[^\n]+)/gi)) {
		const {author} = match.groups!;
		const username = parseUserFromEmail(author);
		if (username && excludeUsers.includes(username)) {
			continue;
		}

		preservedContent.add('Co-authored-by: ' + author);
	}

	// Preserve "Signed-off-by" lines (DCO signoffs)
	// https://github.com/refined-github/refined-github/issues/9330#issuecomment-4361024401
	for (const match of message.matchAll(/signed-off-by: (?<signer>[^\n]+)/gi)) {
		const {signer} = match.groups!;
		preservedContent.add('Signed-off-by: ' + signer);
	}

	if (!closingKeywords) {
		return [...preservedContent].join('\n');
	}

	// Preserve closing issues numbers when a PR is merged into a non-default branch since GitHub doesn't close them #4531
	// https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue
	for (const [line] of message.matchAll(/(?:fix|fixe|close|resolve)(?:s|d)?\s+(?:#\d+|https?:\S+)/gi)) {
		preservedContent.add(line);
	}

	return [...preservedContent].join('\n');
}