|
| 1 | +#!/usr/bin/env node |
| 2 | + |
| 3 | +var assert = require('assert'); |
| 4 | +var path = require('path'); |
| 5 | + |
| 6 | +var yaml = require('js-yaml'); |
| 7 | + |
| 8 | +var shell = require('shelljs'); |
| 9 | + |
| 10 | +// This is the authoritative list of supported node versions. |
| 11 | +var MIN_NODE_VERSION = 4; |
| 12 | +var MAX_NODE_VERSION = 10; |
| 13 | + |
| 14 | +function checkReadme(minNodeVersion) { |
| 15 | + var start = '<!-- start minVersion -->'; |
| 16 | + var stop = '<!-- stop minVersion -->'; |
| 17 | + var formattedMinVersion = '`v' + minNodeVersion + '`'; |
| 18 | + var expectedReadmeRegex = new RegExp( |
| 19 | + start + '\\s*' + formattedMinVersion + '\\s*' + stop, ''); |
| 20 | + var readme = path.join(__dirname, '..', 'README.md'); |
| 21 | + var match = shell.grep(expectedReadmeRegex, readme); |
| 22 | + if (!match.toString()) { |
| 23 | + var msg = 'Update README to specify the min supported version. Look for "' |
| 24 | + + start + '"'; |
| 25 | + throw new Error(msg); |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +function checkEngines(minNodeVersion, package) { |
| 30 | + var expectedEnginesNode = '>=' + minNodeVersion; |
| 31 | + if (package.engines.node !== expectedEnginesNode) { |
| 32 | + var msg = 'Update package.json to fix the "engines" attribute'; |
| 33 | + throw new Error(msg); |
| 34 | + } |
| 35 | +} |
| 36 | + |
| 37 | +function assertDeepEquals(arr1, arr2, msg) { |
| 38 | + try { |
| 39 | + assert.deepStrictEqual(arr1, arr2); |
| 40 | + } catch (e) { |
| 41 | + throw new Error(msg + '\n' + e); |
| 42 | + } |
| 43 | +} |
| 44 | + |
| 45 | +function range(start, stop) { |
| 46 | + var ret = []; |
| 47 | + for (var i = start; i <= stop; i++) { |
| 48 | + ret.push(i); |
| 49 | + } |
| 50 | + return ret; |
| 51 | +} |
| 52 | + |
| 53 | +function checkTravis(minNodeVersion, maxNodeVersion, travisYaml) { |
| 54 | + var expectedTravisVersions = range(minNodeVersion, maxNodeVersion); |
| 55 | + var msg = 'Check Travis node_js versions'; |
| 56 | + assertDeepEquals(travisYaml.node_js, expectedTravisVersions, msg); |
| 57 | +} |
| 58 | + |
| 59 | +function checkAppveyor(minNodeVersion, maxNodeVersion, appveyorYaml) { |
| 60 | + var expectedAppveyorVersions = range(minNodeVersion, maxNodeVersion) |
| 61 | + .map(function (num) { |
| 62 | + return { nodejs_version: num.toString() }; |
| 63 | + }) |
| 64 | + .reverse(); // Arbitrarily, we store appveyor in reverse order. |
| 65 | + var msg = 'Check Appveyor environment.matrix versions'; |
| 66 | + assertDeepEquals(appveyorYaml.environment.matrix, expectedAppveyorVersions, |
| 67 | + msg); |
| 68 | +} |
| 69 | + |
| 70 | +try { |
| 71 | + checkReadme(MIN_NODE_VERSION); |
| 72 | + |
| 73 | + var package = require('../package.json'); |
| 74 | + checkEngines(MIN_NODE_VERSION, package); |
| 75 | + |
| 76 | + var travisFileName = path.join(__dirname, '..', '.travis.yml'); |
| 77 | + var travisYaml = yaml.safeLoad(shell.cat(travisFileName)); |
| 78 | + checkTravis(MIN_NODE_VERSION, MAX_NODE_VERSION, travisYaml); |
| 79 | + |
| 80 | + var appveyorFileName = path.join(__dirname, '..', 'appveyor.yml'); |
| 81 | + var appveyorYaml = yaml.safeLoad(shell.cat(appveyorFileName)); |
| 82 | + checkAppveyor(MIN_NODE_VERSION, MAX_NODE_VERSION, appveyorYaml); |
| 83 | +} catch (e) { |
| 84 | + console.error('Please check the files which declare our Node version'); |
| 85 | + console.error('support, as something is out-of-sync. This script failed'); |
| 86 | + console.error('specificaly because:'); |
| 87 | + throw e; |
| 88 | +} |
0 commit comments