Merge remote-tracking branch 'origin/develop'

Author: Marcy Sutton

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+<a name="3.0.0-beta.1"></a>
+# [3.0.0-beta.1](https://github.com/dequelabs/axe-core/compare/v3.0.0-alpha.9...v3.0.0-beta.1) (2018-02-19)
+
+
+### Bug Fixes
+
+* **audio-caption:** Change tag wcag122 to wcag121 [#686](https://github.com/dequelabs/axe-core/issues/686) ([#721](https://github.com/dequelabs/axe-core/issues/721)) ([9c7b9f1](https://github.com/dequelabs/axe-core/commit/9c7b9f1))
+* **empty-heading:** Skip headings with the role changed [#645](https://github.com/dequelabs/axe-core/issues/645) ([#722](https://github.com/dequelabs/axe-core/issues/722)) ([80ef961](https://github.com/dequelabs/axe-core/commit/80ef961))
+* **image-alt:** Exclude svg[role="img"] elements ([#683](https://github.com/dequelabs/axe-core/issues/683)) ([0fe74d8](https://github.com/dequelabs/axe-core/commit/0fe74d8))
+* **label:** Prevent label rule from crashing on input without type [#678](https://github.com/dequelabs/axe-core/issues/678) ([#730](https://github.com/dequelabs/axe-core/issues/730)) ([4498680](https://github.com/dequelabs/axe-core/commit/4498680))
+* **perf:** improve select performance fixes [#702](https://github.com/dequelabs/axe-core/issues/702) ([3274919](https://github.com/dequelabs/axe-core/commit/3274919))
+* **perf:** memoize axe.utils.select ([c9cd122](https://github.com/dequelabs/axe-core/commit/c9cd122))
+* **perf:** normalize all selectors for better cache utilization ([189c165](https://github.com/dequelabs/axe-core/commit/189c165))
+* **perf:** remove need for node sorting from select completely ([7677a6a](https://github.com/dequelabs/axe-core/commit/7677a6a))
+* **performance:** significantly improve the performance of the dom.findUp utility fixes [#696](https://github.com/dequelabs/axe-core/issues/696) ([9197e03](https://github.com/dequelabs/axe-core/commit/9197e03))
+* add shadow dom coverage to all checks ([0e48413](https://github.com/dequelabs/axe-core/commit/0e48413)), closes [#690](https://github.com/dequelabs/axe-core/issues/690)
+* bug-705: cleanupPlugins() should not throw exception when no arguments are provided ([#709](https://github.com/dequelabs/axe-core/issues/709)) ([fb1d2f7](https://github.com/dequelabs/axe-core/commit/fb1d2f7))
+* Remove axe.a11yCheck() ([88d039f](https://github.com/dequelabs/axe-core/commit/88d039f))
+* use virtual methods where applicable ([6ddc4e5](https://github.com/dequelabs/axe-core/commit/6ddc4e5))
+* **type-checking:** Improve typescript axe.run call signature ([#707](https://github.com/dequelabs/axe-core/issues/707)) ([de45ee3](https://github.com/dequelabs/axe-core/commit/de45ee3))
+
+
+### Performance Improvements
+
+* Add performance metrics in Rule.runChecks ([#701](https://github.com/dequelabs/axe-core/issues/701)) ([27fdc2f](https://github.com/dequelabs/axe-core/commit/27fdc2f))
+
+
+
 <a name="3.0.0-alpha.9"></a>
 # [3.0.0-alpha.9](https://github.com/dequelabs/axe-core/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2018-01-18)
 

CONTRIBUTING.md

@@ -136,10 +136,12 @@ Installing aXe to run accessibility tests in your TypeScript project should be a
 import * as axe from 'axe-core';
 
 describe('Module', () => {
-	it('should have no accessibility violations', () => {
-		axe.a11yCheck(compiledFixture, {}, (results) => {
-			expect(results.violations.length).toBe(0);
-		});
+	it('should have no accessibility violations', (done) => {
+		axe.run(compiledFixture)
+			.then((results) => {
+				expect(results.violations.length).toBe(0);
+				done()
+			}, done);
 	});
 });
 ```

README.md

@@ -10,6 +10,8 @@
 
 The Accessibility Engine for automated testing of HTML-based user interfaces. Drop the aXe on your accessibility defects!
 
+Thanks for helping us to make axe-core the most widely used HTML accessibility testing library in the galaxy! Share your axe-core story using #axecoresquad or by submitting it [here](https://accessibility.deque.com/axe-core-stories) to get a sweet T-shirt.
+
 ## Philosophy
 
 We believe that automated testing has an important role to play in achieving digital equality and that in order to do that, it must achieve mainstream adoption by professional web developers. That means that the tests must inspire trust, must be fast, must work everywhere and must be available everywhere.
@@ -89,6 +91,8 @@ This will create a new build for aXe, called `axe.<lang>.js` and `axe.<lang>.min
 
 To create a new translation for aXe, start by running `grunt translate --lang=<langcode>`. This will create a json file fin the `./locales` directory, with the default English text in it for you to translate. We welcome any localization for axe-core. For details on how to contribute, see the Contributing section below.
 
+To update existing translation file, re-run `grunt translate --lang=<langcode>`. This will add new messages used in English and remove messages which were not used in English.
+
 ## Contributing
 
 Read the [Proposing Axe-core Rules guide ](./doc/rule-proposal.md)

axe.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for axe-core 3.0.0-alpha.9
+// Type definitions for axe-core 3.0.0-beta.1
 // Project: https://github.com/dequelabs/axe-core
 // Definitions by: Marcy Sutton <https://github.com/marcysutton>
 
@@ -12,6 +12,8 @@ declare module axe {
 
 	type RunOnlyType = "rule" | "rules" | "tag" | "tags";
 
+	type RunCallback = (error: Error, results:AxeResults) => void;
+
 	interface ElementContext {
 		node?: Object,
 		selector?: string,
@@ -26,6 +28,13 @@ declare module axe {
 		}
 		values?: TagValue[]
 	}
+	interface RunOptions {
+		runOnly?: RunOnly,
+		rules?: Object,
+		iframes?: Boolean,
+		elementRef?: Boolean,
+		selectors?: Boolean
+	}
 	interface AxeResults {
 		url: string,
 		timestamp: string,
@@ -117,22 +126,18 @@ declare module axe {
 	/**
 	 * Runs a number of rules against the provided HTML page and returns the resulting issue list
 	 *
-	 * @param  {Object}   context  Optional The `Context` specification object @see Context
-	 * @param  {Array}    options  Optional Options passed into rules or checks, temporarily modifying them.
-	 * @param  {Function} callback Optional The function to invoke when analysis is complete.
-	 * @returns {any}  	  results  If the callback was not defined, aXe will return a Promise instead.
-	 */
-	function run(context?: ElementContext, options?: {runOnly?: RunOnly, rules?: Object, iframes?: Boolean, elementRef?: Boolean, selectors?: Boolean}, callback?: (error: Error, results:AxeResults) => void): any
-
-	/**
-	 * Starts analysis on the current document and its subframes
-	 *
-	 * @param  {Object}   context  The `Context` specification object @see Context
-	 * @param  {Array}    options  Options passed into rules or checks, temporarily modifyint them.
-	 * @param  {Function} callback The function to invoke when analysis is complete.
-	 * @returns {Object}  results  The aXe results object
+	 * @param   {ElementContext} context  Optional The `Context` specification object @see Context
+	 * @param   {RunOptions}     options  Optional Options passed into rules or checks, temporarily modifying them.
+	 * @param   {RunCallback}    callback Optional The function to invoke when analysis is complete.
+	 * @returns {Promise<AxeResults>|void} If the callback was not defined, aXe will return a Promise.
 	 */
-	function a11yCheck(context: ElementContext, options: {runOnly?: RunOnly, rules?: Object, iframes?: Boolean, elementRef?: Boolean, selectors?: Boolean}, callback: (results:AxeResults) => void): AxeResults
+	function run(context: ElementContext): Promise<AxeResults>
+	function run(options: RunOptions): Promise<AxeResults>
+	function run(callback: (error: Error, results:AxeResults) => void): void
+	function run(context: ElementContext, callback: RunCallback): void
+	function run(options: RunOptions, callback: RunCallback): void
+	function run(context: ElementContext, options: RunOptions): Promise<AxeResults>
+	function run(context: ElementContext, options: RunOptions, callback: RunCallback): void
 
 	/**
 	 * Method for configuring the data format used by aXe. Helpful for adding new

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-core",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-beta.1",
   "contributors": [
     {
       "name": "David Sturley",

build/tasks/add-locale.js

@@ -1,8 +1,33 @@
 /*jshint node: true */
 'use strict';
+var clone = require('clone');
 var buildManual = require('../build-manual');
 
 module.exports = function (grunt) {
+  function mergeMessages (newMessages, oldMessages) {
+    Object.keys(newMessages).forEach(function (key) {
+      if (!oldMessages.hasOwnProperty(key)) {
+        return;
+      }
+
+      var newValue = newMessages[key];
+      var oldValue = oldMessages[key];
+
+      if (typeof newValue === 'object') {
+        // the message format might be changed, ignore old message
+        if (typeof oldValue !== 'object') {
+          return;
+        }
+
+        newMessages[key] = mergeMessages(clone(newValue), oldValue);
+      } else {
+        newMessages[key] = clone(oldValue);
+      }
+    });
+
+    return newMessages;
+  }
+
   grunt.registerMultiTask('add-locale',
   'Task for localizing messages in rules and checks',
   function () {
@@ -43,9 +68,18 @@ module.exports = function (grunt) {
           }, {})
         };
 
+        // update locale file if exists
+        var localeFile = './locales/' + options.lang + '.json';
+        if (grunt.file.exists(localeFile)) {
+          var oldMessages = grunt.file.readJSON(localeFile);
+
+          // mergeMessages mutates out
+          mergeMessages(out, oldMessages);
+        }
+
         grunt.file.write(file.dest, JSON.stringify(out, null, '  '));
         console.log('created file at', file.dest);
       });
     });
   });
-};
+};

circle.yml

@@ -1,3 +1,13 @@
-machine:
-  node:
-    version: v6.1.0
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node:6.12.3-browsers
+    steps:
+      - checkout
+      - run:
+          name: install-npm
+          command: npm install
+      - run:
+          name: test
+          command: npm test

doc/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!-- Thanks for reporting an issue to axe-core. Please provide all necessary info to reproduce the issue. Without adequate details, your issue may be closed without investigation. 
+
+If you’re reporting a bug, include a description of the issue and a page or code snippet where it can be reproduced. Please make sure you have tested this with the latest version of axe-core. When proposing a new rule, please use our rule template: https://github.com/dequelabs/axe-core/blob/develop/doc/rule-proposal.md
+
+Describe what the desired behavior would be, and how it applies to axe-core's  "Accessibility Supported" policy: https://github.com/dequelabs/axe-core/blob/develop/doc/accessibility-supported.md
+-->
+
+- Link to live demo:
+
+<pre><code>
+axe-core version: X.Y.Z
+axe-webdriver, extension or other integration version: X.Y.Z
+
+Browser and Assistive Technology versions
+
+For Tooling issues:
+- Node version: XX  <!-- run `node --version` -->
+- Platform:  <!-- Mac, Linux, Windows -->
+</code></pre>

doc/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+## PR Checklist
+Please check if your PR fulfills the following requirements:
+
+- [ ] The commit message(s) follow our guidelines: https://github.com/dequelabs/axe-core/blob/develop/doc/code-submission-guidelines.md#git-commits
+- [ ] Changes to rules and checks appropriately support [Shadow DOM](https://github.com/dequelabs/axe-core/blob/develop/doc/developer-guide.md)
+- [ ] Changes have been tested in [major browsers and Assistive Technologies](https://github.com/dequelabs/axe-core/blob/develop/doc/accessibility-supported.md#accessibility-supported)
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+## Description of the changes
+- Github issue:
+
+
+## Does this PR introduce a breaking change?
+```
+[ ] Yes
+[ ] No
+```
+
+
+## Other information