Merge pull request #68 from gentlementlegen/feat/symbol-coefficient

feat!: symbol coefficients and configurable scores per group

README.md

@@ -31,7 +31,7 @@ Be sure to review all `*.test.*` files for implementation details.
               }
             },
             "wordValue": 0.1,
-            "formattingMultiplier": 1
+            "multiplier": 1
           },
           "reward": 0.8,
           "relevance": 0.5
@@ -42,11 +42,11 @@ Be sure to review all `*.test.*` files for implementation details.
 }
 ```
 
-Reward formula: `((count * wordValue) * (score * formattingMultiplier) * n) * relevance + task.reward = total`
+Reward formula: `((count * wordValue) * (score * multiplier) * n) * relevance + task.reward = total`
 
 ## Plugin configuration
 
-Here is a possible valid configuration to enable this plugin. See [these files](./src/configuration) for more details.
+Here is a possible valid configuration to enable this plugin. See [these files](./src/configuration/) for more details.
 
 ```yaml
 plugin: ubiquibot/conversation-rewards
@@ -61,70 +61,91 @@ with:
     requirePriceLabel: true
     contentEvaluator:
       multipliers:
-        - select: [ISSUE_SPECIFICATION]
+        - role: [ISSUE_SPECIFICATION]
           relevance: 1
-        - select: [PULL_AUTHOR]
+        - role: [PULL_AUTHOR]
           relevance: 1
-        - select: [PULL_ASSIGNEE]
+        - role: [PULL_ASSIGNEE]
           relevance: 1
-        - select: [PULL_COLLABORATOR]
+        - role: [PULL_COLLABORATOR]
           relevance: 1
-        - select: [PULL_CONTRIBUTOR]
+        - role: [PULL_CONTRIBUTOR]
           relevance: 1
     userExtractor:
       redeemTask: true
-    dataPurge:
+    dataPurge: {}
     formattingEvaluator:
-      scores:
-        br: 0
-        code: 1
-        p: 1
-        em: 0
-        img: 0
-        strong: 0
-        blockquote: 0
-        h1: 1
-        h2: 1
-        h3: 1
-        h4: 1
-        h5: 1
-        h6: 1
-        a: 1
-        li: 1
-        td: 1
-        hr: 0
-        multipliers:
-          - select: [ISSUE_SPECIFICATION]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - select: [ISSUE_AUTHOR]
-            formattingMultiplier: 1
-            wordValue: 0.2
-          - select: [ISSUE_ASSIGNEE]
-            formattingMultiplier: 0
-            wordValue: 0
-          - select: [ISSUE_COLLABORATOR]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - select: [ISSUE_CONTRIBUTOR]
-            formattingMultiplier: 0.25
-            wordValue: 0.1
-          - select: [PULL_SPECIFICATION]
-            formattingMultiplier: 0
-            wordValue: 0
-          - select: [PULL_AUTHOR]
-            formattingMultiplier: 2
-            wordValue: 0.2
-          - select: [PULL_ASSIGNEE]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - select: [PULL_COLLABORATOR]
-            formattingMultiplier: 1
-            wordValue: 0.1
-          - select: [PULL_CONTRIBUTOR]
-            formattingMultiplier: 0.25
-            wordValue: 0.1
-      permitGeneration:
+      multipliers:
+          - role: [ ISSUE_SPECIFICATION ]
+            multiplier: 1
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+              scores: # Scores can be set for each item differently
+                br: 0
+                code: 1
+                p: 1
+                em: 0
+                img: 0
+                strong: 0
+                blockquote: 0
+                h1: 1
+                h2: 1
+                h3: 1
+                h4: 1
+                h5: 1
+                h6: 1
+                a: 1
+                li: 1
+                ul: 1
+                td: 1
+                hr: 0
+          - role: [ISSUE_AUTHOR]
+            multiplier: 1
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.2
+          - role: [ISSUE_ASSIGNEE]
+            multiplier: 0
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0
+          - role: [ISSUE_COLLABORATOR]
+            multiplier: 1
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+          - role: [ISSUE_CONTRIBUTOR]
+            multiplier: 0.25
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+          - role: [PULL_SPECIFICATION]
+            multiplier: 0
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0
+          - role: [PULL_AUTHOR]
+            multiplier: 2
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.2
+          - role: [PULL_ASSIGNEE]
+            multiplier: 1
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+          - role: [PULL_COLLABORATOR]
+            multiplier: 1
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+          - role: [PULL_CONTRIBUTOR]
+            multiplier: 0.25
+            rewards:
+              regex:
+                "\\b\\w+\\b": 0.1
+      permitGeneration: {}
       githubComment:
         post: true
         debug: false

