add tests for readme version updating

Author: Tim Layton

scripts/readme-update-version.js

@@ -1,22 +1,18 @@
-import {execSync} from 'child_process';
-import {writeFileSync, readFileSync} from 'fs-extra';
-import {resolve} from 'path';
-
+const {execSync} = require('child_process');
+const {writeFileSync, readFileSync} = require('fs-extra');
+const {resolve} = require('path');
 const {version: newVersion} = require('../package.json');
+const {semverRegExp, readmes} = require('./utilities');
 
 const root = resolve(__dirname, '..');
-const regExSemVer = new RegExp(
-  /(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/,
-  'g',
-);
 const readmes = Object.freeze(['README.md', 'src/components/README.md']);
 
 // eslint-disable-next-line no-console
 console.log(`🆕 Updating version in ${readmes.join(', ')}...`);
 readmes.map((readme) => resolve(root, readme)).forEach((file) => {
   writeFileSync(
     file,
-    readFileSync(file, 'utf8').replace(regExSemVer, newVersion),
+    readFileSync(file, 'utf8').replace(semverRegExp, newVersion),
   );
 });
 

scripts/utilities/index.js

@@ -0,0 +1,5 @@
+const {readmes} = require('./readmes');
+const {semverRegExp} = require('./semver-reg-exp');
+
+module.exports.readmes = readmes;
+module.exports.semverRegExp = semverRegExp;

scripts/utilities/readmes.js

@@ -0,0 +1,2 @@
+const readmes = Object.freeze(['README.md', 'src/components/README.md']);
+module.exports.readmes = readmes;

scripts/utilities/semver-reg-exp.js

@@ -0,0 +1,5 @@
+const semverRegExp = new RegExp(
+  /(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/,
+  'g',
+);
+module.exports.semverRegExp = semverRegExp;

tests/readme-update-version.test.js

@@ -0,0 +1,22 @@
+const fs = require('fs-extra');
+const {semverRegExp, readmes} = require('../scripts/utilities');
+
+describe('readme-update-version', () => {
+  it('matches 5 semver numbers in READMEs', () => {
+    let occurances = 0;
+    readmes.forEach((readmePath) => {
+      const readme = fs.readFileSync(readmePath, 'utf8');
+      occurances += (readme.match(semverRegExp) || []).length;
+    });
+
+    expect(occurances).toBe(5);
+  });
+
+  it('semverRegExp matches a variety of valid semver numbers', () => {
+    const testCase =
+      'Both version 2.5.0 and 99.99.99-beta.1 are valid, foo.bar.qux is not';
+    const occurances = (testCase.match(semverRegExp) || []).length;
+
+    expect(occurances).toBe(2);
+  });
+});