| 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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378 | 1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
23
1
5
1
1
1
776
776
1
161
161
161
161
159
159
776
2
161
161
1
2
2
2
776
217
217
2
1
1
776
1
776
1
1
1
1
1
1
161
161
776
1
1
1
1
1
1
85
85
1
1
85
1
85
85
85
85
85
1
85
85
84
84
84
83
84
1
1
1
84
84
84
84
84
84
84
84
1
84
84
84
84
84
84
1
1
1
1
1
1
2
131
217
1
1
131
131
1
1
139
1
2
139
1
1
1
1
1
1
1
| const fs = require('fs');
const glob = require('glob');
const isBuiltInModule = require('is-builtin-module');
const syncExec = require('sync-exec');
const ora = require('ora');
const logSymbols = require('log-symbols');
const request = require('request');
const detective = require('detective');
const es6detective = require('detective-es6');
const colors = require('colors');
const argv = require('yargs').argv;
const packageJson = require('package-json');
require('./includes-polyfill');
/* File reader
* Return contents of given file
*/
let readFile = (path) => {
let content = fs.readFileSync(path, 'utf8');
return content;
};
/* Get installed modules
* Read dependencies array from package.json
*/
let getInstalledModules = () => {
let content = JSON.parse(readFile('package.json'));
let installedModules = [];
let dependencies = content.dependencies || {};
let devDependencies = content.devDependencies || {};
for (let key of Object.keys(dependencies)) {
installedModules.push({
name: key,
dev: false
});
}
for (let key of Object.keys(devDependencies)) {
installedModules.push({
name: key,
dev: true
});
}
return installedModules;
};
/* Get all js files
* Return path of all js files
*/
let getFiles = () => glob.sync('**/*.js', {ignore: ['node_modules/**/*']});
/* Check for valid string - to stop malicious intentions */
let isValidModule = ({name}) => {
let regex = new RegExp('^([a-z0-9-_]{1,})$');
return regex.test(name);
};
/* Find modules from file
* Returns array of modules from a file
*/
let getModulesFromFile = (path) => {
let content = fs.readFileSync(path, 'utf8');
let modules = [];
try {
modules = detective(content, {parse: {sourceType: 'module'}});
let es6modules = es6detective(content, {parse: {sourceType: 'module'}});
modules = modules.concat(es6modules);
modules = modules.filter((module) => isValidModule(module));
} catch (err) {
console.log(colors.red(`Could not parse ${path}. There is a syntax error in file`));
}
return modules;
};
/* Is test file?
* [.spec.js, .test.js] are supported test file formats
*/
let isTestFile = (name) => (name.endsWith('.spec.js') || name.endsWith('.test.js'));
/* Dedup similar modules
* Deduplicates list
* Ignores/assumes type of the modules in list
*/
let deduplicateSimilarModules = (modules) => {
let dedupedModules = [];
let dedupedModuleNames = [];
for (let module of modules) {
if (!dedupedModuleNames.includes(module.name)) {
dedupedModules.push(module);
dedupedModuleNames.push(module.name);
}
}
return dedupedModules;
};
/* Dedup modules
* Divide modules into prod and dev
* Deduplicates each list
*/
let deduplicate = (modules) => {
let dedupedModules = [];
let testModules = modules.filter(module => module.dev);
dedupedModules = dedupedModules.concat(deduplicateSimilarModules(testModules));
let prodModules = modules.filter(module => !module.dev);
dedupedModules = dedupedModules.concat(deduplicateSimilarModules(prodModules));
return dedupedModules;
};
/* Get used modules
* Read all .js files and grep for modules
*/
let getUsedModules = () => {
let files = getFiles();
let usedModules = [];
for (let fileName of files) {
let modulesFromFile = getModulesFromFile(fileName);
let dev = isTestFile(fileName);
for (let name of modulesFromFile) usedModules.push({name, dev});
}
usedModules = deduplicate(usedModules);
return usedModules;
};
/* Handle error
* Pretty error message for common errors
*/
let handleError = (err) => {
Eif (err.includes('E404')) {
console.log(colors.red('Module is not in the npm registry.'));
} else if (err.includes('ENOTFOUND')) {
console.log(colors.red('Could not connect to npm, check your internet connection!'));
} else console.log(colors.red(err));
};
/* Command runner
* Run a given command
*/
let runCommand = (command) => {
let response = syncExec(command);
if (response.stderr) {
console.log();
handleError(response.stderr);
}
return !response.status; // status = 0 for success
};
/* Show pretty outputs
* Use ora spinners to show what's going on
*/
let startSpinner = (message, type) => {
let spinner = ora();
spinner.text = message;
spinner.color = type;
spinner.start();
return spinner;
};
let stopSpinner = (spinner, message, type) => {
spinner.stop();
if (!message) return;
let symbol;
Iif (type === 'red') symbol = logSymbols.error;
else if (type === 'yellow') symbol = logSymbols.warning;
else symbol = logSymbols.success;
console.log(symbol, message);
};
/* Is module popular? - for secure mode */
const POPULARITY_THRESHOLD = 10000;
let isModulePopular = (name, callback) => {
let spinner = startSpinner(`Checking ${name}`, 'yellow');
let url = `https://api.npmjs.org/downloads/point/last-month/${name}`;
request(url, (error, response, body) => {
stopSpinner(spinner);
if (error && error.code === 'ENOTFOUND') {
console.log(colors.red('Could not connect to npm, check your internet connection!'));
} else {
let downloads = JSON.parse(body).downloads;
callback(downloads > POPULARITY_THRESHOLD);
}
});
};
/* Get install command
*
* Depends on package manager, dev and exact
*/
let getInstallCommand = (name, dev) => {
let packageManager = 'npm';
Iif (argv.yarn) packageManager = 'yarn';
let command;
Eif (packageManager === 'npm') {
command = `npm install ${name} --save`;
Iif (dev) command += '-dev';
Iif (argv.exact) command += ' --save-exact';
} else if (packageManager === 'yarn') {
command = `yarn add ${name}`;
if (dev) command += ' --dev';
// yarn always adds exact
}
return command;
};
/* Install module
* Install given module
*/
let installModule = ({name, dev}) => {
let spinner = startSpinner(`Installing ${name}`, 'green');
let command = getInstallCommand(name, dev);
let message = `${name} installed`;
Iif (dev) message += ' in devDependencies';
let success = runCommand(command);
if (success) stopSpinner(spinner, message, 'green');
else stopSpinner(spinner, `${name} installation failed`, 'yellow');
};
/* is scoped module? */
let isScopedModule = (name) => name[0] === '@';
/* Install module if author is trusted */
let installModuleIfTrustedAuthor = ({name, dev}) => {
let trustedAuthor = argv['trust-author'];
packageJson(name).then(json => {
if (json.author && json.author.name === trustedAuthor) installModule({name, dev});
else console.log(colors.red(`${name} not trusted`));
});
};
/* Install module if trusted
* Call isModulePopular before installing
*/
let installModuleIfTrusted = ({name, dev}) => {
// Trust scoped modules
if (isScopedModule(name)) installModule({name, dev});
else {
isModulePopular(name, (popular) => {
// Popular as proxy for trusted
if (popular) installModule({name, dev});
// Trusted Author
else if (argv['trust-author']) installModuleIfTrustedAuthor({name, dev});
// Not trusted
else console.log(colors.red(`${name} not trusted`));
});
}
};
/* Get uninstall command
*
* Depends on package manager
*/
let getUninstallCommand = (name) => {
let packageManager = 'npm';
if (argv.yarn) packageManager = 'yarn';
let command;
if (packageManager === 'npm') command = `npm uninstall ${name} --save`;
else if (packageManager === 'yarn') command = `yarn remove ${name}`;
return command;
};
/* Uninstall module */
let uninstallModule = ({name, dev}) => {
Eif (dev) return;
let command = getUninstallCommand(name);
let message = `${name} removed`;
let spinner = startSpinner(`Uninstalling ${name}`, 'red');
runCommand(command);
stopSpinner(spinner, message, 'red');
};
/* Remove built in/native modules */
let removeBuiltInModules = (modules) => modules.filter((module) => !isBuiltInModule(module.name));
/* Remove local files that are required */
let removeLocalFiles = (modules) => modules.filter((module) => !module.name.includes('./'));
/* Remove file paths from module names
* Example: convert `colors/safe` to `colors`
*/
let removeFilePaths = (modules) => {
for (let module of modules) {
let slicedName = module.name.split('/')[0];
if (slicedName.substr(0, 1) !== '@') module.name = slicedName;
}
return modules;
};
/* Filter registry modules */
let filterRegistryModules = (modules) => removeBuiltInModules(
removeFilePaths(
removeLocalFiles(
modules
)));
/* Get module names from array of module objects */
let getNamesFromModules = (modules) => modules.map(module => module.name);
/* Modules diff */
let diff = (first, second) => {
let namesFromSecond = getNamesFromModules(second);
return first.filter(module => !namesFromSecond.includes(module.name));
};
/* Reinstall modules */
let cleanup = () => {
let spinner = startSpinner('Cleaning up', 'green');
Iif (argv.yarn) runCommand('yarn');
else runCommand('npm install');
stopSpinner(spinner);
};
/* Does package.json exist?
* Without package.json, most of the functionality fails
* installing + adding to package.json
* removing unused modules
*/
let packageJSONExists = () => fs.existsSync('package.json');
/* Public helper functions */
module.exports = {
getInstalledModules,
getUsedModules,
filterRegistryModules,
installModule,
installModuleIfTrusted,
uninstallModule,
diff,
cleanup,
packageJSONExists
};
|