Automate accessibility support section processing based on rule's input aspects#37
Automate accessibility support section processing based on rule's input aspects#37carlosapaduarte wants to merge 7 commits intomainfrom
Conversation
zlayaAvocado
left a comment
zlayaAvocado
left a comment
There was a problem hiding this comment.
Let me know if I misunderstand something, this is my first act-rules PR review :)
| if (aspect.toLowerCase() in supportKeys) { | ||
| body = updateAccessibilitySupportInBody( | ||
| body, | ||
| supportKeys[aspect.toLowerCase()] |
There was a problem hiding this comment.
you are converting aspect.toLowerCase() twice, you can just do it once before the if statement
| return body; | ||
| } | ||
|
|
||
| function updateAccessibilitySupportInBody( |
There was a problem hiding this comment.
Is there a chance some other parts of the body will need to be updated? If so, this should be abstracted to 1. Get that part by heading name (e.g. Accessibility Support in this case) 2. Update the part based on the string we need to add
| body: string, | ||
| support: string | ||
| ): string { | ||
| const supportIndex = body.search(/\n###\s+Accessibility\s+Support\b/m); |
There was a problem hiding this comment.
Is it enforced somewhere that if a rule has accessibility support it will be exactly named "Accessibility Support"? Just want to make sure this can't be easily renamed and break this automation, or someone making a typo, e.g. "Acessibility Support"
I think anyway "Accessibility Support" and all other hardcoded strings, e.g. "There are no accessibility support issues known." should be constants, something along the lines
const SECTIONS = {
ACCESSIBILITY_SUPPORT: {
HEADING_PATTERN: /\n###\s+Accessibility\s+Support\b/mi,
HEADING: "Accessibility Support"
NO_ISSUES_TEXT: "There are no accessibility support issues known."
}
};
| ### Accessibility Support | ||
|
|
||
| There are no accessibility support issues known. |
There was a problem hiding this comment.
is it always going to be accurately formatted, e.g. with line breaks?
| // no support issues, replace with new support issue | ||
| return ( | ||
| body.substring(0, supportIndex) + | ||
| `\n### Accessibility Support\n\n${support}\n\n` + |
There was a problem hiding this comment.
is it a level 3 heading? I am seeing it as 2 here https://www.w3.org/WAI/standards-guidelines/act/rules/73f2c2/ but let me know if I am looking at the wrong page
|
@carlosapaduarte Can you also add a PR description (explain how / where it's going to update the accessibility support section), it will help me and any new people understand what this is doing better. Thank you! |
2 participants
No description provided.