forked from nodejs/node-v0.x-archive
-
Notifications
You must be signed in to change notification settings - Fork 0
/
update-authors.js
144 lines (119 loc) · 4.47 KB
/
update-authors.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.
/*
* This script updates the AUTHORS so that it contains a list of contributors'
* names ordered alphabetically. The sorting algorithm used is stable, see
* function "stableSort" in tools/common.js.
*/
'use strict';
var child_process = require('child_process');
var fs = require('fs');
var assert = require('assert');
var util = require('util');
var path = require('path');
var os = require('os');
var debug = util.debuglog('update-authors');
var commonTools = require(path.join(__dirname, './common.js'));
// Use '%aN <%aE>' and not '%an <%ae>' as we want to have git log use the
// .mailmap file.
var GIT_LOG_COMMAND_ARGS = ['log', "--format='%aN <%aE>'"];
var MAILMAP_FILE = '.mailmap';
var OPTS = processCmdLineArgs();
var AUTHORS_FILE = OPTS.authorsFile || 'AUTHORS';
var PLATFORM_AGNOSTIC_EOL = /\r|\n|\r\n/;
var authorsMap = {};
function usage() {
console.log('Usage: [NODE_DEBUG=update-authors] ./node update-authors.js ' +
' [-a AUTHORS-FILE]');
process.exit(1);
}
function processCmdLineArgs() {
var cmdLineOpts = {};
var cmdLineArgs = process.argv.splice(2);
for (var i = 0; i < cmdLineArgs.length; ++i) {
if (cmdLineArgs[i] === '-a') {
if (!cmdLineArgs[++i]) {
usage();
} else {
cmdLineOpts.authorsFile = cmdLineArgs[i];
}
} else {
usage();
}
}
return cmdLineOpts;
}
function generateAuthorsFile(authorsFilePath, cb) {
assert(typeof authorsFilePath === 'string',
'authorsFilePath must be a string');
var sortedAuthorsNames = commonTools.stableSort(Object.keys(authorsMap));
var authorsFileContent = sortedAuthorsNames.join('\n') + '\n';
fs.writeFile(authorsFilePath, authorsFileContent, cb);
}
var latestAuthorsLineChunk = '';
function addAuthors(authors) {
assert(typeof authors === 'string', 'authors must be a string');
var authors = (latestAuthorsLineChunk + authors).split(PLATFORM_AGNOSTIC_EOL);
latestAuthorsLineChunk = '';
authors.forEach(function eachAuthor(author) {
if (author && author.length > 0) {
var matches = author.match(/^'([^<>]*)\s+<.*>'$/);
if (matches) {
var authorName = matches[1];
debug('MATCHING: ' + authorName);
authorsMap[authorName] = 1;
} else {
debug('NOT MATCHING: ' + author);
latestAuthorsLineChunk = author;
}
}
});
}
function loadAuthorsFromGitLog(cb) {
var gitLog = child_process.spawn('git', GIT_LOG_COMMAND_ARGS);
gitLog.on('close', function onGitLogClose(exitCode, signal) {
if (exitCode === 0 && signal === null) {
debug('NB AUTHORS:' + Object.keys(authorsMap).length);
generateAuthorsFile(AUTHORS_FILE, function onAuthorsFileGenerated(err) {
if (err) {
return cb(new Error('Error when generating authors file:', err));
} else {
console.log('Authors file generated successfully!');
}
});
}
});
gitLog.on('error', function onGitLogError(err) {
var errorMsg = util.format('Error when executing command %s: %s',
GIT_LOG_COMMAND, err);
return cb(new Error(errorMsg));
});
gitLog.stdout.on('data', function onGitLogData(data) {
addAuthors(data.toString());
});
}
loadAuthorsFromGitLog(function done(err) {
if (err) {
console.error('Error when updating authors file:', err);
} else {
console.log('Updated authors file successfully!');
}
});