fix: update json export to properly parse tagName elements #6132
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.
Details
Our Assessment JSON export mechanism surfaces the rule id and description for each requirement. The description originates as JSX and then gets converted into a string. This works fine for the majority of our requirements, where the JSX
props
containchildren
that mostly include innerText. This is not the case for several requirements that includeMarkup.Tag
tags.For example, the Semantics Assessment's "Header Attribute" Requirement includes two
Markup.Tag
tags fortd
andth
that do not havechildren
.When our JSON exporter encounters tags without children, it appends "undefined" to the string:
This fix adapts our description builder to look for the
tagName
property ifchildren
does not exist.Motivation
Addresses issue #6122
Pull request checklist
yarn null:autoadd
yarn fastpass
yarn test
)<rootDir>/test-results/unit/coverage
fix:
,chore:
,feat(feature-name):
,refactor:
). SeeCONTRIBUTING.md
.