node/tools/update-authors.js
Anna Henningsen f9d026dbb7 tools: make mailmap processing for author list case-insensitive
This is to accommodate Myles Borins otherwise ending up with
multiple entries due to different casing in the email 🙂

PR-URL: https://github.com/nodejs/node/pull/29608
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-09-24 21:50:59 -07:00

97 lines
2.9 KiB
JavaScript
Executable File

#!/usr/bin/env node
// Usage: tools/update-author.js [--dry]
// Passing --dry will redirect output to stdout rather than write to 'AUTHORS'.
'use strict';
const { spawn } = require('child_process');
const path = require('path');
const fs = require('fs');
const readline = require('readline');
class CaseIndifferentMap {
_map = new Map();
get(key) { return this._map.get(key.toLowerCase()); }
set(key, value) { return this._map.set(key.toLowerCase(), value); }
}
const log = spawn(
'git',
// Inspect author name/email and body.
['log', '--reverse', '--format=Author: %aN <%aE>\n%b'], {
stdio: ['inherit', 'pipe', 'inherit']
});
const rl = readline.createInterface({ input: log.stdout });
let output;
if (process.argv.includes('--dry'))
output = process.stdout;
else
output = fs.createWriteStream('AUTHORS');
output.write('# Authors ordered by first contribution.\n\n');
const mailmap = new CaseIndifferentMap();
{
const lines = fs.readFileSync(path.resolve(__dirname, '../', '.mailmap'),
{ encoding: 'utf8' }).split('\n');
for (let line of lines) {
line = line.trim();
if (line.startsWith('#') || line === '') continue;
let match;
// Replaced Name <original@example.com>
if (match = line.match(/^([^<]+)\s+(<[^>]+>)$/)) {
mailmap.set(match[2], { author: match[1] });
// <replaced@example.com> <original@example.com>
} else if (match = line.match(/^<([^>]+)>\s+(<[^>]+>)$/)) {
mailmap.set(match[2], { email: match[1] });
// Replaced Name <replaced@example.com> <original@example.com>
} else if (match = line.match(/^([^<]+)\s+(<[^>]+>)\s+(<[^>]+>)$/)) {
mailmap.set(match[3], {
author: match[1], email: match[2]
});
// Replaced Name <replaced@example.com> Original Name <original@example.com>
} else if (match =
line.match(/^([^<]+)\s+(<[^>]+>)\s+([^<]+)\s+(<[^>]+>)$/)) {
mailmap.set(match[3] + '\0' + match[4], {
author: match[1], email: match[2]
});
} else {
console.warn('Unknown .mailmap format:', line);
}
}
}
const seen = new Set();
// Support regular git author metadata, as well as `Author:` and
// `Co-authored-by:` in the message body. Both have been used in the past
// to indicate multiple authors per commit, with the latter standardized
// by GitHub now.
const authorRe =
/(^Author:|^Co-authored-by:)\s+(?<author>[^<]+)\s+(?<email><[^>]+>)/i;
rl.on('line', (line) => {
const match = line.match(authorRe);
if (!match) return;
let { author, email } = match.groups;
const replacement = mailmap.get(author + '\0' + email) || mailmap.get(email);
if (replacement) {
({ author, email } = { author, email, ...replacement });
}
if (seen.has(email) ||
/@chromium\.org/.test(email) ||
email === '<erik.corry@gmail.com>') {
return;
}
seen.add(email);
output.write(`${author} ${email}\n`);
});
rl.on('close', () => {
output.end('\n# Generated by tools/update-authors.js\n');
});