Update 4.x with master updates

.github/ISSUE_TEMPLATE/accessibility_issue.yaml

@@ -20,12 +20,11 @@ body:
       multiple: true
       options: 
         - 'able site'
-        - 'a11y checker engine'
-        - 'a11y checker extension'
-        - 'a11y checker'
-        - 'cypress accessibility checker'
-        - 'karma accessibility checker'
-        - 'rule-server'
+        - 'accessibility-checker-engine'
+        - 'extension-checker'
+        - 'accessibility-checker for Node'
+        - 'cypress-accessibility-checker'
+        - 'karma-accessibility-checker'
         - 'other'
     validations:
       required: true

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -18,12 +18,11 @@ body:
       multiple: true
       options: 
         - 'able site'
-        - 'a11y checker engine'
-        - 'a11y checker extension'
-        - 'a11y checker'
-        - 'cypress accessibility checker'
-        - 'karma accessibility checker'
-        - 'rule-server'
+        - 'accessibility-checker-engine'
+        - 'extension-checker'
+        - 'accessibility-checker for Node'
+        - 'cypress-accessibility-checker'
+        - 'karma-accessibility-checker'
         - 'other'
     validations:
       required: true

.github/ISSUE_TEMPLATE/feature_request_or_enhancement.yaml

@@ -18,12 +18,11 @@ body:
       multiple: true
       options: 
         - 'able site'
-        - 'a11y checker engine'
-        - 'a11y checker extension'
-        - 'a11y checker'
-        - 'cypress accessibility checker'
-        - 'karma accessibility checker'
-        - 'rule-server'
+        - 'accessibility-checker-engine'
+        - 'extension-checker'
+        - 'accessibility-checker for Node'
+        - 'cypress-accessibility-checker'
+        - 'karma-accessibility-checker'
         - 'other'
     validations:
       required: true

.github/ISSUE_TEMPLATE/question.yaml

@@ -18,12 +18,11 @@ body:
       multiple: true
       options: 
         - 'able site'
-        - 'a11y checker engine'
-        - 'a11y checker extension'
-        - 'a11y checker'
-        - 'cypress accessibility checker'
-        - 'karma accessibility checker'
-        - 'rule-server'
+        - 'accessibility-checker-engine'
+        - 'extension-checker'
+        - 'accessibility-checker for Node'
+        - 'cypress-accessibility-checker'
+        - 'karma-accessibility-checker'
         - 'other'
     validations:
       required: true

.github/pull_request_template.md

@@ -1,19 +1,4 @@
-<!-- The title of this PR will be used for release notes, please provide a relevant title. 
-The following formats should be use for the release notes and PRs.
-
-**Rule/Engine updates:**
-newrule(`ruleid`): Title of PR
-fixrule(`ruleid`): Title of PR
-feature(engine): Title of PR
-fix(engine): Title of PR
-chore(`ruleid`|engine): Title of PR
-
-**Tool updates:
-feature(extension|node|karma|cypress): Title of PR
-fix(extension|node|karma|cypress): Title of PR
-chore(extension|node|karma|cypress|repo): Title of PR
-
-Please review more info: https://github.com/IBMa/equal-access/wiki/Release-notes -->
+<!-- For instructions regarding the PR title, see the bottom of the PR template -->
 
 <!-- Specify what this PR is doing. Remove all that do not apply -->
 * New Rule(s): **List rule IDs**
@@ -24,20 +9,30 @@ Please review more info: https://github.com/IBMa/equal-access/wiki/Release-notes
 * Other (Provide information)
 
 ### This PR is related to the following issue(s): 
