@signageos/lib 10.4.0-master.1639 → 10.4.0

package/CHANGELOG.md

@@ -4,10 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [10.4.0] - 2022-10-24
 ### Added
 - Class decorator that facilitate debugging of all methods of the class
 - Word string helper with capitalize, uncapitalize, pascal and camel case conversions.
+- Tool `check-deps` can check expected range of versions instead of just exact match.
 
 ## [10.3.0] - 2022-10-12
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/lib",
-  "version": "10.4.0-master.1639",
+  "version": "10.4.0",
   "main": "./dist",
   "files": [
     "tools",

package/tools/check-deps.js

@@ -7,7 +7,7 @@ const packagePath = process.cwd() + '/package.json';
 const package = require(packagePath);
 
 const ignorePath = process.cwd() + '/.check-depsignore';
-let = ignore = [];
+let ignore = [];
 try {
 	ignore = fs.readFileSync(ignorePath).toString().split('\n');
 	console.log(`Ignoring packages from ${ignorePath}`);
@@ -15,6 +15,18 @@ try {
 	console.log('No ignore file found');
 }
 
+const runControlPath = process.cwd() + '/.check-depsrc.json';
+let runControl = {};
+try {
+	runControl = require(runControlPath);
+	console.log(`Using run control from ${runControlPath}`);
+	if (runControl.ignore) {
+		ignore = ignore.concat(runControl.ignore);
+	}
+} catch (error) {
+	console.log('No Run Control file found');
+}
+
 const includeRegExp = new RegExp(process.argv[2] || '.+');
 const excludeRegExp = new RegExp(process.argv[3] || '^$');
 
@@ -26,6 +38,11 @@ const matchedDepNames = depNames.filter((depName) => includeRegExp.test(depName)
 
 const prereleaseDepNames = [];
 const inexactDepNames = [];
+const expectedRangeDepNames = [];
+
+function isExpectedRangeValid(depName, version) {
+	return version.startsWith(runControl.expectRanges[depName]);
+}
 
 for (const depName of matchedDepNames) {
 	if (ignore.includes(depName)) {
@@ -35,8 +52,15 @@ for (const depName of matchedDepNames) {
 	if (semver.prerelease(depVersion) !== null) {
 		prereleaseDepNames.push(depName);
 	}
-	if (!semver.valid(depVersion)) {
-		inexactDepNames.push(depName);
+	if (depName in runControl.expectRanges) {
+		if (!isExpectedRangeValid(depName, depVersion)) {
+			expectedRangeDepNames.push(depName);
+		}
+	} else {
+		if (!semver.valid(depVersion)) {
+			// Check inexact only when not expected range
+			inexactDepNames.push(depName);
+		}
 	}
 }
 
@@ -52,6 +76,18 @@ if (prereleaseDepNames.length > 0) {
 	);
 }
 
+if (expectedRangeDepNames.length > 0) {
+	const expectedRangeDeps = {};
+	expectedRangeDepNames.forEach((depName) => {
+		expectedRangeDeps[depName] = deps[depName];
+	});
+	console.error(
+		`Some packages has expectation of range of versions specified in package.json deps`,
+		expectedRangeDepNames.map((depName) => `${depName}->"${runControl.expectRanges[depName]}"`).join(', '),
+		expectedRangeDeps,
+	);
+}
+
 if (inexactDepNames.length > 0) {
 	const inexactDeps = {};
 	inexactDepNames.forEach((depName) => {
@@ -64,6 +100,6 @@ if (inexactDepNames.length > 0) {
 	);
 }
 
-if (prereleaseDepNames.length > 0 || inexactDepNames.length > 0) {
+if (prereleaseDepNames.length > 0 || expectedRangeDepNames.length > 0 || inexactDepNames.length > 0) {
 	process.exit(1);
 }