refactor(core/public): Convert to ES modules (dequelabs#2167)

* webpack lib/public

* convert lib/public to modules

* test: fix cleanupPlugins

* test: fix failing tests in configure

* test: fix addRepoter failures

* fix runRules tests

* skip a bunch of tests which mock

* update todo note with issue link

* updates based on review

.eslintrc

@@ -74,6 +74,7 @@
   "overrides": [
     {
       "files": [
+        "lib/core/public/**/*.js",
         "lib/core/reporters/**/*.js",
         "lib/core/utils/*.js",
         "lib/commons/**/*.js"

Gruntfile.js

@@ -100,6 +100,7 @@ module.exports = function(grunt) {
 						cwd: 'lib/core',
 						src: [
 							'**/*.js',
+							'!public/**/*.js',
 							'!reporters/**/*.js',
 							'!utils/**/*.js',
 							'!imports/index.js'
@@ -113,7 +114,12 @@ module.exports = function(grunt) {
 					{
 						expand: true,
 						cwd: 'tmp',
-						src: ['*.js', 'core/reporters/reporters.js', 'core/utils/utils.js'],
+						src: [
+							'*.js',
+							'core/public/public.js',
+							'core/reporters/reporters.js',
+							'core/utils/utils.js'
+						],
 						dest: 'tmp'
 					}
 				]
@@ -165,6 +171,12 @@ module.exports = function(grunt) {
 			}
 		},
 		webpack: {
+			corePublic: createWebpackConfig(
+				'lib/core/public/public.js',
+				'tmp/core/public',
+				// Due to how the Babel/concat stuff works, this cannot be called `index.js`.
+				'public.js'
+			),
 			coreReporters: createWebpackConfig(
 				'lib/core/reporters/reporters.js',
 				'tmp/core/reporters',

lib/core/public/cleanup-plugins.js → lib/core/public/cleanup.js

@@ -1,5 +1,6 @@
-function cleanupPlugins(resolve, reject) {
+function cleanup(resolve, reject) {
 	'use strict';
+
 	resolve = resolve || function() {};
 	reject = reject || axe.log;
 
@@ -50,4 +51,5 @@ function cleanupPlugins(resolve, reject) {
 		}
 	}).catch(reject);
 }
-axe.cleanup = cleanupPlugins;
+
+export default cleanup;

lib/core/public/configure.js

@@ -1,5 +1,6 @@
-/* global reporters */
-function configureChecksRulesAndBranding(spec) {
+import { hasReporter } from './reporter';
+
+function configure(spec) {
 	'use strict';
 	var audit;
 
@@ -38,7 +39,7 @@ function configureChecksRulesAndBranding(spec) {
 
 	if (
 		spec.reporter &&
-		(typeof spec.reporter === 'function' || reporters[spec.reporter])
+		(typeof spec.reporter === 'function' || hasReporter(spec.reporter))
 	) {
 		audit.reporter = spec.reporter;
 	}
@@ -81,4 +82,4 @@ function configureChecksRulesAndBranding(spec) {
 	}
 }
 
-axe.configure = configureChecksRulesAndBranding;
+export default configure;

lib/core/public/get-rules.js

@@ -3,7 +3,7 @@
  * @param  {Array}   tags  Optional array of tags
  * @return {Array}  Array of rules
  */
-axe.getRules = function(tags) {
+function getRules(tags) {
 	'use strict';
 
 	tags = tags || [];
@@ -26,4 +26,6 @@ axe.getRules = function(tags) {
 			tags: matchingRule.tags
 		};
 	});
-};
+}
+
+export default getRules;

lib/core/public/load.js

@@ -1,5 +1,11 @@
-/*global Audit, runRules, cleanupPlugins */
+/*global Audit */
 /*eslint indent: 0*/
+
+// todo: import Audit when it has been converted to es modules
+
+import cleanup from './cleanup';
+import runRules from './run-rules';
+
 function runCommand(data, keepalive, callback) {
 	'use strict';
 	var resolve = callback;
@@ -29,7 +35,7 @@ function runCommand(data, keepalive, callback) {
 				reject
 			);
 		case 'cleanup-plugin':
-			return cleanupPlugins(resolve, reject);
+			return cleanup(resolve, reject);
 		default:
 			// go through the registered commands
 			if (
@@ -47,7 +53,7 @@ function runCommand(data, keepalive, callback) {
  * @param  {Object} audit The "audit specification" object
  * @private
  */
-axe._load = function(audit) {
+function load(audit) {
 	'use strict';
 
 	axe.utils.respondable.subscribe('axe.ping', function(
@@ -63,4 +69,6 @@ axe._load = function(audit) {
 	axe.utils.respondable.subscribe('axe.start', runCommand);
 
 	axe._audit = new Audit(audit);
-};
+}
+
+export default load;

lib/core/public/plugins.js

@@ -1,6 +1,4 @@
 /*eslint no-use-before-define:0 */
-var axe = axe || {};
-axe.plugins = {};
 
 function Plugin(spec) {
 	'use strict';
@@ -41,7 +39,9 @@ Plugin.prototype.add = function(impl) {
 	this._registry[impl.id] = impl;
 };
 
-axe.registerPlugin = function(plugin) {
+function registerPlugin(plugin) {
 	'use strict';
 	axe.plugins[plugin.id] = new Plugin(plugin);
-};
+}
+
+export default registerPlugin;

lib/core/public/public.js

@@ -0,0 +1,24 @@
+import cleanup from './cleanup';
+import configure from './configure';
+import getRules from './get-rules';
+import load from './load';
+import registerPlugin from './plugins';
+import { hasReporter, getReporter, addReporter } from './reporter';
+import reset from './reset';
+import runRules from './run-rules';
+import runVirtualRule from './run-virtual-rule';
+import run from './run';
+
+axe.cleanup = cleanup;
+axe.configure = configure;
+axe.getRules = getRules;
+axe._load = load;
+axe.plugins = {};
+axe.registerPlugin = registerPlugin;
+axe.hasReporter = hasReporter;
+axe.getReporter = getReporter;
+axe.addReporter = addReporter;
+axe.reset = reset;
+axe._runRules = runRules;
+axe.runVirtualRule = runVirtualRule;
+axe.run = run;

lib/core/public/reporter.js

@@ -1,7 +1,11 @@
-var reporters = {};
-var defaultReporter;
+const reporters = {};
+let defaultReporter;
 
-axe.getReporter = function(reporter) {
+export function hasReporter(reporterName) {
+	return reporters.hasOwnProperty(reporterName);
+}
+
+export function getReporter(reporter) {
 	'use strict';
 	if (typeof reporter === 'string' && reporters[reporter]) {
 		return reporters[reporter];
@@ -12,13 +16,13 @@ axe.getReporter = function(reporter) {
 	}
 
 	return defaultReporter;
-};
+}
 
-axe.addReporter = function registerReporter(name, cb, isDefault) {
+export function addReporter(name, cb, isDefault) {
 	'use strict';
 
 	reporters[name] = cb;
 	if (isDefault) {
 		defaultReporter = cb;
 	}
-};
+}

lib/core/public/reset.js

@@ -1,5 +1,5 @@
 /*global axe */
-function resetConfiguration() {
+function reset() {
 	'use strict';
 	var audit = axe._audit;
 
@@ -9,4 +9,4 @@ function resetConfiguration() {
 	audit.resetRulesAndChecks();
 }
 
-axe.reset = resetConfiguration;
+export default reset;

lib/core/public/run-rules.js

@@ -93,4 +93,4 @@ function runRules(context, options, resolve, reject) {
 	});
 }
 
-axe._runRules = runRules;
+export default runRules;

lib/core/public/run-virtual-rule.js

@@ -7,7 +7,7 @@
  * @param {Object} options  (optional) Set of options passed into rules or checks
  * @return {Object} axe results for the rule run
  */
-axe.runVirtualRule = function(ruleId, vNode, options = {}) {
+function runVirtualRule(ruleId, vNode, options = {}) {
 	options.reporter = options.reporter || axe._audit.reporter || 'v1';
 	axe._selectorData = {};
 
@@ -47,4 +47,6 @@ axe.runVirtualRule = function(ruleId, vNode, options = {}) {
 		...results,
 		toolOptions: options
 	};
-};
+}
+
+export default runVirtualRule;

lib/core/public/run.js

@@ -1,3 +1,5 @@
+import { getReporter } from './reporter';
+
 function isContext(potential) {
 	'use strict';
 	switch (true) {
@@ -79,7 +81,7 @@ function normalizeRunParams(context, options, callback) {
  *                             - Results  The results object / array, or undefined on error
  * @return {Promise}           Resolves with the axe results. Only available when natively supported
  */
-axe.run = function(context, options, callback) {
+function run(context, options, callback) {
 	'use strict';
 	if (!axe._audit) {
 		throw new Error('No audit configured');
@@ -136,7 +138,7 @@ axe.run = function(context, options, callback) {
 			}
 
 			try {
-				let reporter = axe.getReporter(options.reporter);
+				let reporter = getReporter(options.reporter);
 				let results = reporter(rawResults, options, respond);
 				if (results !== undefined) {
 					respond(results);
@@ -156,4 +158,6 @@ axe.run = function(context, options, callback) {
 	);
 
 	return p;
-};
+}
+
+export default run;