feat: list erroneous rules in results comment (#17)

AriPerkkio · Aug 8, 2021 · c45eaab · c45eaab
1 parent cd0d286
commit c45eaab
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/comment-templates.ts b/src/comment-templates.ts
@@ -1,6 +1,11 @@
 import { Result } from 'eslint-remote-tester/dist/exports-for-compare-action';
 import { requirePeerDependency } from './peer-dependencies';
 
+const filterUniqueTruthy = <T>(item: T, index: number, array: T[]) =>
+    item != null && array.indexOf(item) === index;
+
+const formatRule = (rule: string | null) => '\n-   `' + rule + '`';
+
 // prettier-ignore
 /**
  * Template for building github issue comment when action run into error
@@ -34,6 +39,8 @@ export const COMMENT_TEMPLATE = (
     const limitReached = results.length > maxResultCount;
     const limitedResults = results.slice(0, maxResultCount);
 
+    const rules = results.map(result => result.rule).filter(filterUniqueTruthy);
+
     // prettier-ignore
     return '' +
 `Detected ${results.length} ESLint reports and/or crashes. ${repositoryCount ? `
@@ -43,6 +50,8 @@ ${limitReached ?
 Reached maximum result count ${maxResultCount}.
 Showing ${limitedResults.length}/${results.length}
 ` : ''}
+Rules:${rules.map(formatRule).join('')}
+
 <details>
     <summary>Click to expand</summary>
 

diff --git a/test/comment-templates.test.ts b/test/comment-templates.test.ts
@@ -30,6 +30,10 @@ describe('COMMENT_TEMPLATE', () => {
             "Detected 2 ESLint reports and/or crashes. 
             Scanned 152 repositories.
 
+            Rules:
+            -   \`rule-1\`
+            -   \`rule-2\`
+
             <details>
                 <summary>Click to expand</summary>
 
@@ -80,6 +84,11 @@ describe('COMMENT_TEMPLATE', () => {
             Reached maximum result count 2.
             Showing 2/3
 
+            Rules:
+            -   \`rule-1\`
+            -   \`rule-2\`
+            -   \`rule-3\`
+
             <details>
                 <summary>Click to expand</summary>
 
@@ -129,6 +138,11 @@ describe('COMMENT_TEMPLATE', () => {
             Reached maximum result count 2.
             Showing 2/3
 
+            Rules:
+            -   \`rule-1\`
+            -   \`rule-2\`
+            -   \`rule-3\`
+
             <details>
                 <summary>Click to expand</summary>