-
Notifications
You must be signed in to change notification settings - Fork 378
/
info.action.ts
263 lines (234 loc) · 7.66 KB
/
info.action.ts
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
import * as chalk from 'chalk';
import { readFileSync } from 'fs';
import { platform, release } from 'os';
import { join } from 'path';
import {
AbstractPackageManager,
PackageManagerFactory,
} from '../lib/package-managers';
import { BANNER, MESSAGES } from '../lib/ui';
import { AbstractAction } from './abstract.action';
import osName from '../lib/utils/os-info.utils';
interface LockfileDependency {
version: string;
}
interface PackageJsonDependencies {
[key: string]: LockfileDependency;
}
interface NestDependency {
name: string;
value: string;
packageName: string;
}
interface NestDependencyWarnings {
[key: string]: Array<NestDependency>;
}
export class InfoAction extends AbstractAction {
private manager!: AbstractPackageManager;
// Nest dependencies whitelist used to compare the major version
private warningMessageDependenciesWhiteList = [
'@nestjs/core',
'@nestjs/common',
'@nestjs/schematics',
'@nestjs/platform-express',
'@nestjs/platform-fastify',
'@nestjs/platform-socket.io',
'@nestjs/platform-ws',
'@nestjs/websockets',
];
public async handle() {
this.manager = await PackageManagerFactory.find();
this.displayBanner();
await this.displaySystemInformation();
await this.displayNestInformation();
}
private displayBanner() {
console.info(chalk.red(BANNER));
}
private async displaySystemInformation(): Promise<void> {
console.info(chalk.green('[System Information]'));
console.info('OS Version :', chalk.blue(osName(platform(), release()), release()));
console.info('NodeJS Version :', chalk.blue(process.version));
await this.displayPackageManagerVersion();
}
async displayPackageManagerVersion() {
try {
const version: string = await this.manager.version();
console.info(
`${this.manager.name} Version :`,
chalk.blue(version),
'\n',
);
} catch {
console.error(
`${this.manager.name} Version :`,
chalk.red('Unknown'),
'\n',
);
}
}
async displayNestInformation(): Promise<void> {
this.displayCliVersion();
console.info(chalk.green('[Nest Platform Information]'));
await this.displayNestInformationFromPackage();
}
async displayNestInformationFromPackage(): Promise<void> {
try {
const dependencies: PackageJsonDependencies =
this.readProjectPackageDependencies();
this.displayNestVersions(dependencies);
} catch (err) {
console.error(
chalk.red(MESSAGES.NEST_INFORMATION_PACKAGE_MANAGER_FAILED),
);
}
}
displayCliVersion(): void {
console.info(chalk.green('[Nest CLI]'));
console.info(
'Nest CLI Version :',
chalk.blue(
JSON.parse(readFileSync(join(__dirname, '../package.json')).toString())
.version,
),
'\n',
);
}
readProjectPackageDependencies(): PackageJsonDependencies {
const buffer = readFileSync(join(process.cwd(), 'package.json'));
const pack = JSON.parse(buffer.toString());
const dependencies = { ...pack.dependencies, ...pack.devDependencies };
Object.keys(dependencies).forEach((key) => {
dependencies[key] = {
version: dependencies[key],
};
});
return dependencies;
}
displayNestVersions(dependencies: PackageJsonDependencies) {
const nestDependencies = this.buildNestVersionsMessage(dependencies);
nestDependencies.forEach((dependency) =>
console.info(dependency.name, chalk.blue(dependency.value)),
);
this.displayWarningMessage(nestDependencies);
}
displayWarningMessage(nestDependencies: NestDependency[]) {
try {
const warnings = this.buildNestVersionsWarningMessage(nestDependencies);
const majorVersions = Object.keys(warnings);
if (majorVersions.length > 0) {
console.info('\r');
console.info(chalk.yellow('[Warnings]'));
console.info(
'The following packages are not in the same major version',
);
console.info('This could lead to runtime errors');
majorVersions.forEach((version) => {
console.info(chalk.bold(`* Under version ${version}`));
warnings[version].forEach(({ packageName, value }) => {
console.info(`- ${packageName} ${value}`);
});
});
}
} catch {
console.info('\t');
console.error(
chalk.red(
MESSAGES.NEST_INFORMATION_PACKAGE_WARNING_FAILED(
this.warningMessageDependenciesWhiteList,
),
),
);
}
}
buildNestVersionsWarningMessage(
nestDependencies: NestDependency[],
): NestDependencyWarnings {
const unsortedWarnings =
nestDependencies.reduce(
(depWarningsGroup, { name, packageName, value }) => {
if (!this.warningMessageDependenciesWhiteList.includes(packageName)) {
return depWarningsGroup;
}
const [major,] = value.replace(/[^\d.]/g, '').split('.', 1);
const minimumVersion = major;
depWarningsGroup[minimumVersion] = [
...(depWarningsGroup[minimumVersion] || []),
{ name, packageName, value },
];
return depWarningsGroup;
},
Object.create(null) as NestDependencyWarnings,
);
const unsortedMinorVersions = Object.keys(unsortedWarnings);
if (unsortedMinorVersions.length <= 1) {
return {};
}
const sortedMinorVersions = unsortedMinorVersions.sort(
(versionA, versionB) => {
const numA = parseFloat(versionA);
const numB = parseFloat(versionB);
if (isNaN(numA) && isNaN(numB)) {
// If both are not valid numbers, maintain the current order.
return 0;
}
// NaN is considered greater than any number, so if numA is NaN, place it later.
return isNaN(numA) ? 1 : isNaN(numB) ? -1 : numB - numA;
},
);
return sortedMinorVersions.reduce(
(warnings, minorVersion) => {
warnings[minorVersion] = unsortedWarnings[minorVersion];
return warnings;
},
Object.create(null) as NestDependencyWarnings,
);
}
buildNestVersionsMessage(
dependencies: PackageJsonDependencies,
): NestDependency[] {
const nestDependencies = this.collectNestDependencies(dependencies);
return this.format(nestDependencies);
}
collectNestDependencies(
dependencies: PackageJsonDependencies,
): NestDependency[] {
const nestDependencies: NestDependency[] = [];
Object.keys(dependencies).forEach((key) => {
if (key.indexOf('@nestjs') > -1) {
const depPackagePath = require.resolve(key + '/package.json', {
paths: [process.cwd()],
});
const depPackage = readFileSync(depPackagePath).toString();
const value = JSON.parse(depPackage).version;
nestDependencies.push({
name: `${key.replace(/@nestjs\//, '').replace(/@.*/, '')} version`,
value: value || dependencies[key].version,
packageName: key,
});
}
});
return nestDependencies;
}
format(dependencies: NestDependency[]): NestDependency[] {
const sorted = dependencies.sort(
(dependencyA, dependencyB) =>
dependencyB.name.length - dependencyA.name.length,
);
const length = sorted[0].name.length;
sorted.forEach((dependency) => {
if (dependency.name.length < length) {
dependency.name = this.rightPad(dependency.name, length);
}
dependency.name = dependency.name.concat(' :');
dependency.value = dependency.value.replace(/(\^|\~)/, '');
});
return sorted;
}
rightPad(name: string, length: number): string {
while (name.length < length) {
name = name.concat(' ');
}
return name;
}
}