mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
08feb7fc79
* remove contributors from package.json in favour of AUTHORS The contributors section of our package.json is _very_ long and manually updating can (?) be a pain. I took a leaf out of nodejs's book and copied their update-authors script [1]. [1]: https://github.com/nodejs/node/blob/master/tools/update-authors.js * remove some of my many emails * add a couple more mail mappings * get lint passing * add instruction to update-authors Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
106 lines
3.1 KiB
JavaScript
106 lines
3.1 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
// Attribution:
|
|
// This file is based on https://github.com/nodejs/node/blob/master/tools/update-authors.js.
|
|
// It is licensed according to https://github.com/nodejs/node/blob/master/LICENSE
|
|
|
|
// 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 {
|
|
constructor () {
|
|
this._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
|
|
|
|
// Replaced Name <original@example.com>
|
|
const match1 = line.match(/^([^<]+)\s+(<[^>]+>)$/)
|
|
if (match1) {
|
|
mailmap.set(match1[2], { author: match1[1] })
|
|
continue
|
|
}
|
|
// <replaced@example.com> <original@example.com>
|
|
const match2 = line.match(/^<([^>]+)>\s+(<[^>]+>)$/)
|
|
if (match2) {
|
|
mailmap.set(match2[2], { email: match2[1] })
|
|
continue
|
|
}
|
|
// Replaced Name <replaced@example.com> <original@example.com>
|
|
const match3 = line.match(/^([^<]+)\s+(<[^>]+>)\s+(<[^>]+>)$/)
|
|
if (match3) {
|
|
mailmap.set(match3[3], {
|
|
author: match3[1], email: match3[2]
|
|
})
|
|
continue
|
|
}
|
|
// Replaced Name <replaced@example.com> Original Name <original@example.com>
|
|
const match4 = line.match(/^([^<]+)\s+(<[^>]+>)\s+([^<]+)\s+(<[^>]+>)$/)
|
|
if (match4) {
|
|
mailmap.set(match4[3] + '\0' + match4[4], {
|
|
author: match4[1], email: match4[2]
|
|
})
|
|
continue
|
|
}
|
|
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
|
|
|
|
const { author, email } = match.groups
|
|
|
|
if (seen.has(email) ||
|
|
/@chromium\.org/.test(email) ||
|
|
/greenkeeper\[bot\]/.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')
|
|
})
|