Added related nodes

lpelypenko · Dec 24, 2020 · c8e8b4f · c8e8b4f
1 parent 916fe0f
commit c8e8b4f
Show file tree

Hide file tree

Showing 11 changed files with 809 additions and 2 deletions.
diff --git a/artifacts/accessibilityReport.html b/artifacts/accessibilityReport.html
diff --git a/artifacts/tcInapplicablePresent.html b/artifacts/tcInapplicablePresent.html
diff --git a/artifacts/tcIncludingCustomSummary.html b/artifacts/tcIncludingCustomSummary.html
diff --git a/artifacts/tcPassesAndViolations.html b/artifacts/tcPassesAndViolations.html
diff --git a/artifacts/tsAllOptionalParametersPresent.html b/artifacts/tsAllOptionalParametersPresent.html
diff --git a/artifacts/urlIsNotPassed.html b/artifacts/urlIsNotPassed.html
diff --git a/src/util/AxeReport.ts b/src/util/AxeReport.ts
@@ -17,6 +17,7 @@ interface NodeResult {
     targetNodes: string;
     fixSummaries: FixSummary[];
     index: number;
+    relatedNodesAny: string[]
 }
 
 interface Details {

diff --git a/src/util/prepareReportData.ts b/src/util/prepareReportData.ts
@@ -73,16 +73,32 @@ export function prepareReportData({
                 description,
                 help,
                 helpUrl,
-                nodes: nodes.map(({ target, html, failureSummary }, nodeIndex) => {
+                nodes: nodes.map(({ target, html, failureSummary, any }, nodeIndex) => {
                     const targetNodes = target.join('\n');
                     const defaultHighlight = {
                         highlight: 'Recommendation with the fix was not provided by axe result',
                     };
                     const fixSummaries: FixSummary[] = failureSummary
                         ? prepareFixSummary(failureSummary, defaultHighlight)
                         : [defaultHighlight];
+                    const relatedNodesAny: string[] = [];
+                    any.forEach((checkResult) => {
+                        if (checkResult.relatedNodes && checkResult.relatedNodes.length > 0) {
+                            checkResult.relatedNodes.forEach((node) => {
+                                if (node.target.length > 0) {
+                                    relatedNodesAny.push(node.target.join('\n'));
+                                }
+                            });
+                        }
+                    });
 
-                    return { targetNodes, html, fixSummaries, index: nodeIndex + 1 };
+                    return {
+                        targetNodes,
+                        html,
+                        fixSummaries,
+                        relatedNodesAny,
+                        index: nodeIndex + 1,
+                    };
                 }),
             };
         }

diff --git a/src/util/template/pageTemplate.html b/src/util/template/pageTemplate.html
@@ -185,6 +185,12 @@ <h6 class="card-subtitle mb-2 text-muted violationCardTitleItem">
                                             </ul>
                                         </div>
                                         {{/fixSummaries}}
+                                        {{#relatedNodesAny.length}}
+                                        <p><strong>Related node(s):</strong></p>
+                                        {{/relatedNodesAny.length}}
+                                        {{#relatedNodesAny}}
+                                        <pre><code class="css">{{.}}</code></pre>
+                                        {{/relatedNodesAny}}
                                     </td>
                                 </tr>
                                 {{/nodes}}

diff --git a/temp/tcPassesViolationsIncomplete.html b/temp/tcPassesViolationsIncomplete.html
diff --git a/test/__snapshots__/index.test.ts.snap b/test/__snapshots__/index.test.ts.snap