package.json

@@ -40,7 +40,6 @@
     "ethers": "^6.13.0",
     "js-tiktoken": "1.0.14",
     "jsdom": "24.0.0",
-    "lodash": "4.17.21",
     "markdown-it": "14.1.0",
     "openai": "4.56.0",
     "tsx": "4.7.1",

src/configuration/config-reader.ts

@@ -1,27 +1,27 @@
+import { Value } from "@sinclair/typebox/value";
 import program from "../parser/command-line";
 import { IncentivesConfiguration, incentivesConfigurationSchema, validateIncentivesConfiguration } from "./incentives";
-import { Value } from "@sinclair/typebox/value";
-import { merge } from "lodash";
 
 let configuration: IncentivesConfiguration | null = null;
 
 try {
-  const defaultConf = Value.Create(incentivesConfigurationSchema);
-  configuration = Value.Decode(incentivesConfigurationSchema, defaultConf);
+  configuration = Value.Default(incentivesConfigurationSchema, {}) as IncentivesConfiguration;
 } catch (e) {
   console.error(e);
 }
 
 if (program.settings) {
-  const settings = merge(configuration, JSON.parse(program.settings));
+  const settings = Value.Default(
+    incentivesConfigurationSchema,
+    JSON.parse(program.settings)
+  ) as IncentivesConfiguration;
   if (validateIncentivesConfiguration.test(settings)) {
-    configuration = settings;
+    configuration = Value.Decode(incentivesConfigurationSchema, settings);
   } else {
     console.warn("Invalid incentives configuration detected, will revert to defaults.");
     for (const error of validateIncentivesConfiguration.errors(settings)) {
       console.warn(error);
     }
   }
 }
-
 export default configuration as IncentivesConfiguration;

src/configuration/content-evaluator-config.ts

@@ -7,29 +7,29 @@ export const contentEvaluatorConfigurationType = Type.Object({
    */
   multipliers: Type.Array(
     Type.Object({
-      select: Type.Array(commentType),
+      role: Type.Array(commentType),
       relevance: Type.Optional(Type.Number()),
     }),
     {
       default: [
         {
-          select: ["ISSUE_SPECIFICATION"],
+          role: ["ISSUE_SPECIFICATION"],
           relevance: 1,
         },
         {
-          select: ["PULL_AUTHOR"],
+          role: ["PULL_AUTHOR"],
           relevance: 1,
         },
         {
-          select: ["PULL_ASSIGNEE"],
+          role: ["PULL_ASSIGNEE"],
           relevance: 1,
         },
         {
-          select: ["PULL_COLLABORATOR"],
+          role: ["PULL_COLLABORATOR"],
           relevance: 1,
         },
         {
-          select: ["PULL_CONTRIBUTOR"],
+          role: ["PULL_CONTRIBUTOR"],
           relevance: 1,
         },
       ],

src/configuration/data-collection-config.ts

@@ -1,14 +1,17 @@
 import { Static, Type } from "@sinclair/typebox";
 
-export const dataCollectionConfigurationType = Type.Object({
-  /**
-   * The maximum amount of retries on failure.
-   */
-  maxAttempts: Type.Number({ default: 10, minimum: 1 }),
-  /**
-   * The delay between each retry, in milliseconds.
-   */
-  delayMs: Type.Number({ default: 1000, minimum: 100 }),
-});
+export const dataCollectionConfigurationType = Type.Object(
+  {
+    /**
+     * The maximum amount of retries on failure.
+     */
+    maxAttempts: Type.Number({ default: 10, minimum: 1 }),
+    /**
+     * The delay between each retry, in milliseconds.
+     */
+    delayMs: Type.Number({ default: 1000, minimum: 100 }),
+  },
+  { default: {} }
+);
 
 export type DataCollectionConfiguration = Static<typeof dataCollectionConfigurationType>;