Skip to content

fix(helpUrl): ensure axe.configure always updates the help URLs - #5114

Merged
WilcoFiers merged 3 commits into
developfrom
ensure-lang-on-help-url
May 22, 2026
Merged

fix(helpUrl): ensure axe.configure always updates the help URLs#5114
WilcoFiers merged 3 commits into
developfrom
ensure-lang-on-help-url

Conversation

@WilcoFiers

@WilcoFiers WilcoFiers commented May 21, 2026

Copy link
Copy Markdown
Contributor

Noticed that most of the time the lang attribute isn't set on the helpURL like it's supposed to.

@WilcoFiers
WilcoFiers requested a review from a team as a code owner May 21, 2026 17:02
Copilot AI review requested due to automatic review settings May 21, 2026 17:02
Copilot AI reviewed May 21, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes help URL localization behavior by ensuring axe.configure() consistently rebuilds rule helpUrl values after branding and/or locale updates, so the lang query parameter is applied when a locale language is configured.

Changes:

  • Updated axe.configure() to always call audit._constructHelpUrls() after applying branding/locale, passing previous help URL settings (including lang) to enable correct updates.
  • Removed Audit#setBranding’s implicit help URL reconstruction so help URL updates are centralized in axe.configure().
  • Added/adjusted tests to verify helpUrl gains &lang=... on locale changes and that custom help URLs are not modified.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
test/core/public/configure.js Adds coverage ensuring locale lang updates propagate to default help URLs and do not alter custom help URLs.
test/core/base/audit.js Removes setBranding-driven help URL construction expectations and keeps help URL behavior tested under _constructHelpUrls.
lib/core/public/configure.js Captures previous help URL settings and always reconstructs help URLs after branding/locale configuration.
lib/core/base/audit.js Stops setBranding from triggering help URL reconstruction; minor JSDoc updates.
Comments suppressed due to low confidence (2)

lib/core/public/configure.js:58

  • There’s a whitespace-only line inside the throw new TypeError( block (and it appears to contain trailing spaces). This can trip no-trailing-spaces/formatting checks and reduces readability; remove the blank line (or restore a meaningful comment if needed).
      if (!check.id) {
        throw new TypeError(
          `Configured check ${JSON.stringify(
            check
          )} is invalid. Checks must be an object with at least an id property`
        );

lib/core/public/configure.js:78

  • Same issue here: a whitespace-only line was introduced inside the throw new TypeError( block. Please remove the blank line/trailing whitespace to avoid lint/formatting failures.
        throw new TypeError(
          `Configured rule ${JSON.stringify(
            rule
          )} is invalid. Rules must be an object with at least an id property`
        );
      }

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lib/core/base/audit.js
Comment on lines 411 to 414
/*
* Updates the default options and then applies them
* @param {Mixed} options Options object
* @param {Mixed} branding
*/
@WilcoFiers
WilcoFiers merged commit c4f60ff into develop May 22, 2026
22 checks passed
@WilcoFiers
WilcoFiers deleted the ensure-lang-on-help-url branch May 22, 2026 13:50
@attest-team-ci attest-team-ci mentioned this pull request Jun 1, 2026
Merged
WilcoFiers added a commit that referenced this pull request Jun 1, 2026
@WilcoFiers
chore(release): v4.12.0 (#5122)
0016ef9 
##
[4.12.0](v4.11.4...v4.12.0)
(2026-06-01)

### Features

- add gather-internals.js external script
([#5099](#5099))
([c61d58b](c61d58b)),
closes [#5080](#5080)
- **aria-allowed/prohibited-attr, aria-required-parent/children:**
partially support element internals role
([#5080](#5080))
([417b48a](417b48a)),
closes [#5039](#5039)
[#4259](#4259)
- **axe.externalAPIs:** add public api for setting elementInternal data
([#5105](#5105))
([63bab8f](63bab8f))
- **core:** expose normalizeRunOptions
([#4998](#4998))
([b8e6a59](b8e6a59))
- expose axe.resetLocale() to restore the default locale
([#5108](#5108))
([c2b5292](c2b5292)),
closes [#5107](#5107)
- **getRules:** include rule enabled state in returned objects
([#5118](#5118))
([75bf772](75bf772)),
closes [#5116](#5116)
- **list,listitem:** support element internals role
([#5119](#5119))
([7d9d696](7d9d696))
- **new-rule:** check that aria-tab have an accessible name
([#5001](#5001))
([0d4e4e7](0d4e4e7)),
closes [#4842](#4842)
- **rules:** deprecate landmark-complementary-is-top-level rules
([#4992](#4992))
([9e09139](9e09139)),
closes [#4950](#4950)
- **utils:** add `getElementInternals` function
([#5077](#5077))
([1c15f82](1c15f82))

### Bug Fixes

- **aria-allowed-attr:** restrict br and wbr elements to aria-hidden
only ([#4974](#4974))
([c6245e7](c6245e7))
- **aria-conditional-attr:** add support for radio
([#5100](#5100))
([8223c98](8223c98))
- **aria-valid-attr-value:** handle multiple aria-errormessage IDs
([#4973](#4973))
([0489e30](0489e30))
- **aria:** prevent getOwnedVirtual from returning duplicate nodes
([#4987](#4987))
([48ca955](48ca955)),
closes [#4840](#4840)
- **commons/text:** exclude natively hidden elements from
aria-labelledby accessible name
([#5076](#5076))
([ea7202c](ea7202c)),
closes [#4704](#4704)
- **DqElement:** avoid calling constructors with cloneNode
([#5013](#5013))
([0281fa1](0281fa1))
- **existing-rule:** aria-busy now shows an error message for a use with
unallowed children
([#5017](#5017))
([2067b87](2067b87))
- **helpUrl:** ensure axe.configure always updates the help URLs
([#5114](#5114))
([c4f60ff](c4f60ff))
- **label-content-name-mismatch:** match visible text with aria-label
and exclude invisible text
([#5096](#5096))
([3a012a1](3a012a1))
- **locale:** ensure all subtags are correctly set
([#5112](#5112))
([13005ed](13005ed))
- **scrollable-region-focusable:** clarify the issue is in safari
([#4995](#4995))
([4ec5211](4ec5211)),
closes
[WebKit#190870](https://github.com/dequelabs/WebKit/issues/190870)
[WebKit#277290](https://github.com/dequelabs/WebKit/issues/277290)
- **scrollable-region-focusable:** do not fail scroll areas when all
content is visible without scrolling
([#4993](#4993))
([838707a](838707a))
- **target-size:** determine offset using clientRects if target is
display:inline
([#5012](#5012))
([a4b8091](a4b8091))
- **target-size:** ignore position: fixed elements that are offscreen
when page is scrolled
([#5066](#5066))
([1229a6e](1229a6e)),
closes [#5065](#5065)
- **target-size:** ignore widgets that are inline with other inline
elements ([#5000](#5000))
([a8dd81b](a8dd81b))
- **utils/getAncestry:** escape node name
([#5079](#5079))
([d1fabaa](d1fabaa)),
closes [#5078](#5078)
- **utils:** Add null check to parseCrossOriginStylesheet, closes
[#5074](#5074)
([#5075](#5075))
([f12ef32](f12ef32))
- **utils:** update isShadowRoot to use spec-compliant custom element
regex ([#5059](#5059))
([edc6ce2](edc6ce2)),
closes [#5030](#5030)

This PR was opened by a robot 🤖 🎉
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@straker straker straker approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@WilcoFiers @straker