-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
302 lines (260 loc) · 9.72 KB
/
index.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
const resolveFrom = require('resolve-from');
const dedent = require('dedent');
const {promisify} = require('util');
const _ = require('lodash');
const globby = require('globby');
const readFile = promisify(require('fs').readFile.bind(require('fs')));
const execa = require('execa');
const moment = require('moment');
const log = require('./src/log');
const processLimitedLogged = require('./src/process-limited-logged');
// TODO: Should this ditch ESLint and use https://github.com/estools/esquery directly?
// That would require the user specifying babel config. ESQuery takes an AST. Currently, ESLint handles parsing.
// TODO: The type around Commit is sloppy.
/* eslint-disable max-len */
/**
* @param {object} options
* @param {string} options.astSelector
* @param {boolean} options.survey
* @param {string[]} options.paths
* @param {string | undefined} options.after
* @return {Promise<Omit<import("./types").Commit, 'filePath'>[] | {patternInstanceCount: number; filesWithInstanceCount: number, totalFilesSearchedCount: number; sampleFilesWithPattern: string[]}>}
*/
/* eslint-enable max-len */
async function queryPatternAge(options) {
const files = await log.logPhase(
{phase: 'finding files via globby', level: 'debug', ..._.pick(options, 'paths')},
() => globby(options.paths, {
// This is probably not necessary for correctness, because we filter out eslint-ignored files later.
// But, for performance, let's omit ignorable files as early as possible.
gitignore: true
})
);
const eslintMainPath = getEslintPath();
/** @type {import("eslint")} */
const {CLIEngine, Linter} = require(eslintMainPath);
const cliEngine = new CLIEngine({});
const sampleFileCount = 10;
const eslintReport = await log.logPhase(
{
phase: 'running ESLint on files',
level: 'debug',
countFiles: files.length,
..._.pick(options, 'astSelector'),
sampleFiles: _.take(files, sampleFileCount)
},
() => getEslintReports(cliEngine, Linter, files, options.astSelector)
);
log.trace({eslintReport});
const locations = getLocations(eslintReport);
log.trace({locations});
if (options.survey) {
const patternInstanceCount = _(locations)
.mapValues('length')
.values()
.sum();
const filesWithInstances = Object.keys(locations);
return {
patternInstanceCount,
filesWithInstanceCount: filesWithInstances.length,
sampleFilesWithPattern: getSample(filesWithInstances, sampleFileCount),
totalFilesSearchedCount: files.length
};
}
const gitCommits = await getGitCommits(locations);
const sortedGitCommits = _.sortBy(gitCommits, 'timestampS');
if (!options.after) {
return sortedGitCommits;
}
const afterTimestampS = moment(options.after, 'YYYY-M-D').unix();
return _(gitCommits)
.filter(({timestampS}) => timestampS >= afterTimestampS)
.sortBy('timestampS')
.value();
}
/**
* To avoid randomness which would break tests, be consistent when running from unit tests.
* This is a little naughty, I know. :)
*
* @template T
* @param {T[]} items
* @param {number} size
* @returns {T[]}
*/
function getSample(items, size) {
return process.env.NODE_ENV === 'test' ? items.slice(0, size) : _.sampleSize(items, size);
}
/**
* @param {ReturnType<typeof getLocations>} locations
* @returns {Promise<Record<string, Omit<import("./types").Commit, 'filePath'>>>}
*/
async function getGitCommits(locations) {
/**
* @param {import('type-fest').ValueOf<typeof locations>} locationsForFile
* @param {string} filePath
* @returns
*/
async function execGitForLocation(locationsForFile, filePath) {
const locationParams = _(locationsForFile)
.map(({line, endLine}) => ['-L', `${line},${endLine}`])
.flatten()
.value();
const commandArgs = ['blame', filePath, ...locationParams, '--porcelain'];
const command = 'git';
const {stdout: gitResults} = await execa(command, commandArgs);
const gitHashLength = 40;
// I don't know how to declare this inline.
/** @type {Omit<import("./types").Commit, 'count' | 'files'>[]} */
const initialReducerValue = [];
// TODO: To improve accuracy of results, emit a count of how often each commit appears in the blame, instead of
// assuming that all commits occur equally often.
return gitResults
.split('\n')
.map(line => {
// I don't know which assumptions about the git output are safe to make.
const firstSpaceIndex = line.indexOf(' ');
const firstEntry = line.substring(0, firstSpaceIndex);
if (firstEntry.length === gitHashLength) {
return {
label: 'hash',
value: firstEntry
};
}
return {
label: firstEntry,
value: line.substring(firstSpaceIndex + 1)
};
}).reduce((acc, line, index, lines) => {
if (line.label !== 'hash' || _.find(acc, {hash: line.value})) {
return acc;
}
const linesAfterThisOne = lines.slice(index);
/**
* @param {string} label
*/
function demandLine(label) {
const foundLine = _.find(linesAfterThisOne, {label});
if (!foundLine) {
throw new Error('Bug in this tool: did not find expected output in git blame.');
}
return foundLine;
}
return [...acc, {
hash: line.value,
filePath,
command: `${command} ${commandArgs.join(' ')}`,
timestampS: Number(demandLine('author-time').value),
author: demandLine('author').value
}];
}, initialReducerValue);
}
const commits = await processLimitedLogged(
{phase: 'getting git timestamps', level: 'debug', countFiles: _.size(locations)},
locations,
/** @ts-ignore I think this is just because I can't figure out how to have a @template extend another type. */
execGitForLocation
);
log.debug({commits});
return _(commits)
.flattenDeep()
.groupBy('hash')
.mapValues(commits => ({
count: commits.length,
files: _.map(commits, 'filePath'),
commands: _.map(commits, 'command'),
..._.omit(commits[0], 'filePath', 'command', 'count', 'files')
}))
.value();
}
/**
*
* @template V
* @param {Record<string, V>} object
* @param {(v: V, k: string) => boolean} predicate
* @returns {Record<string, V>}
*/
function filterValues(object, predicate) {
return _.reduce(object, (acc, val, key) => {
if (predicate(val, key)) {
return {...acc, [key]: val};
}
return acc;
}, {});
}
/**
* @param {{[filePath: string]: import("eslint").Linter.LintMessage[]}} eslintReport
*/
function getLocations(eslintReport) {
return filterValues(_.mapValues(
eslintReport,
messages =>
_(messages)
// If the user has disables for custom rules, like "eslint-disable my-rule", that rule's config will not be
// found. Those errors don't matter for our purposes, so we'll ignore them.
.filter({ruleId: 'no-restricted-syntax'})
.map(message => _.pick(message, ['line', 'endLine']))
.value()
), violations => Boolean(violations.length));
}
function getEslintPath() {
try {
return resolveFrom(process.cwd(), 'eslint');
} catch (e) {
const err = new Error(dedent`
eslint-bankruptcy could not find an eslint instance to run. To resolve this:
1. Run this command from a directory in which "require('eslint')" works.
2. Pass an eslint instance to use.
3. Pass a directory from which to resolve eslint.
`);
// @ts-ignore I'm fine assigning to err.originalError even though it doesn't exist on the Error type.
err.originalError = e;
throw err;
}
}
/**
*
* @param {import("eslint").CLIEngine} cliEngine
* @param {{new(): import("eslint").Linter}} Linter
* @param {string[]} files
* @param {string} astSelector
* @return {Promise<{[filePath: string]: import("eslint").Linter.LintMessage[]}>}
*/
async function getEslintReports(cliEngine, Linter, files, astSelector) {
const pairs = await Promise.all(_(files)
.reject(filePath => cliEngine.isPathIgnored(filePath))
.map(async filePath => {
const linter = new Linter();
const config = cliEngine.getConfigForFile(filePath);
config.rules = {
'no-restricted-syntax': [2, astSelector]
};
// If the config specifies a parser, like for @typescript-eslint, we need to manually register it.
if (config.parser) {
// https://eslint.org/docs/developer-guide/nodejs-api#linterdefineparser
linter.defineParser(config.parser, require(config.parser));
}
// Normally, this is a good setting. However, given that we set rules to be solely no-restricted-syntax, we may
// see disable directives that are now unused.
//
// @ts-expect-error This type is missing, but should be there.
config.reportUnusedDisableDirectives = false;
log.trace({filePath, config}, 'Linting');
const fileContents = await readFile(filePath, 'utf8');
const lintReport = linter.verify(fileContents, config);
// If the eslint config uses special preprocessors to handle files like .md files, then when we lint here,
// we'll get a parse error. In this case, ruleId will be null.
const parseError = _.find(lintReport, {ruleId: null});
if (parseError) {
throw new Error(dedent`File '${filePath}' could not be parsed.
If you want it to be parsed, then resolve the error that ESLint generated:
"${parseError.message}"
If you meant to ignore this file, update your 'paths' param to omit it.
`);
}
return [filePath, lintReport];
})
.value()
);
return _.fromPairs(pairs);
}
module.exports = queryPatternAge;