refactor(verbosity): better handling for verbosity

src/configuration/formatting-evaluator-config.ts

@@ -111,6 +111,7 @@ export const formattingEvaluatorConfigurationType = Type.Object(
         ],
       }
     ),
+    wordCountExponent: Type.Number({ default: 0.85 }),
   },
   { default: {} }
 );

src/parser/formatting-evaluator-module.ts

@@ -23,6 +23,7 @@ export class FormattingEvaluatorModule implements Module {
     configuration.incentives.formattingEvaluator;
   private readonly _md = new MarkdownIt();
   private readonly _multipliers: { [k: number]: Multiplier } = {};
+  private readonly _wordCountExponent: number;
 
   _getEnumValue(key: CommentType) {
     let res = 0;
@@ -46,6 +47,7 @@ export class FormattingEvaluatorModule implements Module {
         };
       }, {});
     }
+    this._wordCountExponent = this._configuration?.wordCountExponent ?? 0.85;
   }
 
   async transform(data: Readonly<IssueActivity>, result: Result) {
@@ -54,23 +56,9 @@ export class FormattingEvaluatorModule implements Module {
       const comments = currentElement.comments || [];
       for (let i = 0; i < comments.length; i++) {
         const comment = comments[i];
-        // Count with html elements if any, otherwise just treat it as plain text
         const { formatting } = this._getFormattingScore(comment);
         const multiplierFactor = this._multipliers?.[comment.type] ?? { multiplier: 0 };
-        const formattingTotal = formatting
-          ? Object.values(formatting).reduce((acc, curr) => {
-              let sum = new Decimal(0);
-              for (const symbol of Object.keys(curr.symbols)) {
-                sum = sum.add(
-                  new Decimal(curr.symbols[symbol].count)
-                    .mul(curr.symbols[symbol].multiplier)
-                    .mul(multiplierFactor.multiplier)
-                    .mul(curr.score)
-                );
-              }
-              return acc.add(sum);
-            }, new Decimal(0))
-          : new Decimal(0);
+        const formattingTotal = this._calculateFormattingTotal(formatting, multiplierFactor).toDecimalPlaces(2);
         comment.score = {
           ...comment.score,
           formatting: {
@@ -84,6 +72,33 @@ export class FormattingEvaluatorModule implements Module {
     return result;
   }
 
+  private _calculateFormattingTotal(
+    formatting: ReturnType<typeof this._getFormattingScore>["formatting"],
+    multiplierFactor: Multiplier
+  ): Decimal {
+    if (!formatting) return new Decimal(0);
+
+    return Object.values(formatting).reduce((acc, curr) => {
+      let sum = new Decimal(0);
+
+      for (const symbol of Object.keys(curr.symbols)) {
+        const count = new Decimal(curr.symbols[symbol].count);
+        const symbolMultiplier = new Decimal(curr.symbols[symbol].multiplier);
+        const formattingElementScore = new Decimal(curr.score);
+        const exponent = this._wordCountExponent;
+
+        sum = sum.add(
+          count
+            .pow(exponent) // (count^exponent)
+            .mul(symbolMultiplier) // symbol multiplier
+            .mul(formattingElementScore) // comment type multiplier
+            .mul(multiplierFactor.multiplier) // formatting element score
+        );
+      }
+      return acc.add(sum);
+    }, new Decimal(0));
+  }
+
   get enabled(): boolean {
     if (!Value.Check(formattingEvaluatorConfigurationType, this._configuration)) {
       console.warn("Invalid / missing configuration detected for FormattingEvaluatorModule, disabling.");

tests/__mocks__/results/content-evaluator-results.json

@@ -20,7 +20,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 3.36
+          "reward": 2.128
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1948930217"
@@ -44,7 +44,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 2.56
+          "reward": 1.688
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949201722"
@@ -77,7 +77,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 11.68
+          "reward": 6.28
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949203681"
@@ -101,7 +101,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 1.44
+          "reward": 1.032
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949633751"
@@ -125,7 +125,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 1.28
+          "reward": 0.936
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949639054"
@@ -149,7 +149,7 @@
             "multiplier": 1
           },
           "relevance": 0.8,
-          "reward": 8.16
+          "reward": 4.528
         },
         "type": "ISSUE_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949642845"
@@ -209,7 +209,7 @@
             "multiplier": 1
           },
           "relevance": 1,
-          "reward": 5.7
+          "reward": 3.51
         },
         "type": "ISSUE_SPECIFICATION",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22"
@@ -233,7 +233,7 @@
             "multiplier": 1
           },
           "relevance": 1,
-          "reward": 0.7
+          "reward": 0.52
         },
         "type": "PULL_COLLABORATOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949021356"
@@ -257,7 +257,7 @@
             "multiplier": 1
           },
           "relevance": 1,
-          "reward": 1.2
+          "reward": 0.83
         },
         "type": "PULL_COLLABORATOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949196677"
@@ -317,13 +317,13 @@
             "multiplier": 1
           },
           "relevance": 1,
-          "reward": 64.9
+          "reward": 25.02
         },
         "type": "PULL_COLLABORATOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949196678"
       }
     ],
-    "total": 100.98,
+    "total": 46.472,
     "userId": 4975670
   },
   "gitcoindev": {
@@ -395,7 +395,7 @@
             "multiplier": 2
           },
           "relevance": 1,
-          "reward": 4
+          "reward": 2.83
         },
         "type": "PULL_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949044575"
@@ -419,7 +419,7 @@
             "multiplier": 2
           },
           "relevance": 1,
-          "reward": 6
+          "reward": 4
         },
         "type": "PULL_AUTHOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949046925"
@@ -429,7 +429,7 @@
       "multiplier": 1,
       "reward": 37.5
     },
-    "total": 47.5,
+    "total": 44.33,
     "userId": 88761781
   },
   "molecula451": {
@@ -462,7 +462,7 @@
             "multiplier": 0.25
           },
           "relevance": 0.8,
-          "reward": 0.3
+          "reward":  0.2
         },
         "type": "ISSUE_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1948916343"
@@ -486,7 +486,7 @@
             "multiplier": 0.25
           },
           "relevance": 0.8,
-          "reward": 0.1
+          "reward": 0.08
         },
         "type": "ISSUE_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1948989989"
@@ -510,7 +510,7 @@
             "multiplier": 0.25
           },
           "relevance": 0.8,
-          "reward": 0.28
+          "reward": 0.192
         },
         "type": "ISSUE_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949195772"
@@ -534,7 +534,7 @@
             "multiplier": 0.25
           },
           "relevance": 0.8,
-          "reward": 0.24
+          "reward": 0.168
         },
         "type": "ISSUE_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949564869"
@@ -558,7 +558,7 @@
             "multiplier": 0.25
           },
           "relevance": 0.8,
-          "reward": 0.62
+          "reward": 0.368
         },
         "type": "ISSUE_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/issues/22#issuecomment-1949635137"
@@ -606,7 +606,7 @@
             "multiplier": 0.25
           },
           "relevance": 1,
-          "reward": 0.025
+          "reward": 0.03
         },
         "type": "PULL_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949038563"
@@ -630,13 +630,13 @@
             "multiplier": 0.25
           },
           "relevance": 1,
-          "reward": 0.45
+          "reward": 0.29
         },
         "type": "PULL_CONTRIBUTOR",
         "url": "https://github.com/ubiquibot/comment-incentives/pull/25#issuecomment-1949044855"
       }
     ],
-    "total": 2.055,
+    "total": 1.368,
     "userId": 41552663
   }
 }