Merge pull request #1 from lpelypenko/improveOutputOnNoViolations

Improved output for no violations and added test
lpelypenko · Oct 27, 2020 · d219e1e · d219e1e
2 parents a507a23 + 4bf5204
commit d219e1e
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -12,9 +12,9 @@ export function prettyPrintAxeReport(report: SpecReportInput): void {
             passes: report.passes,
             url: report.url,
         });
+        console.info(preparedData.violationsTotal);
         // Print summary of violations as a table
         if (preparedData.violationsSummaryTable.length !== 0) {
-            console.info(preparedData.violationsTotal);
             if (!report.skipResultTable) {
                 console.table(preparedData.violationsSummaryTable);
             }

diff --git a/src/prepareReportData.ts b/src/prepareReportData.ts
@@ -34,6 +34,7 @@ export function getWcagReference(tags: string[]): string {
  * - detailed list of violations that could be printed as formatted text
  * @param violations
  * @param passes
+ * @param url
  */
 export function prepareReportData({ violations, passes, url }: SpecReportInput): SpecPreparedData {
     if (!violations) {
@@ -53,7 +54,9 @@ export function prepareReportData({ violations, passes, url }: SpecReportInput):
         : '';
     if (violations.length === 0) {
         return {
-            violationsTotal: 'No accessibility violation were detected',
+            violationsTotal: `No accessibility violation were detected${
+                url ? ` for the ${url}` : ''
+            }`,
             violationsSummaryTable: [],
             violationsDetailsFormatted: '',
             checksPassedSummary,
@@ -92,8 +95,9 @@ export function prepareReportData({ violations, passes, url }: SpecReportInput):
                     .join('\n')
             );
 
-            return `${i +
-                1}. ${axeRuleId}\t${learnMore}\n${name}\n${summary}\n${wcagRef}\n${nodeDetails}\n`;
+            return `${
+                i + 1
+            }. ${axeRuleId}\t${learnMore}\n${name}\n${summary}\n${wcagRef}\n${nodeDetails}\n`;
         })
         .join('\n');
 

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -21,6 +21,12 @@ describe('printAxeReport() test', () => {
             skipResultTable: true,
         });
     });
+    it('no violations', async () => {
+        prettyPrintAxeReport({
+            violations: [],
+            url: 'www.example.com',
+        });
+    });
     it('Verify throwing an  error if violations are not passed', async () => {
         expect(() => {
             //@ts-ignore