feat(configure): accept ver property as axeVersion fallback (#1812)

* fix(configure): accept ver property as fallback * fix test
dequelabs · Sep 23, 2019 · 4ebcde8 · 4ebcde8
1 parent 1aa567c
commit 4ebcde8
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 6 deletions.
diff --git a/lib/core/public/configure.js b/lib/core/public/configure.js
@@ -8,12 +8,13 @@ function configureChecksRulesAndBranding(spec) {
 		throw new Error('No audit configured');
 	}
 
-	if (spec.axeVersion) {
-		if (!/^\d+\.\d+\.\d+(-canary)?/.test(spec.axeVersion)) {
-			throw new Error(`Invalid configured version ${spec.axeVersion}`);
+	if (spec.axeVersion || spec.ver) {
+		let specVersion = spec.axeVersion || spec.ver;
+		if (!/^\d+\.\d+\.\d+(-canary)?/.test(specVersion)) {
+			throw new Error(`Invalid configured version ${specVersion}`);
 		}
 
-		let [version, canary] = spec.axeVersion.split('-');
+		let [version, canary] = specVersion.split('-');
 		let [major, minor, patch] = version.split('.').map(Number);
 
 		let [axeVersion, axeCanary] = axe.version.split('-');
@@ -26,10 +27,11 @@ function configureChecksRulesAndBranding(spec) {
 			(major === axeMajor &&
 				minor === axeMinor &&
 				patch === axePatch &&
-				((canary && axeCanary) || (canary && !axeCanary)))
+				canary &&
+				canary !== axeCanary)
 		) {
 			throw new Error(
-				`Configured version ${spec.axeVersion} is not compatible with current axe version ${axe.version}`
+				`Configured version ${specVersion} is not compatible with current axe version ${axe.version}`
 			);
 		}
 	}

diff --git a/test/core/public/configure.js b/test/core/public/configure.js
@@ -585,6 +585,11 @@ describe('axe.configure', function() {
 				axe.configure({
 					axeVersion: '1.2.3'
 				});
+
+				axe.version = '1.2.3-canary.2664bae';
+				axe.configure({
+					axeVersion: '1.2.3-canary.2664bae'
+				});
 			});
 		});
 
@@ -690,5 +695,28 @@ describe('axe.configure', function() {
 				);
 			});
 		});
+
+		it('should accept ver property as fallback', function() {
+			assert.throws(function fn() {
+				axe.configure(
+					{
+						ver: '1.3.0'
+					},
+					/^Configured version/
+				);
+			});
+		});
+
+		it('should accept axeVersion over ver property', function() {
+			assert.throws(function fn() {
+				axe.configure(
+					{
+						ver: '0.1.2',
+						axeVersion: '1.3.0'
+					},
+					/^Configured version 1\.3\.0/
+				);
+			});
+		});
 	});
 });