Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | import { spawnSync, type SpawnSyncOptionsWithStringEncoding, type SpawnSyncReturns } from 'child_process';
import * as fs from 'fs';
import { env } from 'process';
import readlineSync from 'readline-sync';
import { Observable, type Subscriber, timer } from 'rxjs';
import { finalize, tap } from 'rxjs/operators';
import { argv } from 'yargs';
import { COLORS } from '../utils/colors';
import { logger } from '../utils/logger';
/**
* Project root directory.
*/
const root = process.cwd();
type TUpdatablePackages = Record<string, string>;
interface IPackageJson {
scripts: Record<string, string>;
husky: {
hooks: Record<string, string>;
};
dependencies: Record<string, string>;
devDependencies: Record<string, string>;
engines: {
node: string;
npm: string;
};
}
/**
* Prints script usage instructions.
*/
function printUsageInstructions() {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(
`\n${COLORS.CYAN}%s${COLORS.DEFAULT} ${COLORS.YELLOW}%s${COLORS.DEFAULT}
${COLORS.CYAN}%s${COLORS.DEFAULT} ${COLORS.YELLOW}%s${COLORS.DEFAULT}
${COLORS.CYAN}%s${COLORS.DEFAULT} ${COLORS.YELLOW}%s${COLORS.DEFAULT}
${COLORS.CYAN}%s${COLORS.DEFAULT} ${COLORS.YELLOW}%s${COLORS.DEFAULT}\n`,
'Use --check flag to check for updates, e.g.',
'npx ts-node -P ./tools/tsconfig.tools.json ./tools/ts/update.ts --check',
'Use --check --jsonUpgraded flags to check for updates and save updated packages as json in the project root, e.g.',
'npx ts-node -P ./tools/tsconfig.tools.json ./tools/ts/update.ts --check --jsonUpgraded',
'Use --migrate=update flag to start migration process, e.g.',
'npx ts-node -P ./tools/tsconfig.tools.json ./tools/ts/update.ts --migrate=update',
'Use --migrate=only flag to execute existing migrations only, e.g.',
'npx ts-node -P ./tools/tsconfig.tools.json ./tools/ts/update.ts --migrate=only',
);
}
/**
* Runs a process synchronously, and outputs result.
* @param command command to run
* @param [args] command arguments
* @param [options] spawnSync options
*/
function spawnCommandSync(
command: string,
args: string[] = [],
options: SpawnSyncOptionsWithStringEncoding = {
env: { ...env, FORCE_COLOR: 'true' },
encoding: 'utf8',
shell: true,
},
): SpawnSyncReturns<string> {
const spawnSyncOutput = spawnSync(command, args, options);
if (spawnSyncOutput.error) {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(
`${COLORS.CYAN}%s${COLORS.DEFAULT}
${COLORS.RED}%s:${COLORS.DEFAULT}\n%s
${COLORS.CYAN}%s:${COLORS.DEFAULT}\n%s
${COLORS.CYAN}%s:${COLORS.DEFAULT}\n%s\n`,
'Process finished.',
'ERROR',
spawnSyncOutput.error,
'stderr',
spawnSyncOutput.stderr,
'exit code',
spawnSyncOutput.status,
);
} else {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(
`${COLORS.CYAN}%s${COLORS.DEFAULT}
${COLORS.CYAN}%s:${COLORS.DEFAULT}\n%s
${COLORS.CYAN}%s:${COLORS.DEFAULT}\n%s\n`,
'Process finished.',
'stdout',
spawnSyncOutput.stdout,
'exit code',
spawnSyncOutput.status,
);
}
return spawnSyncOutput;
}
function writeUpdateSummary(packages: TUpdatablePackages) {
const path = `${root}/migrations-packages.json`;
fs.writeFile(path, JSON.stringify(packages), (error: NodeJS.ErrnoException | null) => {
if (error !== null) {
logger.printError(error);
process.exit(1);
}
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(`\n${COLORS.GREEN}%s${COLORS.DEFAULT}%s\n`, 'Update summary saved: ', path);
});
}
/**
* Check for available updates.
* @param [jsonUpgraded] defaults to true; passes flag to ncu cli, as a result output is in json format;
*/
function checkForUpdates(jsonUpgraded = false): TUpdatablePackages {
const args = jsonUpgraded ? ['--jsonUpgraded'] : [];
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(`\n${COLORS.YELLOW}%s${COLORS.DEFAULT}\n`, 'Checking for updates. Wait for it...');
const ncuOutput = spawnCommandSync('ncu', args);
const updatablePackages: TUpdatablePackages =
jsonUpgraded && typeof ncuOutput.error === 'undefined'
? (JSON.parse(ncuOutput.stdout.replace(/Using yarn(.*package\.json)?/gi, '').trim()) ?? {})
: {};
if (jsonUpgraded) {
writeUpdateSummary(updatablePackages);
} else {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(
`\n${COLORS.YELLOW}%s${COLORS.DEFAULT}\n`,
'Verify output above. Dependencies highlighted with red may have breaking changes but not necessarily.',
);
}
return updatablePackages;
}
/**
* Reads migrations.json, and executes migrations if file exists.
*/
function executeMigrations(): Observable<SpawnSyncReturns<string> | null> {
const result = new Observable(function (this, subscriber: Subscriber<SpawnSyncReturns<string> | null>) {
fs.readFile(`${root}/migrations.json`, 'utf8', (error, data) => {
if (error !== null) {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(`\n${COLORS.GREEN}%s${COLORS.DEFAULT}\n`, '<< NO MIGRATIONS >>');
subscriber.next(null);
} else {
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(`\n${COLORS.YELLOW}%s${COLORS.DEFAULT}\n`, '<< EXECUTING MIGRATIONS >>', data);
const migrationProcessOutput = spawnCommandSync('npx nx migrate', ['--run-migrations']);
if (migrationProcessOutput.error) {
subscriber.error(migrationProcessOutput);
process.exit(1);
} else {
const deleteMigrationsFile = spawnCommandSync(`rm ${root}/migrations.json`);
if (deleteMigrationsFile.error) {
subscriber.next(deleteMigrationsFile);
process.exit(1);
} else {
subscriber.next(migrationProcessOutput);
}
subscriber.next(migrationProcessOutput);
}
}
subscriber.complete();
subscriber.unsubscribe();
});
});
return result;
}
const newQuestionConfig: {
limit: readlineSync.OptionType[];
trueValue: readlineSync.OptionType[];
falseValue: readlineSync.OptionType[];
} = {
limit: ['yes', 'no', 'y', 'n', 'Y', 'N'],
trueValue: ['yes', 'y', 'Y'],
falseValue: ['no', 'n', 'N'],
};
const newQuestion = (
question: string,
config: typeof newQuestionConfig = {
...newQuestionConfig,
},
) => {
readlineSync.setDefaultOptions({ limit: config.limit });
const answer = Boolean(
readlineSync.question(`${question} (y/N)? `, {
trueValue: config.trueValue,
falseValue: config.falseValue,
}),
);
return answer;
};
/**
* Executes packages migration procedure recursively.
* @param config migration configuration
*/
function migratePackagesRecursively(config: { packageNames: string[]; packageIndex: number }, bulkUserChoice?: boolean) {
const processNextPackage = () => {
const timeout = 150;
void timer(timeout)
.pipe(
tap(() => {
if (config.packageIndex < config.packageNames.length) {
migratePackagesRecursively(
{
packageNames: config.packageNames,
packageIndex: config.packageIndex + 1,
},
bulkUserChoice,
);
}
}),
)
.subscribe();
};
const packageName = config.packageNames[config.packageIndex];
if (typeof packageName !== 'undefined') {
const answer =
typeof bulkUserChoice === 'undefined'
? newQuestion(`> Migrate ${packageName} to the latest version`, {
...newQuestionConfig,
})
: bulkUserChoice;
if (answer) {
const command = `npx nx migrate ${packageName}`;
const migratePackageOutput = spawnCommandSync(command);
if (migratePackageOutput.error) {
process.exit(1);
}
void executeMigrations()
.pipe(
finalize(() => {
processNextPackage();
}),
)
.subscribe();
} else {
processNextPackage();
}
}
}
/**
* Starts migration for all packages defined in the migrations-packages.json.
*/
function updateAndMigratePackages(bulkUserChoice?: boolean) {
const path = `${root}/migrations-packages.json`;
fs.readFile(path, (error: NodeJS.ErrnoException | null, data?: Buffer) => {
if (error !== null) {
logger.printError(error);
process.exit(1);
}
if (typeof data !== 'undefined') {
const updatablePackages: TUpdatablePackages = JSON.parse(data.toString());
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(
`\n${COLORS.CYAN}%s${COLORS.DEFAULT}\n%s\n`,
`Updatable packages (local cache, rerun --check --jsonUpgraded to regenerate if output differs from the subsequent live check)`,
updatablePackages,
);
const packageNames = Object.keys(updatablePackages);
migratePackagesRecursively({ packageNames, packageIndex: 0 }, bulkUserChoice);
}
});
}
/**
* Executes packages migration procedure recursively.
* @param config migration configuration
*/
function executeMigrationsRecursively(config: { packageNames: string[]; packageVersions: string[]; packageIndex: number }) {
const processNextPackage = () => {
const timeout = 150;
void timer(timeout)
.pipe(
tap(() => {
if (config.packageIndex < config.packageNames.length) {
executeMigrationsRecursively({
packageNames: config.packageNames,
packageVersions: config.packageVersions,
packageIndex: config.packageIndex + 1,
});
}
}),
)
.subscribe();
};
const packageName = config.packageNames[config.packageIndex];
const packageVersion = config.packageVersions[config.packageIndex];
const parsedVersion = typeof packageVersion !== 'undefined' ? packageVersion.match(/^\d+/) : null;
const previousVersion = parsedVersion === null ? parsedVersion : Number(parsedVersion[0]) > 0 ? Number(parsedVersion[0]) - 1 : 0;
if (typeof packageName !== 'undefined' && previousVersion !== null) {
const answer = newQuestion(`> Execute migration of ${packageName} from the version ${previousVersion} to the latest version`, {
...newQuestionConfig,
});
if (answer) {
const command = `npx nx migrate ${packageName} --migrate-only --from="${packageName}@${previousVersion}"`;
const migratePackageOutput = spawnCommandSync(command);
if (migratePackageOutput.error) {
process.exit(1);
}
void executeMigrations()
.pipe(
finalize(() => {
processNextPackage();
}),
)
.subscribe();
} else {
processNextPackage();
}
}
}
/**
* Migrates packages (without updating any) from the previous version.
*/
function migratePackagesOnly() {
const path = `${root}/package.json`;
fs.readFile(path, (error: NodeJS.ErrnoException | null, data?: Buffer) => {
if (error !== null) {
logger.printError(error);
process.exit(1);
}
if (typeof data !== 'undefined') {
const parsedPackageJson: IPackageJson = JSON.parse(data.toString());
const dependencies = parsedPackageJson.dependencies;
// eslint-disable-next-line no-console -- needed here to print output in the terminal
console.log(`\n${COLORS.CYAN}%s${COLORS.DEFAULT}\n%s\n`, `Parsed dependencies`, dependencies);
const packageNames = Object.keys(dependencies);
const packageVersions = Object.values(dependencies);
executeMigrationsRecursively({ packageNames, packageVersions, packageIndex: 0 });
}
});
}
const removeUnneededFiles = () => {
const migrations = `${root}/migrations.json`;
const migrationsPackages = `${root}/migrations-packages.json`;
fs.unlink(migrations, error => {
if (error !== null) {
logger.printError(error, 'Non breaking error');
}
});
fs.unlink(migrationsPackages, error => {
if (error !== null) {
logger.printError(error, 'Non breaking error');
}
});
};
/**
* Reads input, and follows control flow.
*/
function readInputAndRun(): void {
const check = (argv as { [key: string]: boolean | undefined })['check'];
const cleanup = (argv as { [key: string]: boolean | undefined })['cleanup'];
const migrate = (argv as { [key: string]: string | undefined })['migrate'];
const bulkUserChoice = (argv as { [key: string]: boolean | undefined })['bulkUserChoice'];
if (cleanup === true) {
removeUnneededFiles();
} else if (check === true) {
const jsonUpgraded = (argv as { [key: string]: boolean | undefined })['jsonUpgraded'];
checkForUpdates(jsonUpgraded);
} else if (migrate === 'update') {
updateAndMigratePackages(bulkUserChoice);
} else if (migrate === 'only') {
migratePackagesOnly();
} else {
printUsageInstructions();
}
}
readInputAndRun();
|