Include rule name. Closes #1

jerone · jerone · commit 907bdab00278 · 2022-08-22T17:10:10.000+02:00
diff --git a/src/index.js b/src/index.js
@@ -21,15 +21,20 @@ module.exports = (results = []) => {
   }
 
   function reportMessage(result) {
-    const lineColumn = `#${result.line}|${result.column}`;
+    let message = "     ";
     switch (result.severity) {
       case 2:
-        return `     ${prefixes.error} ${error(lineColumn)}: ${result.message}`;
+        message += prefixes.error;
+        message += ` ${error(`#${result.line}|${result.column}`)}`;
+        break;
       case 1:
-        return `     ${prefixes.warning} ${warning(lineColumn)}: ${
-          result.message
-        }`;
+        message += prefixes.warning;
+        message += ` ${warning(`#${result.line}|${result.column}`)}`;
+        break;
     }
+    message += `: ${result.message}`;
+    message += ` [${result.ruleId}]`;
+    return message;
   }
 
   function reportSummary(result) {
diff --git a/tests/fixtures/mixed.json b/tests/fixtures/mixed.json
@@ -7,12 +7,14 @@
         "column": 1,
         "line": 1,
         "message": "Unexpected console statement.",
+        "ruleId": "no-console",
         "severity": 1
       },
       {
         "column": 2,
         "line": 2,
         "message": "Unexpected console statement.",
+        "ruleId": "no-console",
         "severity": 1
       }
     ],
@@ -25,12 +27,14 @@
       {
         "column": 1,
         "line": 1,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 2
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 2
       }
