mirror of
https://github.com/shelljs/shelljs.git
synced 2025-12-08 20:35:51 +00:00
75d26de5b3
Starting in node >= 22.10.0, a commandNotFound error will have `undefined` values for stdout/stderr, whereas in earlier versions these values were `null`. Fixes #1180
97 lines
2.9 KiB
JavaScript
Executable File
97 lines
2.9 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
var assert = require('assert');
|
|
var path = require('path');
|
|
|
|
// eslint-disable-next-line import/no-extraneous-dependencies
|
|
var yaml = require('js-yaml');
|
|
|
|
var shell = require('..');
|
|
|
|
// This is the authoritative list of supported node versions.
|
|
var MIN_NODE_VERSION = 18;
|
|
var MAX_NODE_VERSION = 22;
|
|
|
|
// Ideally this map should be empty, however we can pin node releases to
|
|
// specific versions if necessary to workaround bugs. See
|
|
// https://github.com/shelljs/shelljs/issues/1180.
|
|
var pinnedNodeVersions = {
|
|
// Format:
|
|
// majorVersionInt: 'full.node.version',
|
|
// Example:
|
|
// 22: '22.9.0',
|
|
};
|
|
|
|
function checkReadme(minNodeVersion) {
|
|
var start = '<!-- start minVersion -->';
|
|
var stop = '<!-- stop minVersion -->';
|
|
var formattedMinVersion = '`v' + minNodeVersion + '`';
|
|
var expectedReadmeRegex = new RegExp(
|
|
start + '\\s*' + formattedMinVersion + '\\s*' + stop, '',
|
|
);
|
|
var readme = path.join(__dirname, '..', 'README.md');
|
|
var match = shell.grep(expectedReadmeRegex, readme);
|
|
if (!match.toString().trim()) {
|
|
var msg = 'Update README to specify the min supported version. Look for "'
|
|
+ start + '"';
|
|
throw new Error(msg);
|
|
}
|
|
}
|
|
|
|
function checkEngines(minNodeVersion, packageJson) {
|
|
var expectedEnginesNode = '>=' + minNodeVersion;
|
|
if (packageJson.engines.node !== expectedEnginesNode) {
|
|
var msg = 'Update package.json to fix the "engines" attribute';
|
|
throw new Error(msg);
|
|
}
|
|
}
|
|
|
|
function assertDeepEquals(arr1, arr2, msg) {
|
|
try {
|
|
assert.deepStrictEqual(arr1, arr2);
|
|
} catch (e) {
|
|
throw new Error(msg + '\n' + e);
|
|
}
|
|
}
|
|
|
|
function range(start, stop) {
|
|
var ret = [];
|
|
for (var i = start; i <= stop; i += 2) {
|
|
if (i % 2 !== 0) {
|
|
console.warn('Warning: testing a non-LTS nodejs release: ' + i);
|
|
}
|
|
ret.push(i);
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
function checkGithubActions(minNodeVersion, maxNodeVersion, githubActionsYaml) {
|
|
var expectedVersions = range(minNodeVersion, maxNodeVersion);
|
|
expectedVersions = expectedVersions.map(function (majorVersion) {
|
|
return pinnedNodeVersions[majorVersion] || majorVersion;
|
|
});
|
|
var msg = 'Check GitHub Actions node_js versions';
|
|
assertDeepEquals(githubActionsYaml.jobs.test.strategy.matrix['node-version'],
|
|
expectedVersions, msg);
|
|
}
|
|
|
|
try {
|
|
checkReadme(MIN_NODE_VERSION);
|
|
|
|
var packageJson = require('../package.json');
|
|
checkEngines(MIN_NODE_VERSION, packageJson);
|
|
|
|
var githubActionsFileName = path.join(__dirname, '..', '.github', 'workflows',
|
|
'main.yml');
|
|
var githubActionsYaml = yaml.load(shell.cat(githubActionsFileName));
|
|
checkGithubActions(MIN_NODE_VERSION, MAX_NODE_VERSION, githubActionsYaml);
|
|
|
|
console.log('All files look good (this project supports LTS releases v'
|
|
+ MIN_NODE_VERSION + '-v' + MAX_NODE_VERSION + ')!');
|
|
} catch (e) {
|
|
console.error('Please check the files which declare our Node version');
|
|
console.error('support, as something is out-of-sync. This script failed');
|
|
console.error('specificaly because:');
|
|
throw e;
|
|
}
|