feat!: symbol coefficients and configurable scores per group

src/configuration/config-reader.ts

@@ -1,27 +1,28 @@
-import program from "../parser/command-line";
-import { IncentivesConfiguration, incentivesConfigurationSchema, validateIncentivesConfiguration } from "./incentives";
 import { Value } from "@sinclair/typebox/value";
 import { merge } from "lodash";
+import program from "../parser/command-line";
+import { IncentivesConfiguration, incentivesConfigurationSchema, validateIncentivesConfiguration } from "./incentives";
 
 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 = merge(
+    configuration,
+    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/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: 10000, 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: 10000, minimum: 100 }),
+  },
+  { default: {} }
+);
 
 export type DataCollectionConfiguration = Static<typeof dataCollectionConfigurationType>;

src/configuration/formatting-evaluator-config.ts

@@ -7,95 +7,100 @@ const type = Type.Union(
   )
 );
 
-export const formattingEvaluatorConfigurationType = Type.Object({
-  /**
-   * Multipliers applied to different parts of the comment body content
-   */
-  multipliers: Type.Array(
-    Type.Object({
-      select: Type.Array(type),
-      formattingMultiplier: Type.Number(),
-      wordValue: Type.Number(),
-    }),
-    {
-      default: [
-        {
-          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,
-        },
-      ],
-    }
-  ),
-  /**
-   * Attributed score per HTML entity
-   */
-  scores: Type.Record(Type.String(), Type.Number(), {
-    default: {
-      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,
-    },
-  }),
-});
+const symbolsType = Type.Record(Type.String(), Type.Number(), { minProperties: 1 });
+
+export const formattingEvaluatorConfigurationType = Type.Object(
+  {
+    /**
+     * Multipliers applied to different parts of the comment body content
+     */
+    multipliers: Type.Array(
+      Type.Object({
+        select: Type.Array(type),
+        formattingMultiplier: Type.Number(),
+        symbols: symbolsType,
+        /**
+         * Attributed score per HTML entity
+         */
+        scores: Type.Record(Type.String(), Type.Number(), {
+          default: {
+            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,
+          },
+        }),
+      }),
+      {
+        default: [
+          {
+            select: ["ISSUE_SPECIFICATION"],
+            formattingMultiplier: 1,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+          {
+            select: ["ISSUE_AUTHOR"],
+            formattingMultiplier: 1,
+            symbols: { "\\b\\w+\\b": 0.2 },
+          },
+          {
+            select: ["ISSUE_ASSIGNEE"],
+            formattingMultiplier: 0,
+            symbols: { "\\b\\w+\\b": 0 },
+          },
+          {
+            select: ["ISSUE_COLLABORATOR"],
+            formattingMultiplier: 1,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+          {
+            select: ["ISSUE_CONTRIBUTOR"],
+            formattingMultiplier: 0.25,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+          {
+            select: ["PULL_SPECIFICATION"],
+            formattingMultiplier: 0,
+            symbols: { "\\b\\w+\\b": 0 },
+          },
+          {
+            select: ["PULL_AUTHOR"],
+            formattingMultiplier: 2,
+            symbols: { "\\b\\w+\\b": 0.2 },
+          },
+          {
+            select: ["PULL_ASSIGNEE"],
+            formattingMultiplier: 1,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+          {
+            select: ["PULL_COLLABORATOR"],
+            formattingMultiplier: 1,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+          {
+            select: ["PULL_CONTRIBUTOR"],
+            formattingMultiplier: 0.25,
+            symbols: { "\\b\\w+\\b": 0.1 },
+          },
+        ],
+      }
+    ),
+  },
+  { default: {} }
+);
 
 export type FormattingEvaluatorConfiguration = Static<typeof formattingEvaluatorConfigurationType>;

src/configuration/github-comment-config.ts

@@ -1,14 +1,17 @@
 import { Static, Type } from "@sinclair/typebox";
 
-export const githubCommentConfigurationType = Type.Object({
-  /**
-   * Enables posting to the related GitHub Issue
-   */
-  post: Type.Boolean({ default: true }),
-  /**
-   * Enables debug by creating a local html file of the rendered comment
-   */
-  debug: Type.Boolean({ default: false }),
-});
+export const githubCommentConfigurationType = Type.Object(
+  {
+    /**
+     * Enables posting to the related GitHub Issue
+     */
+    post: Type.Boolean({ default: true }),
+    /**
+     * Enables debug by creating a local html file of the rendered comment
+     */
+    debug: Type.Boolean({ default: false }),
+  },
+  { default: {} }
+);
 
 export type GithubCommentConfiguration = Static<typeof githubCommentConfigurationType>;

src/configuration/incentives.ts

@@ -8,37 +8,43 @@ import { githubCommentConfigurationType } from "./github-comment-config";
 import { permitGenerationConfigurationType } from "./permit-generation-configuration";
 import { userExtractorConfigurationType } from "./user-extractor-config";
 
-export const incentivesConfigurationSchema = T.Object({
-  /**
-   * Network ID to run in, default to 100
-   */
-  evmNetworkId: T.Number({ default: 100 }),
-  /**
-   * The encrypted key to use for permit generation
-   */
-  evmPrivateEncrypted: T.String(),
-  /**
-   * Reward token for ERC20 permits, default WXDAI for gnosis chain
-   */
-  erc20RewardToken: T.String({ default: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d" }),
-  incentives: T.Object({
+export const incentivesConfigurationSchema = T.Object(
+  {
     /**
-     * Optionally specify a file to write the results in
+     * Network ID to run in, default to 100
      */
-    file: T.Optional(T.String()),
+    evmNetworkId: T.Number({ default: 100 }),
     /**
-     * If set to true, the plugin runs even if the price label is missing, and will evaluate comments.
+     * The encrypted key to use for permit generation
      */
-    requirePriceLabel: T.Boolean({ default: true }),
-    contentEvaluator: T.Optional(T.Union([contentEvaluatorConfigurationType, T.Null()])),
-    userExtractor: T.Optional(T.Union([userExtractorConfigurationType, T.Null()])),
-    dataPurge: T.Optional(T.Union([dataPurgeConfigurationType, T.Null()])),
-    formattingEvaluator: T.Optional(T.Union([formattingEvaluatorConfigurationType, T.Null()])),
-    permitGeneration: T.Optional(T.Union([permitGenerationConfigurationType, T.Null()])),
-    githubComment: T.Optional(T.Union([githubCommentConfigurationType, T.Null()])),
-  }),
-  dataCollection: dataCollectionConfigurationType,
-});
+    evmPrivateEncrypted: T.String(),
+    /**
+     * Reward token for ERC20 permits, default WXDAI for gnosis chain
+     */
+    erc20RewardToken: T.String({ default: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d" }),
+    incentives: T.Object(
+      {
+        /**
+         * Optionally specify a file to write the results in
+         */
+        file: T.Optional(T.String()),
+        /**
+         * If set to true, the plugin runs even if the price label is missing, and will evaluate comments.
+         */
+        requirePriceLabel: T.Boolean({ default: true }),
+        contentEvaluator: T.Optional(T.Union([contentEvaluatorConfigurationType, T.Null()])),
+        userExtractor: T.Optional(T.Union([userExtractorConfigurationType, T.Null()])),
+        dataPurge: T.Optional(T.Union([dataPurgeConfigurationType, T.Null()])),
+        formattingEvaluator: formattingEvaluatorConfigurationType,
+        permitGeneration: T.Optional(T.Union([permitGenerationConfigurationType, T.Null()])),
+        githubComment: githubCommentConfigurationType,
+      },
+      { default: {} }
+    ),
+    dataCollection: dataCollectionConfigurationType,
+  },
+  { default: {} }
+);
 
 export const validateIncentivesConfiguration = new StandardValidator(incentivesConfigurationSchema);