Adding rule id to a VCS message (#156)

* adding rule id to a VCS message

* message linting fix

---------

Co-authored-by: mvedernikov <[email protected]>

Author: Vedmax

package.json

@@ -8,9 +8,9 @@
   "homepage": "https://github.com/codeleague/codecoach",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint 'src/**/*.{js,ts}' --quiet --fix",
-    "lint-ci": "eslint 'src/**/*.{js,ts}'",
-    "format": "prettier --write 'src/**/*.{js,ts}'",
+    "lint": "eslint \"src/**/*.{js,ts}\" --quiet --fix",
+    "lint-ci": "eslint \"src/**/*.{js,ts}\"",
+    "format": "prettier --write \"src/**/*.{js,ts}\"",
     "test": "jest",
     "build": "tsc --project tsconfig.build.json",
     "dev": "nodemon --inspect=5858 --config ./nodemon.json -- --config=\"config-test.json\"",

src/AnalyzerBot/utils/commentUtil.spec.ts

@@ -97,7 +97,7 @@ describe('groupComments', () => {
         text:
           ':rotating_light: msg1' +
           '  \n' +
-          ':warning: (SUPPRESSED) additional warning' +
+          ':warning: (SUPPRESSED) additional warning (rule: UNIMPORTANT_RULE2)' +
           '  \n',
       },
       {
@@ -138,7 +138,7 @@ describe('groupComments', () => {
         text:
           ':rotating_light: msg1' +
           '  \n' +
-          ':warning: (SUPPRESSED) additional warning' +
+          ':warning: (SUPPRESSED) additional warning (rule: UNIMPORTANT_RULE/RULE2)' +
           '  \n',
       },
       {

src/AnalyzerBot/utils/commentUtil.ts

@@ -46,7 +46,8 @@ function buildText(
   const { severity, msg } = item;
   const { text: currentText } = currentComment;
   const msgWithSuppression = isSuppressed ? `(SUPPRESSED) ${msg}` : msg;
-  const text = MessageUtil.createMessageWithEmoji(msgWithSuppression, severity);
+  const msgWithRuleId = MessageUtil.addRuleIdToMessage(msgWithSuppression, item.ruleId);
+  const text = MessageUtil.createMessageWithEmoji(msgWithRuleId, severity);
   return `${currentText}${text}  \n`;
 }
 

src/AnalyzerBot/utils/message.util.spec.ts

@@ -26,3 +26,18 @@ describe('generateCommitDescription', () => {
     expect(MessageUtil.generateCommitDescription(99)).toBe('CodeCoach report 99 errors');
   });
 });
+
+describe('addRuleIdToMessage', () => {
+  it('should add ruleId to message', () => {
+    const msg = 'test';
+    const ruleId = 'id';
+
+    expect(MessageUtil.addRuleIdToMessage(msg, ruleId)).toBe(`${msg} (rule: ${ruleId})`);
+  });
+  it('should not add ruleId to message if ruleId is empty', () => {
+    const msg = 'test';
+    const ruleId = '';
+
+    expect(MessageUtil.addRuleIdToMessage(msg, ruleId)).toBe(msg);
+  });
+});

src/AnalyzerBot/utils/message.util.ts

@@ -46,4 +46,8 @@ ${warningMsg}`;
       ? `CodeCoach report ${nOfErrors} errors`
       : 'CodeCoach report no critical issue, good job!';
   }
+
+  static addRuleIdToMessage(msg: string, ruleId: string): string {
+    return `${msg}` + (ruleId ? ` (rule: ${ruleId})` : '');
+  }
 }