-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
executable file
·253 lines (242 loc) · 6.05 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
const request = require('request');
const { execSync } = require('child_process');
const defaultParameterError = (msg) => {
throw new Error(`Missing ${msg} parameter`);
};
const execSheelCommand = ({
command,
silentError = true,
args = [],
}) => {
try {
const out = execSync(`${command} ${args.reduce((a, b) => `${a} ${b}`, '')}`, { stdio: ['pipe', 'pipe', silentError ? 'ignore' : 'pipe'] });
return out.toString().trim();
} catch (err) {
if (err) throw new Error(err);
}
return false;
};
const filterByKey = (obj, predicate) => Object.keys(obj)
.filter(key => predicate(key))
.reduce((out, key) => {
out[key] = obj[key]; // eslint-disable-line
return out;
}, {});
/**
* @param {Object} options
* @property {string} client=yarn - npm or yarn
* @returns {string}
* @example
* getGlobalDir();
*
* // returns
* '/Users/foo/.config/yarn/global'
*/
const getGlobalDir = ({ client = 'yarn' } = {}) => {
let dir = execSheelCommand({
command: client,
args: client === 'npm' ? ['root', '-g'] : ['global', 'dir'],
});
if (client === 'npm') dir = dir.replace(/(\/|\\)node_modules/i, '');
return dir;
};
/**
* @param {Object} options
* @property {string} name - Package name.
* @property {string} client=yarn - npm or yarn
* @returns {string}
* @example
* getGlobalPackagePath({ name: 'jest' });
*
* // returns
* '/Users/foo/.config/yarn/global/node_modules/jest'
*/
const getGlobalPackagePath = ({
name,
client = 'yarn',
}) => `${getGlobalDir({ client })}/node_modules/${name}`;
const getGlobalPackagesList = ({ client }) => {
if (client === 'npm') {
const list = execSheelCommand({
command: 'npm',
args: ['list', '-g', '--depth=0', '--json'],
});
return JSON.parse(list.toString());
}
return require(`${getGlobalDir({ client })}/package.json`);
};
/**
* @param {Object} options
* @property {string} scope - Get packages by @scope.
* @property {function} filter - A custom filter callback.
* @property {boolean} extended - Get extended info, such as name, version and description.
* @property {string} client=yarn - Preferred client, npm or yarn.
* @returns {Array.string|Array.Object}
* @example
* getGlobalPackages();
*
* // returns
* ['jest', 'vue-cli']
* @example
* getGlobalPackages({ extended: true });
*
* // returns
* [
* {
* name: 'jest',
* version: '23.6.0',
* description: 'Delightful JavaScript Testing'.
* },
* {
* name: 'vue-cli',
* version: '2.9.6',
* description: 'A simple CLI for scaffolding Vue.js projects.'
* }
* ]
*/
const getGlobalPackages = ({
scope = '',
filter = undefined,
extended = false,
client = 'yarn',
} = {}) => {
let { dependencies } = getGlobalPackagesList({ client });
dependencies = filterByKey(dependencies, key => key.startsWith(scope) && (typeof (filter) === 'function' ? filter(key) : true));
if (!extended) return Object.keys(dependencies);
return Object.keys(dependencies).map((key) => {
const {
version,
description,
} = require(`${getGlobalDir({ client })}/node_modules/${key}/package.json`);
return {
name: key,
version,
description,
};
});
};
/**
* @param {Object} options
* @property {boolean} extended - Get extended info, such as name, version and description.
* @property {string} client=yarn - Preferred client, npm or yarn.
* @returns {Boolean|Object}
* @example
* checkIfPackageIsGloballyInstalled({ name: 'vue-cli' });
*
* // returns true
* @example
* getGlobalPackages({
* extended: true,
* name: 'vue-cli'
* });
*
* // returns
* {
* name: 'vue-cli',
* version: '2.9.6',
* description: 'A simple CLI for scaffolding Vue.js projects.'
* }
*/
const checkIfPackageIsGloballyInstalled = ({
client = 'yarn',
extended = false,
name = defaultParameterError('name'),
}) => {
const packages = getGlobalPackages({
client,
extended,
filter: key => key === name,
});
const pkg = packages.find(p => (extended ? p.name === name : p === name));
return !extended ? !!pkg : pkg || false;
};
/**
* @param {Object} options
* @property {string} name - Package name.
* @property {string} key - Request specific key, example: version.
* @property {string} client=yarn - Preferred client, npm or yarn.
* @returns {Object}
* @example
* getRemotePackageInfo({
* name: 'vue-cli',
* key: 'version'
* })
*
* //returns
* '2.9.6'
* @example
* getRemotePackageInfo( name: 'vue-cli' })
*
* //returns
* {
* name: 'vue-cli',
* version: '2.9.6',
* description: 'A simple CLI for scaffolding Vue.js projects.'
* }
*/
const getRemotePackageInfo = ({
client = 'yarn',
name = defaultParameterError('name'),
key = '',
}) => {
const spawn = execSheelCommand({
command: client,
args: [client === 'npm' ? 'view' : 'info', name, '--json', key],
});
return client === 'yarn' ? JSON.parse(spawn).data : spawn;
};
/**
* @param {Object} options Read here for params documentation https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search
* @returns {Promise.Array.Object}
* @example
* getRemotePackages({ search: 'react' }).then((response) => {
* console.log(response);
* })
*
* // returns
* [
* {
* name: 'react',
* version: '16.6.0',
* description: 'React is a JavaScript library for building user interfaces.'.
* },
* {
* name: 'react-router',
* version: '4.3.1',
* description: 'Declarative routing for React'.
* },
* ...
* ]
*/
const getRemotePackages = (params = {}) => new Promise((resolve, reject) => {
const url = 'https://registry.npmjs.org/-/v1/search';
request.get({
url,
qs: params,
json: true,
}, (err, response, body) => {
if (err) {
reject(err);
return;
}
resolve(body.objects.map(({
package: {
name,
description,
version,
},
}) => ({
name,
description,
version,
})));
});
});
module.exports = {
getGlobalPackages,
getRemotePackages,
getRemotePackageInfo,
getGlobalDir,
checkIfPackageIsGloballyInstalled,
getGlobalPackagePath,
};