lion/scripts/lint-versions.js
2023-11-08 19:03:30 +01:00

115 lines
3.5 KiB
JavaScript

const { readdirSync, existsSync, readFileSync } = require('fs');
const semver = require('semver');
const getDirectories = (/** @type {string} */ source) =>
readdirSync(source, { withFileTypes: true })
.filter(pathMeta => pathMeta.isDirectory())
.map(pathMeta => pathMeta.name);
/**
* @param {string} filePath
*/
function readPackageJsonDeps(filePath) {
if (existsSync(filePath)) {
const jsonData = JSON.parse(readFileSync(filePath, 'utf-8'));
const merged = { ...jsonData.dependencies, ...jsonData.devDependencies };
const result = {};
Object.keys(merged).forEach(dep => {
if (merged[dep] && !merged[dep].includes('file:')) {
result[dep] = merged[dep];
}
});
// Note: we IGNORE singleton manager here as we NEED it to be a broad range of version
// the singleton-manager should never have a breaking change
delete result['singleton-manager'];
return result;
}
return {};
}
/**
* @param {string} filePath
*/
function readPackageJsonNameVersion(filePath) {
if (existsSync(filePath)) {
const jsonData = JSON.parse(readFileSync(filePath, 'utf-8'));
const result = {};
result[jsonData.name] = `${jsonData.version}`;
return result;
}
return {};
}
/**
*
* @param {object} versionsA
* @param {object} versionsB
* @returns
*/
function compareVersions(versionsA, versionsB) {
let output = '';
const newVersions = { ...versionsA };
Object.keys(versionsB).forEach(dep => {
// we accept different versions of glob for node packages
if (dep === 'glob') {
return;
}
if (versionsA[dep] && versionsB[dep] && versionsA[dep] !== versionsB[dep]) {
if (!semver.satisfies(versionsA[dep], versionsB[dep])) {
// if version doesn't satisfy range, check if they are both ranges,
// and if so, if either of them is entirely contained by the other,
// if so, then they are semver compatible and will resolve to the same thing
const rangeA = semver.validRange(versionsA[dep]);
const rangeB = semver.validRange(versionsB[dep]);
if (
// @ts-ignore
!(rangeA && rangeB && (semver.subset(rangeA, rangeB) || semver.subset(rangeB, rangeA)))
) {
output += ` - "${dep}" "${versionsB[dep]}" does not seem semver compatible with "${versionsA[dep]}" and probably one of them needs a bump"\n`;
}
}
}
if (!newVersions[dep]) {
newVersions[dep] = versionsB[dep];
}
});
return {
output,
newVersions,
};
}
let endReturn = 0;
/**
* @param {string} folder
*/
function lintVersions(folder) {
let currentVersions = readPackageJsonDeps('./package.json');
// find all versions in the monorepo
getDirectories(`./${folder}`).forEach(subPackage => {
const filePath = `./${folder}/${subPackage}/package.json`;
currentVersions = { ...currentVersions, ...readPackageJsonNameVersion(filePath) };
});
// lint all versions in folder
getDirectories(`./${folder}`).forEach(subPackage => {
const filePath = `./${folder}/${subPackage}/package.json`;
const subPackageVersions = readPackageJsonDeps(filePath);
const { output, newVersions } = compareVersions(currentVersions, subPackageVersions);
currentVersions = { ...newVersions };
if (output) {
console.log(`Version mismatches found in "${filePath}":`);
console.log(output);
console.log();
endReturn = 1;
}
});
}
lintVersions('packages');
lintVersions('packages-node');
if (endReturn === 0) {
console.log('All versions are aligned 💪');
}
process.exit(endReturn);