chore: Merge pull request #1403 from dequelabs/release-320

chore: Release axe-core 3.2.0

circle.yml → .circleci/config.yml

@@ -2,14 +2,19 @@ version: 2
 
 defaults: &defaults
   docker:
-    - image: circleci/node:6.12.3-browsers
+    - image: circleci/node:10-browsers
   working_directory: ~/axe-core
 
 restore_dependency_cache: &restore_dependency_cache
   restore_cache:
     keys:
-      - v1-npm-cache-{{ checksum "package.json" }}
-      - v1-npm-cache-
+      - v{{ .Environment.CACHE_VERSION }}-npm-cache-{{ checksum "package.json" }}
+      - v{{ .Environment.CACHE_VERSION }}-npm-cache-
+
+restore_phantomjs_cache: &restore_phantomjs_cache
+  restore_cache:
+    keys:
+      - v{{ .Environment.CACHE_VERSION }}-phantomjs-2.1.1
 
 set_npm_auth: &set_npm_auth
   run: npm config set "//registry.npmjs.org/:_authToken" $NPM_AUTH
@@ -24,16 +29,32 @@ jobs:
       - <<: *restore_dependency_cache
       - run: npm install
       - save_cache:
-          key: v1-npm-cache-{{ checksum "package.json" }}
+          key: v{{ .Environment.CACHE_VERSION }}-npm-cache-{{ checksum "package.json" }}
           paths:
             - node_modules
 
+  # Run ESLINT
+  lint:
+    <<: *defaults
+    steps:
+      - checkout
+      - <<: *restore_dependency_cache
+      - run: npm run eslint
+
   # Run the test suite.
   test:
     <<: *defaults
     steps:
       - checkout
       - <<: *restore_dependency_cache
+      - <<: *restore_phantomjs_cache
+      - run:
+          name: PhantomJs - Install or Restore from Cache
+          command: 'sh .circleci/install-phantomjs.sh'
+      - save_cache:
+          key: v{{ .Environment.CACHE_VERSION }}-phantomjs-2.1.1
+          paths:
+            - phantomjs
       - run: npm run test
 
   # Release a "next" version
@@ -60,7 +81,12 @@ workflows:
   version: 2
   build:
     jobs:
+      # install deps
       - dependencies
+      # Run linting
+      - lint:
+          requires:
+            - dependencies
       # Run tests on all commits, but after installing dependencies
       - test:
           requires:
@@ -93,4 +119,4 @@ workflows:
             - hold
           filters:
             branches:
-              only: master
+              only: master

.circleci/install-phantomjs.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [ ! -e phantomjs ]; then
+	# phantomjs cache does not exist, fetch phantomjs
+  sudo curl --output phantomjs https://s3.amazonaws.com/circle-downloads/phantomjs-2.1.1
+fi
+
+# move phantomjs to bin
+sudo cp -r phantomjs /usr/local/bin/phantomjs
+
+# update permissions
+sudo chmod ugo+x /usr/local/bin/phantomjs

.eslintignore

@@ -1,4 +1,8 @@
-build/tasks/generate-imports.js
-!lib/core/imports/index.js
+**/node_modules/**/*.js
+
+build/tasks/aria-supported.js
+
+doc/api/*
+doc/examples/jest_react/*.js
+
 lib/core/imports/*.js
-doc/api/*

.eslintrc

@@ -4,7 +4,8 @@
     "ecmaVersion": 9
   },
   "env": {
-    "node": true
+    "node": true,
+    "es6": true
   },
   "globals": {
     "axe": true
@@ -63,6 +64,13 @@
     "no-shadow": 0,
     "dot-notation": 2,
     "no-new-func": 0,
-    "no-new-wrappers": 0
+    "no-new-wrappers": 0,
+    "no-restricted-syntax": [
+      "error",
+      {
+        "selector": "MemberExpression[property.name=tagName]",
+        "message": "Don't use node.tagName, use node.nodeName instead."
+      }
+    ]
   }
 }

.github/CODEOWNERS

@@ -1 +1,13 @@
+# Reference - https://help.github.com/articles/about-code-owners/
+
+# Complete repo
 * @dequelabs/axe-codeowners
+
+# Localisation
+locales/ja.json @mlca11y/mlca11y @dequelabs/axe-codeowners
+
+# Core features
+lib/core/* @stephenmathieson @dequelabs/axe-codeowners
+test/core/* @stephenmathieson @dequelabs/axe-codeowners
+build/* @stephenmathieson @dequelabs/axe-codeowners
+Gruntfile.js @stephenmathieson @dequelabs/axe-codeowners

.github/ISSUE_TEMPLATE.md

@@ -1,11 +1,16 @@
-<!-- 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. 
+<!--
+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:
+Expectation: << Describe what you expect the product to do >>
+
+Actual: << Describe what the product actually does >>
+
+Motivation: << Describe why you want the behavior to be changed >>
 
 <pre><code>
 axe-core version: X.Y.Z
@@ -16,4 +21,4 @@ Browser and Assistive Technology versions
 For Tooling issues:
 - Node version: XX  <!-- run `node --version` -->
 - Platform:  <!-- Mac, Linux, Windows -->
-</code></pre>
+</code></pre>

.gitignore

@@ -1,22 +1,28 @@
-tmp
-dist
+# defaults
 node_modules
+npm-shrinkwrap.json
+package-lock.json
+.DS_Store
+.vscode
+
+# tmp - `dev` time generated assets
+tmp
+
+# test - runner generated assets
 test/*/index.html
 test/integration/*/index.html
+
+# dist
 axe.js
 axe.*.js
-*.tgz
-npm-shrinkwrap.json
+
+
+# generated jsdoc api docs
+doc/api/*
+
+# ts generated file
 typings/axe-core/axe-core-tests.js
-doc/rule-descriptions.*.md
-package-lock.json
-.DS_Store
-!lib/core/imports/index.js
-lib/core/imports/*.js
 
-# running circleci locally to verify build, ignoring relevant files
-# if circle and docker is configured locally (copy circle.yml to .circleci/config.yml) - run -> circleci build
-.circleci/**/*.* 
+# doc
+doc/rule-descriptions.*.md
 
-# ignore jsdoc api documentation generated files
-doc/api/*

.huskyrc

@@ -0,0 +1,5 @@
+{
+	"hooks": {
+		"pre-commit": "grunt configure && lint-staged"
+	}
+}

.prettierignore

@@ -0,0 +1 @@
+node_modules/