forked from yarnpkg/yarn
/
fix.js
353 lines (303 loc) · 11.2 KB
/
fix.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
/* @flow */
import {MANIFEST_FIELDS} from '../../constants';
import type {Reporter} from '../../reporters/index.js';
import {isValidBin, isValidLicense} from './util.js';
import {normalizePerson, extractDescription} from './util.js';
import {hostedGitFragmentToGitUrl} from '../../resolvers/index.js';
import inferLicense from './infer-license.js';
import * as fs from '../fs.js';
const semver = require('semver');
const path = require('path');
const url = require('url');
const VALID_BIN_KEYS = /^[a-z0-9_-]+$/i;
const LICENSE_RENAMES: {[key: string]: ?string} = {
'MIT/X11': 'MIT',
X11: 'MIT',
};
type Dict<T> = {
[key: string]: T,
};
type WarnFunction = (msg: string) => void;
export default (async function(
info: Dict<mixed>,
moduleLoc: string,
reporter: Reporter,
warn: WarnFunction,
looseSemver: boolean,
): Promise<void> {
const files = await fs.readdir(moduleLoc);
// clean info.version
if (typeof info.version === 'string') {
info.version = semver.clean(info.version, looseSemver) || info.version;
}
// if name or version aren't set then set them to empty strings
info.name = info.name || '';
info.version = info.version || '';
// if the man field is a string then coerce it to an array
if (typeof info.man === 'string') {
info.man = [info.man];
}
// if the keywords field is a string then split it on any whitespace
if (typeof info.keywords === 'string') {
info.keywords = info.keywords.split(/\s+/g);
}
// if there's no contributors field but an authors field then expand it
if (!info.contributors && files.indexOf('AUTHORS') >= 0) {
const authorsFilepath = path.join(moduleLoc, 'AUTHORS');
const authorsFilestats = await fs.stat(authorsFilepath);
if (authorsFilestats.isFile()) {
let authors = await fs.readFile(authorsFilepath);
authors = authors
.split(/\r?\n/g) // split on lines
.map((line): string => line.replace(/^\s*#.*$/, '').trim()) // remove comments
.filter((line): boolean => !!line); // remove empty lines
info.contributors = authors;
}
}
// expand people fields to objects
if (typeof info.author === 'string' || typeof info.author === 'object') {
info.author = normalizePerson(info.author);
}
if (Array.isArray(info.contributors)) {
info.contributors = info.contributors.map(normalizePerson);
}
if (Array.isArray(info.maintainers)) {
info.maintainers = info.maintainers.map(normalizePerson);
}
// if there's no readme field then load the README file from the cwd
if (!info.readme) {
const readmeCandidates = files
.filter((filename): boolean => {
const lower = filename.toLowerCase();
return lower === 'readme' || lower.indexOf('readme.') === 0;
})
.sort((filename1, filename2): number => {
// favor files with extensions
return filename2.indexOf('.') - filename1.indexOf('.');
});
for (const readmeFilename of readmeCandidates) {
const readmeFilepath = path.join(moduleLoc, readmeFilename);
const readmeFileStats = await fs.stat(readmeFilepath);
if (readmeFileStats.isFile()) {
info.readmeFilename = readmeFilename;
info.readme = await fs.readFile(readmeFilepath);
break;
}
}
}
// if there's no description then take the first paragraph from the readme
if (!info.description && info.readme) {
const desc = extractDescription(info.readme);
if (desc) {
info.description = desc;
}
}
// support array of engine keys
if (Array.isArray(info.engines)) {
const engines = {};
for (const str of info.engines) {
if (typeof str === 'string') {
const [name, ...patternParts] = str.trim().split(/ +/g);
engines[name] = patternParts.join(' ');
}
}
info.engines = engines;
}
// if the repository field is a string then assume it's a git repo and expand it
if (typeof info.repository === 'string') {
info.repository = {
type: 'git',
url: info.repository,
};
}
const repo = info.repository;
// explode info.repository.url if it's a hosted git shorthand
if (repo && typeof repo === 'object' && typeof repo.url === 'string') {
repo.url = hostedGitFragmentToGitUrl(repo.url, reporter);
}
// allow bugs to be specified as a string, expand it to an object with a single url prop
if (typeof info.bugs === 'string') {
info.bugs = {url: info.bugs};
}
// normalize homepage url to http
if (typeof info.homepage === 'string') {
const parts = url.parse(info.homepage);
parts.protocol = parts.protocol || 'http:';
if (parts.pathname && !parts.hostname) {
parts.hostname = parts.pathname;
parts.pathname = '';
}
info.homepage = url.format(parts);
}
// if the `bin` field is as string then expand it to an object with a single property
// based on the original `bin` field and `name field`
// { name: "foo", bin: "cli.js" } -> { name: "foo", bin: { foo: "cli.js" } }
if (typeof info.name === 'string' && typeof info.bin === 'string' && info.bin.length > 0) {
// Remove scoped package name for consistency with NPM's bin field fixing behaviour
const name = info.name.replace(/^@[^\/]+\//, '');
info.bin = {[name]: info.bin};
}
// Validate that the bin entries reference only files within their package, and that
// their name is a valid file name
if (typeof info.bin === 'object' && info.bin !== null) {
const bin: Object = info.bin;
for (const key of Object.keys(bin)) {
const target = bin[key];
if (!VALID_BIN_KEYS.test(key) || !isValidBin(target)) {
delete bin[key];
warn(reporter.lang('invalidBinEntry', info.name, key));
} else {
bin[key] = path.normalize(target);
}
}
} else if (typeof info.bin !== 'undefined') {
delete info.bin;
warn(reporter.lang('invalidBinField', info.name));
}
// bundleDependencies is an alias for bundledDependencies
if (info.bundledDependencies) {
info.bundleDependencies = info.bundledDependencies;
delete info.bundledDependencies;
}
let scripts: Object;
// dummy script object to shove file inferred scripts onto
if (info.scripts && typeof info.scripts === 'object') {
scripts = info.scripts;
} else {
scripts = {};
}
// if there's a server.js file and no start script then set it to `node server.js`
if (!scripts.start && files.indexOf('server.js') >= 0) {
scripts.start = 'node server.js';
}
// if there's a binding.gyp file and no install script then set it to `node-gyp rebuild`
if (!scripts.install && files.indexOf('binding.gyp') >= 0) {
scripts.install = 'node-gyp rebuild';
}
// set scripts if we've polluted the empty object
if (Object.keys(scripts).length) {
info.scripts = scripts;
}
const dirs = info.directories;
if (dirs && typeof dirs === 'object') {
const binDir = dirs.bin;
if (!info.bin && binDir && typeof binDir === 'string') {
const bin = (info.bin = {});
const fullBinDir = path.join(moduleLoc, binDir);
if (await fs.exists(fullBinDir)) {
for (const scriptName of await fs.readdir(fullBinDir)) {
if (scriptName[0] === '.') {
continue;
}
bin[scriptName] = path.join('.', binDir, scriptName);
}
} else {
warn(reporter.lang('manifestDirectoryNotFound', binDir, info.name));
}
}
const manDir = dirs.man;
if (!info.man && typeof manDir === 'string') {
const man = (info.man = []);
const fullManDir = path.join(moduleLoc, manDir);
if (await fs.exists(fullManDir)) {
for (const filename of await fs.readdir(fullManDir)) {
if (/^(.*?)\.[0-9]$/.test(filename)) {
man.push(path.join('.', manDir, filename));
}
}
} else {
warn(reporter.lang('manifestDirectoryNotFound', manDir, info.name));
}
}
}
delete info.directories;
// normalize licenses field
const licenses = info.licenses;
if (Array.isArray(licenses) && !info.license) {
let licenseTypes = [];
for (let license of licenses) {
if (license && typeof license === 'object') {
license = license.type;
}
if (typeof license === 'string') {
licenseTypes.push(license);
}
}
licenseTypes = licenseTypes.filter(isValidLicense);
if (licenseTypes.length === 1) {
info.license = licenseTypes[0];
} else if (licenseTypes.length) {
info.license = `(${licenseTypes.join(' OR ')})`;
}
}
const license = info.license;
// normalize license
if (license && typeof license === 'object') {
info.license = license.type;
}
// get license file
const licenseFile = files.find((filename): boolean => {
const lower = filename.toLowerCase();
return (
lower === 'license' || lower.startsWith('license.') || lower === 'unlicense' || lower.startsWith('unlicense.')
);
});
if (licenseFile) {
const licenseFilepath = path.join(moduleLoc, licenseFile);
const licenseFileStats = await fs.stat(licenseFilepath);
if (licenseFileStats.isFile()) {
const licenseContent = await fs.readFile(licenseFilepath);
const inferredLicense = inferLicense(licenseContent);
info.licenseText = licenseContent;
const license = info.license;
if (typeof license === 'string') {
if (inferredLicense && isValidLicense(inferredLicense) && !isValidLicense(license)) {
// some packages don't specify their license version but we can infer it based on their license file
const basicLicense = license.toLowerCase().replace(/(-like|\*)$/g, '');
const expandedLicense = inferredLicense.toLowerCase();
if (expandedLicense.startsWith(basicLicense)) {
// TODO consider doing something to notify the user
info.license = inferredLicense;
}
}
} else if (inferredLicense) {
// if there's no license then infer it based on the license file
info.license = inferredLicense;
} else {
// valid expression to refer to a license in a file
info.license = `SEE LICENSE IN ${licenseFile}`;
}
}
}
if (typeof info.license === 'string') {
// sometimes licenses are known by different names, reduce them
info.license = LICENSE_RENAMES[info.license] || info.license;
} else if (typeof info.readme === 'string') {
// the license might be at the bottom of the README
const inferredLicense = inferLicense(info.readme);
if (inferredLicense) {
info.license = inferredLicense;
}
}
// get notice file
const noticeFile = files.find((filename): boolean => {
const lower = filename.toLowerCase();
return lower === 'notice' || lower.startsWith('notice.');
});
if (noticeFile) {
const noticeFilepath = path.join(moduleLoc, noticeFile);
const noticeFileStats = await fs.stat(noticeFilepath);
if (noticeFileStats.isFile()) {
info.noticeText = await fs.readFile(noticeFilepath);
}
}
for (const dependencyType of MANIFEST_FIELDS) {
const dependencyList = info[dependencyType];
if (dependencyList && typeof dependencyList === 'object') {
delete dependencyList['//'];
for (const name in dependencyList) {
dependencyList[name] = dependencyList[name] || '';
}
}
}
});