Add pa11y scanner #3949
Merged
Add pa11y scanner #3949
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, we did accessibility scanning for every file in every push / build / PR, which took > 25 mins each run. Now, we more carefully curate the files that need to be scanned, to limit the scan time. This commit: - Adds `npm run pa11y:list-files` command which runs a site build and outputs the files to be scanned for the current changeset - Adds a per-page pa11y scan, which lists pages that have changed or whose layouts have changed - Adds a site-wide pa11y scan: if files that affect the whole site change, take a sample of files from across the site to check - Incidentally deletes an unused layout - Moves _plugins/ to lib/ and ignores lib/ in the 11ty build - Pins the glob package to 8, because 9 and higher breaks something with the SVG Sprite package The code reads a little weird, and one more refactor could help.
beechnut
force-pushed
the
replatform/pa11y
branch
from
39fb4f9
to
7f5c57d
Compare
|
I added some non blocking suggestions related to readability, this feels like a great start Matt! |
caleywoods
approved these changes
Jun 20, 2024
lib/pa11y.js
Outdated
| } | ||
|
|
||
| function didSitewideFilesChange() { | ||
| const result = doesIntersect(changedFileSet(), sitewideFileSet()) |
There was a problem hiding this comment.
Non-blocking suggestion here, I might rename result to filesChanged.
lib/pa11y.js
Outdated
| return filesToWrite | ||
| } | ||
|
|
||
| async function pa11yScan ({ dir, results }) { |
There was a problem hiding this comment.
Non blocking question/suggestion: results sounds like it's an array of pages/files/documents sent from eleventy.after, if that's correct then maybe renaming results to have a little more context could help readability? If so I think the same renaming should occur where results is passed to the pa11yScan function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we did accessibility scanning for every file in every push / build / PR, which took > 25 mins each run.
Now, we more carefully curate the files that need to be scanned, to limit the scan time.
This PR:
Commentary:
This commit gets us to the "Make it work" stage, not yet addressing "Make it right" or "Make it fast".
The code also reads a little weird, and I'm not sure a conditional "eleventy.after" event is the right design for this. I think one more refactor here would be wise.
Closes #3875