-- <!-- Provide each ticket on a new line with # -->
-
-
-### Additional information can be found here: 
-- <!-- Provide the name of the rule & reference link or doc(s) -->
-
+<!-- Provide each ticket on a new line with "Fixes" to close when the PR closes (e.g., Fixes #000) -->
+- 
 
 ### Testing reference: 
-- <!-- Provide testing file(s) or/and code sandbox link(s). Also, provide details on the expected behavior -->
-
+<!-- Provide testing file(s) or/and code sandbox link(s). Also, provide details on the expected behavior -->
+- 
 
 ### I have conducted the following for this PR: 
 - [ ] I validated this code in Chrome and FF 
 - [ ] I validated this fix in my local env
 - [ ] I provided details for testing
 - [ ] This PR has been reviewed and is ready for test  
 - [ ] I understand that the title of this PR will be used for the next release notes.
+
+<!--
+-- TITLE INSTRUCTIONS START: DO NOT EDIT THIS SECTION --
+The title of this PR will be used for release notes, please provide a relevant title. 
+The following templates should be used for the PR titles:
+- newrule(`ruleid`): Title of PR
+- fixrule(`ruleid`): Title of PR
+- feature(engine|extension|node|karma|cypress): Title of PR
+- fix(engine|extension|node|karma|cypress): Title of PR
+- chore(engine|extension|node|karma|cypress|repo): Title of PR
+
+Please review more info: https://github.com/IBMa/equal-access/wiki/Release-notes 
+-- TITLE INSTRUCTIONS END --
+-->

.github/workflows/master.yml

@@ -29,6 +29,8 @@ jobs:
       working-directory: report-react
     - run: npm install
       working-directory: accessibility-checker-extension
+    - run: npm install
+      working-directory: accessibility-checker-extension/test
     - run: npm install
       working-directory: rule-server
     - run: npm run build

.github/workflows/publish.yml

@@ -145,6 +145,8 @@ jobs:
       working-directory: report-react
     - run: npm install
       working-directory: accessibility-checker-extension
+    - run: npm install
+      working-directory: accessibility-checker-extension/test
     - run: npm install
       working-directory: rule-server
     - run: npm run build

.github/workflows/test.yml

@@ -3,7 +3,7 @@
 
 name: All branch testing
 
-on: [ pull_request ]
+on: [ pull_request, merge_group ]
 
 jobs:
 ###############################################################################
@@ -40,6 +40,12 @@ jobs:
       working-directory: accessibility-checker-engine
     - run: npx mocha ./test/mocha/help/help.test.js
       working-directory: accessibility-checker-engine
+    - name: Upload rule listing
+      uses: actions/upload-artifact@v1
+      with:
+        name: Rule listing
+        path: accessibility-checker-engine/dist/help/rules.html
+
 
   act-results:
     runs-on: ubuntu-22.04
@@ -326,6 +332,11 @@ jobs:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
         cache-dependency-path: '**/package-lock.json'
+    - name: Latest Chrome
+      uses: browser-actions/setup-chrome@v1
+      with:
+        chrome-version: latest
+      id: setup-chrome
     - run: npm install
       working-directory: rule-server
     - run: npm run build
@@ -440,7 +451,7 @@ jobs:
         working-directory: cypress-accessibility-checker/test
 
 ###############################################################################
-# Extension Build verification
+# Extension Build verification and test
 ####
   extension-test:
     runs-on: ubuntu-22.04
@@ -461,6 +472,8 @@ jobs:
       working-directory: report-react
     - run: npm install
       working-directory: accessibility-checker-extension
+    - run: npm install
+      working-directory: accessibility-checker-extension/test
     - run: npm install
       working-directory: rule-server
     - run: npm run build
@@ -473,6 +486,9 @@ jobs:
       working-directory: accessibility-checker-extension
     - run: npm run package:browser
       working-directory: accessibility-checker-extension
+    - name: UI Tests
+      run: npm test
+      working-directory: accessibility-checker-extension/test
     - name: Upload packed extension
       uses: actions/upload-artifact@v1
       with:
@@ -512,4 +528,4 @@ jobs:
         BLUEMIX_USERID: apikey
         BLUEMIX_PASS: ${{ secrets.BLUEMIX_PASS }}
         CLOUD_PWD: ${{ secrets.CLOUD_PWD }}
-        TRAVIS_BRANCH: sandbox
+        TRAVIS_BRANCH: sandbox

README.md

@@ -1,24 +1,35 @@
 # equal-access
 
-This Git repository hosts tools and supporting components that are part of the [IBM Equal Access Toolkit](https://ibm.com/able/toolkit).
+This Git repository hosts tools and supporting components of the [IBM Equal Access Toolkit](https://ibm.com/able/toolkit).
+The Toolkit provides the tools and guidance to create experiences that are delightful for people of all abilities.
+The guidance is organized by phase, such as Plan, Design, Develop, and Verify, and explains how to integrate these automated testing tools into the [Verify phase](https://www.ibm.com/able/toolkit/verify/overview).
+The Toolkit is a major part of the accessibility information and applications at [ibm.com/able](https://ibm.com/able/).
 
 ## Overview
 
-This README covers topics for users who want to find the deployed tools as well as topics for developers who want to better understand the various components and build the tools.
+This README covers topics for users who want to find and install the deployed tools as well as topics for developers who want to better understand the various components and build the tools themselves.
 
 The [wiki](https://github.com/IBMa/equal-access/wiki) contains overview information, links to videos, and other resources.
+See the [Release Notes](https://github.com/IBMa/equal-access/releases) for the latest deployed changes in the tools, rules, and components.
 
 ## Usage
 
-The tools have been deployed to the various stores and NPM so they can be easily downloaded and installed:
+The tools have been deployed to the browser and NPM stores so they can be easily downloaded and installed.
 
-* [Chrome accessibility-checker-extension](https://chrome.google.com/webstore/detail/ibm-equal-access-accessib/lkcagbfjnkomcinoddgooolagloogehp) : web browser extension that integrates automated accessibility checking capabilities into the Chrome Developer Tools
-* [Firefox accessibility-checker-extension](https://addons.mozilla.org/en-US/firefox/addon/accessibility-checker/) : web browser extension that integrates automated accessibility checking capabilities into the Firefox Web Developer Tools
-* [Node accessibility-checker](https://www.npmjs.com/package/accessibility-checker): automated accessibility testing within a continuous integration pipeline such as Travis CI for Node-based test environments such as Selenium, Puppeteer, Playwright, and Zombie; the ability to validate results against baseline files, and scan local files
-* [karma-accessibility-checker](https://www.npmjs.com/package/karma-accessibility-checker): automated accessibility testing for the Karma environment
-* [cypress-accessibility-checker](https://www.npmjs.com/package/cypress-accessibility-checker): wrapper of the `accessibility-checker` in the Cypress environment
+#### Browser extensions
 
-## Requirements
+The browser extensions provide an integrated checking experience and visualizations to help users quickly identify the source of accessibility issues and try fixes:
+
+* [Chrome Web Store extension](https://chrome.google.com/webstore/detail/ibm-equal-access-accessib/lkcagbfjnkomcinoddgooolagloogehp) : web browser extension that integrates automated accessibility checking capabilities into the Chrome Developer Tools.
+* [Firefox Add-on extension](https://addons.mozilla.org/en-US/firefox/addon/accessibility-checker/) : web browser extension that integrates automated accessibility checking capabilities into the Firefox Web Developer Tools.
+* [Edge Add-on extension](https://microsoftedge.microsoft.com/addons/detail/ibm-equal-access-accessib/ompccpejakabkmfepbijnagedbdfldka) : web browser extension that integrates automated accessibility checking capabilities into the Edge Developer Tools.
+
+#### Automated testing packages
+* [Node accessibility-checker](https://www.npmjs.com/package/accessibility-checker): automated accessibility testing within a continuous integration pipeline, such as Travis CI for Node-based test environments, that works with test frameworks such as Selenium, Puppeteer, Playwright, and Zombie; and provides the ability to validate results against baseline files, and scan local files.
+* [Karma-accessibility-checker](https://www.npmjs.com/package/karma-accessibility-checker): automated accessibility testing for the Karma environment.
+* [Cypress-accessibility-checker](https://www.npmjs.com/package/cypress-accessibility-checker): wrapper of the `accessibility-checker` in the Cypress environment.
+
+## Requirements for building the tools
 
 * [Node Version 18](https://nodejs.org/en/download/).
 
@@ -83,7 +94,7 @@ $ npm run build
   * ace-node-debug.js: uncompressed javascript library to be used in a NodeJS environment for development
   * ace-node.js: compressed javascript library to be used in a NodeJS environment for production
 * In the equal-access/accessibility-checker/package directory
-  * java script source that can be installed or deployed as npm package that works with an HTML parsing engines such as Selenium, Puppeteer, Playwright, or Zombie to allow developers to perform integrated accessibility testing within a continuous integration pipeline such as Travis CI. Please view more [details](accessibility-checker/src/README.md).
+  * JavaScript source that can be installed or deployed as npm package that works with an HTML parsing engines, such as Selenium, Puppeteer, Playwright, or Zombie to allow developers to perform integrated accessibility testing within a continuous integration pipeline, such as Travis CI. Please view more [details](accessibility-checker/src/README.md).
 * In the equal-access/karma-accessibility-checker/package directory
   * javascript source that can be used as a Karma plugin, see more [details](karma-accessibility-checker/README.md).
 
@@ -99,7 +110,7 @@ Please check the README for each individual tool for its build instructions:
 
 ## Feedback and reporting bugs
 
-If you think you've found a bug, have questions or suggestions, open a [GitHub Issue](https://github.com/IBMa/equal-access/issues). If you are an IBM employee, feel free to ask questions in the IBM internal Slack channel `#accessibility-at-ibm`.
+If you think you've found a bug, have questions or suggestions, open a [GitHub Issue](https://github.com/IBMa/equal-access/issues/new/choose). If you are an IBM employee, feel free to ask questions in the IBM internal Slack channel `#accessibility-at-ibm`.
 
 ## License
 

accessibility-checker-engine/README-NPM.md

@@ -2,7 +2,10 @@
 
 ## Overview
 
-`accessibility-checker-engine` is a DOM, rule-based engine for detecting issues in web applications. The engine is used by the [IBM Equal Access Accessibility Checker](https://www.ibm.com/able/toolkit/tools#develop) suite of tools. The rules and engine are fully written in JavaScript and can be injected directly into web pages and applications.
+`accessibility-checker-engine` is a rules-based engine for detecting issues in the Document Object Model (DOM) of web applications and content.
+
+- The engine is used by the [IBM Equal Access Accessibility Checker](https://www.ibm.com/able/toolkit/tools#develop) suite of tools.
+- The rules and engine are written in JavaScript and can be injected directly into web pages and applications.
 
 ## Get the engine
 
@@ -43,9 +46,12 @@ checker.check(doc, ["IBM_Accessibility"])
 * `["IBM_Accessibility"]` - apply IBM accessibility ruleset.
 * `report` - accessibility results contains identified accessibility issues and their descriptions from the given `doc`, and a summary of the issues. The report is in JSON format (see [details](#report)).
 
-## Checklist and Rulesets
+## Rules and Rulesets
 
-The rule are based on the IBM [Checklist](https://www.ibm.com/able/guidelines/ci162/accessibility_checklist.html), which is a superset of WCAG 2.1 AA. We also provide a WCAG 2.0 AA rulesets. Mappings from the checklists to rules are defined in the [ruleset file](https://github.com/IBMa/equal-access/blob/master/accessibility-checker-engine/src/v2/checker/accessibility/rulesets/index.ts)
+* Rules are based on the [IBM Accessibility requirements](https://www.ibm.com/able/requirements/requirements/), which is a unified set of WCAG, EN 301 549, and US 508 standards.
+* Rules are harmonized with the open rules published by the [W3C ACT-Rules Community](https://www.w3.org/community/act-r/) group as reported in the [IBM Equal Access Accessibility Checker ACT implementation report](https://wai-wcag-act-rules.netlify.app/standards-guidelines/act/implementations/equal-access/).
+* Rule sets, such as `IBM Accessibility v7.2`, `WCAG 2.2 (A & AA)`, `WCAG 2.1 (A & AA)`, and `WCAG 2.0 (A & AA)`and mappings of the rules to the standards (Requirements), Rule IDs, the individual failure messages, and links to the Help files are published at [Checker rule sets](https://www.ibm.com/able/requirements/checker-rule-sets).
+* Mappings of the rules are defined in the [individual rule_ID_name.ts files](https://github.com/IBMa/equal-access/tree/master/accessibility-checker-engine/src/v4/rules).
 
 ## Report
 
@@ -202,7 +208,7 @@ The following code snippet demonstrates how to use ACE to test a web page for ac
 
 ### Browser extensions
 
-You can use the [accessibility-checker-extension](https://www.ibm.com/able/toolkit/tools/#develop) for Chrome or Firefox. The browser extensions integrate the accessibility web engine (ace.js) and formatted results into the browser developer tool to visually view the accessibility issues and the locations of violating components. For more information and instructions, please view [accessibility-checker-extensions](https://www.ibm.com/able/toolkit/tools/#develop).
+You can use the [accessibility-checker-extension](https://www.ibm.com/able/toolkit/tools/#develop) for Chrome, Edge, or Firefox. The browser extensions integrate the accessibility web engine (ace.js) and formatted results into the browser developer tool to view the accessibility issues and the locations of violating components. For more information and instructions, please view [accessibility-checker-extensions](https://www.ibm.com/able/toolkit/tools/#develop).
 
 ### Integration with test frameworks