@@ -43,13 +47,15 @@
     "messages": [
       {
         "column": 1,
+        "ruleId": "no-console",
         "line": 1,
         "message": "Unexpected console statement.",
         "severity": 1
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 2
       }
diff --git a/tests/fixtures/multiple-errors.json b/tests/fixtures/multiple-errors.json
@@ -5,12 +5,14 @@
       {
         "column": 1,
         "line": 1,
+        "ruleId": "no-console",
         "severity": 1,
         "message": "Unexpected console statement."
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "severity": 2,
         "message": "Unexpected console statement."
       }
@@ -23,13 +25,15 @@
     "messages": [
       {
         "column": 1,
+        "ruleId": "no-console",
         "line": 1,
         "severity": 1,
         "message": "Unexpected console statement."
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "severity": 2,
         "message": "Unexpected console statement."
       }
diff --git a/tests/fixtures/multiple-warnings.json b/tests/fixtures/multiple-warnings.json
@@ -5,13 +5,15 @@
     "messages": [
       {
         "column": 1,
+        "ruleId": "no-console",
         "line": 1,
         "message": "Unexpected console statement.",
         "severity": 1
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 1
       }
@@ -25,13 +27,15 @@
       {
         "column": 1,
         "line": 1,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 1
       },
       {
         "column": 2,
         "line": 2,
         "message": "Unexpected console statement.",
+        "ruleId": "no-console",
         "severity": 1
       }
     ],
diff --git a/tests/fixtures/single-error.json b/tests/fixtures/single-error.json
@@ -5,13 +5,15 @@
     "messages": [
       {
         "column": 1,
+        "ruleId": "no-console",
         "line": 1,
         "message": "Unexpected console statement.",
         "severity": 1
       },
       {
         "column": 2,
         "line": 2,
+        "ruleId": "no-console",
         "message": "Unexpected console statement.",
         "severity": 2
       }
diff --git a/tests/fixtures/single-warning.json b/tests/fixtures/single-warning.json
@@ -7,6 +7,7 @@
         "column": 1,
         "line": 1,
         "message": "Unexpected console statement.",
+        "ruleId": "no-console",
         "severity": 1
       }
     ],
diff --git a/tests/index.test.js b/tests/index.test.js
@@ -14,8 +14,8 @@ describe("single file", () => {
     const output = formatter(fixtureSingleError);
     expect(output).toBe(`\
   ✗ ${error("index1.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ✗ ${error("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ✗ ${error("#2|2")}: Unexpected console statement. [no-console]
 
 ✗ ${error("Error!")} » 1 error and 1 warning in 1 file`);
   });
@@ -24,7 +24,7 @@ describe("single file", () => {
     const output = formatter(fixtureSingleWarning);
     expect(output).toBe(`\
   ⚡ ${warning("index1.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
 
 ⚡ ${warning("Warning!")} » 0 errors and 1 warning in 1 file`);
   });
@@ -43,11 +43,11 @@ describe("multiple files", () => {
     const output = formatter(fixtureMultipleErrors);
     expect(output).toBe(`\
   ✗ ${error("index1.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ✗ ${error("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ✗ ${error("#2|2")}: Unexpected console statement. [no-console]
   ✗ ${error("index2.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ✗ ${error("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ✗ ${error("#2|2")}: Unexpected console statement. [no-console]
 
 ✗ ${error("Error!")} » 2 errors and 2 warnings in 2 files`);
   });
@@ -56,11 +56,11 @@ describe("multiple files", () => {
     const output = formatter(fixtureMultipleWarnings);
     expect(output).toBe(`\
   ⚡ ${warning("index1.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ⚡ ${warning("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ⚡ ${warning("#2|2")}: Unexpected console statement. [no-console]
   ⚡ ${warning("index2.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ⚡ ${warning("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ⚡ ${warning("#2|2")}: Unexpected console statement. [no-console]
 
 ⚡ ${warning("Warning!")} » 0 errors and 4 warnings in 2 files`);
   });
@@ -78,14 +78,14 @@ describe("multiple files", () => {
     const output = formatter(fixtureMixed);
     expect(output).toBe(`\
   ⚡ ${warning("index1.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ⚡ ${warning("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ⚡ ${warning("#2|2")}: Unexpected console statement. [no-console]
   ✗ ${error("index2.js")}
-     ✗ ${error("#1|1")}: Unexpected console statement.
-     ✗ ${error("#2|2")}: Unexpected console statement.
+     ✗ ${error("#1|1")}: Unexpected console statement. [no-console]
+     ✗ ${error("#2|2")}: Unexpected console statement. [no-console]
   ✗ ${error("index3.js")}
-     ⚡ ${warning("#1|1")}: Unexpected console statement.
-     ✗ ${error("#2|2")}: Unexpected console statement.
+     ⚡ ${warning("#1|1")}: Unexpected console statement. [no-console]
+     ✗ ${error("#2|2")}: Unexpected console statement. [no-console]
   ✓ ${success("index4.js")}
 
 ✗ ${error("Error!")} » 3 errors and 3 warnings in 4 files`);

Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,14 @@`
`7`	`7`	`"column": 1,`
`8`	`8`	`"line": 1,`
`9`	`9`	`"message": "Unexpected console statement.",`
	`10`	`+ "ruleId": "no-console",`
`10`	`11`	`"severity": 1`
`11`	`12`	`},`
`12`	`13`	`{`
`13`	`14`	`"column": 2,`
`14`	`15`	`"line": 2,`
`15`	`16`	`"message": "Unexpected console statement.",`
	`17`	`+ "ruleId": "no-console",`
`16`	`18`	`"severity": 1`
`17`	`19`	`}`
`18`	`20`	`],`
`@@ -25,12 +27,14 @@`
`25`	`27`	`{`
`26`	`28`	`"column": 1,`
`27`	`29`	`"line": 1,`
	`30`	`+ "ruleId": "no-console",`
`28`	`31`	`"message": "Unexpected console statement.",`
`29`	`32`	`"severity": 2`
`30`	`33`	`},`
`31`	`34`	`{`
`32`	`35`	`"column": 2,`
`33`	`36`	`"line": 2,`
	`37`	`+ "ruleId": "no-console",`
`34`	`38`	`"message": "Unexpected console statement.",`
`35`	`39`	`"severity": 2`
`36`	`40`	`}`
`@@ -43,13 +47,15 @@`
`43`	`47`	`"messages": [`
`44`	`48`	`{`
`45`	`49`	`"column": 1,`
	`50`	`+ "ruleId": "no-console",`
`46`	`51`	`"line": 1,`
`47`	`52`	`"message": "Unexpected console statement.",`
`48`	`53`	`"severity": 1`
`49`	`54`	`},`
`50`	`55`	`{`
`51`	`56`	`"column": 2,`
`52`	`57`	`"line": 2,`
	`58`	`+ "ruleId": "no-console",`
`53`	`59`	`"message": "Unexpected console statement.",`
`54`	`60`	`"severity": 2`
`55`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,14 @@`
`5`	`5`	`{`
`6`	`6`	`"column": 1,`
`7`	`7`	`"line": 1,`
	`8`	`+ "ruleId": "no-console",`
`8`	`9`	`"severity": 1,`
`9`	`10`	`"message": "Unexpected console statement."`
`10`	`11`	`},`
`11`	`12`	`{`
`12`	`13`	`"column": 2,`
`13`	`14`	`"line": 2,`
	`15`	`+ "ruleId": "no-console",`
`14`	`16`	`"severity": 2,`
`15`	`17`	`"message": "Unexpected console statement."`
`16`	`18`	`}`
`@@ -23,13 +25,15 @@`
`23`	`25`	`"messages": [`
`24`	`26`	`{`
`25`	`27`	`"column": 1,`
	`28`	`+ "ruleId": "no-console",`
`26`	`29`	`"line": 1,`
`27`	`30`	`"severity": 1,`
`28`	`31`	`"message": "Unexpected console statement."`
`29`	`32`	`},`
`30`	`33`	`{`
`31`	`34`	`"column": 2,`
`32`	`35`	`"line": 2,`
	`36`	`+ "ruleId": "no-console",`
`33`	`37`	`"severity": 2,`
`34`	`38`	`"message": "Unexpected console statement."`
`35`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,15 @@`
`5`	`5`	`"messages": [`
`6`	`6`	`{`
`7`	`7`	`"column": 1,`
	`8`	`+ "ruleId": "no-console",`
`8`	`9`	`"line": 1,`
`9`	`10`	`"message": "Unexpected console statement.",`
`10`	`11`	`"severity": 1`
`11`	`12`	`},`
`12`	`13`	`{`
`13`	`14`	`"column": 2,`
`14`	`15`	`"line": 2,`
	`16`	`+ "ruleId": "no-console",`
`15`	`17`	`"message": "Unexpected console statement.",`
`16`	`18`	`"severity": 1`
`17`	`19`	`}`
`@@ -25,13 +27,15 @@`
`25`	`27`	`{`
`26`	`28`	`"column": 1,`
`27`	`29`	`"line": 1,`
	`30`	`+ "ruleId": "no-console",`
`28`	`31`	`"message": "Unexpected console statement.",`
`29`	`32`	`"severity": 1`
`30`	`33`	`},`
`31`	`34`	`{`
`32`	`35`	`"column": 2,`
`33`	`36`	`"line": 2,`
`34`	`37`	`"message": "Unexpected console statement.",`
	`38`	`+ "ruleId": "no-console",`
`35`	`39`	`"severity": 1`
`36`	`40`	`}`
`37`	`41`	`],`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`"column": 1,`
`8`	`8`	`"line": 1,`
`9`	`9`	`"message": "Unexpected console statement.",`
	`10`	`+ "ruleId": "no-console",`
`10`	`11`	`"severity": 1`
`11`	`12`	`}`
`12`	`13`	`],`