feat(utils): add scoring logic (#133)

Author: BioPhoton

packages/core/src/lib/implementation/collect.spec.ts

@@ -22,5 +22,6 @@ describe('collect', () => {
     expect(() =>
       reportSchema.omit({ packageName: true, version: true }).parse(report),
     ).not.toThrow();
+    expect(report.plugins[0]?.audits[0]?.slug).toBe('audit-1');
   });
 });

packages/core/src/lib/implementation/persist.spec.ts

@@ -5,9 +5,9 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { Report } from '@code-pushup/models';
 import {
   MEMFS_VOLUME,
-  config,
+  minimalConfig,
+  minimalReport,
   persistConfig,
-  report,
 } from '@code-pushup/models/testing';
 import { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX } from '@code-pushup/utils';
 import { mockConsole, unmockConsole } from '../../../test/console.mock';
@@ -35,8 +35,8 @@ const readReport = (format: 'json' | 'md') => {
   }
 };
 
-const dummyReport = report();
-const dummyConfig = config(outputDir);
+const dummyReport = minimalReport();
+const dummyConfig = minimalConfig(outputDir);
 let logs: string[] = [];
 
 const resetFiles = async () => {

packages/core/src/lib/implementation/persist.ts

@@ -3,7 +3,12 @@ import { existsSync, mkdirSync } from 'fs';
 import { stat, writeFile } from 'fs/promises';
 import { join } from 'path';
 import { CoreConfig, Report } from '@code-pushup/models';
-import { formatBytes, reportToMd, reportToStdout } from '@code-pushup/utils';
+import {
+  formatBytes,
+  reportToMd,
+  reportToStdout,
+  scoreReport,
+} from '@code-pushup/utils';
 
 export class PersistDirError extends Error {
   constructor(outputDir: string) {
@@ -27,9 +32,10 @@ export async function persistReport(
   const outputDir = persist.outputDir;
   let { format } = persist;
   format = format && format.length !== 0 ? format : ['stdout'];
-
+  let scoredReport;
   if (format.includes('stdout')) {
-    reportToStdout(report);
+    scoredReport = scoreReport(report);
+    reportToStdout(scoredReport);
   }
 
   // collect physical format outputs
@@ -39,7 +45,8 @@ export async function persistReport(
   ];
 
   if (format.includes('md')) {
-    results.push({ format: 'md', content: reportToMd(report) });
+    scoredReport = scoredReport || scoreReport(report);
+    results.push({ format: 'md', content: reportToMd(scoredReport) });
   }
 
   if (!existsSync(outputDir)) {

packages/models/test/fixtures/config.mock.ts

@@ -1,4 +1,4 @@
-import { CoreConfig } from '../../src';
+import { CoreConfig, Report } from '../../src';
 import { categoryConfigs } from './categories.mock';
 import { eslintPluginConfig } from './eslint-plugin.mock';
 import { lighthousePluginConfig } from './lighthouse-plugin.mock';
@@ -23,6 +23,20 @@ export function minimalConfig(
 ): Omit<CoreConfig, 'upload'> & Required<Pick<CoreConfig, 'upload'>> {
   const PLUGIN_1_SLUG = 'plugin-1';
   const AUDIT_1_SLUG = 'audit-1';
+
+  const plg1 = pluginConfig([auditReport({ slug: AUDIT_1_SLUG })], {
+    slug: PLUGIN_1_SLUG,
+    outputDir,
+    outputFile: `${PLUGIN_1_SLUG}.json`,
+  });
+  const { runner, ...reportPlg } = plg1;
+  reportPlg.audits = reportPlg.audits.map(a => ({
+    ...a,
+    score: 0,
+    value: 0,
+    displayValue: '',
+  }));
+
   return JSON.parse(
     JSON.stringify({
       persist: { outputDir },
@@ -56,3 +70,45 @@ export function minimalConfig(
     } satisfies Omit<CoreConfig, 'upload'> & Required<Pick<CoreConfig, 'upload'>>),
   );
 }
+
+export function minimalReport(outputDir = 'tmp'): Report {
+  const PLUGIN_1_SLUG = 'plugin-1';
+  const AUDIT_1_SLUG = 'audit-1';
+
+  const plg1 = pluginConfig([auditReport({ slug: AUDIT_1_SLUG })], {
+    slug: PLUGIN_1_SLUG,
+    outputDir,
+    outputFile: `${PLUGIN_1_SLUG}.json`,
+  });
+  const { runner, ...reportPlg } = plg1;
+  reportPlg.audits = reportPlg.audits.map(a => ({
+    ...a,
+    score: 0,
+    value: 0,
+    displayValue: '',
+  }));
+
+  return JSON.parse(
+    JSON.stringify({
+      packageName: '@code-pushup/core',
+      version: '0.1.0',
+      date: 'today',
+      duration: 42,
+      categories: [
+        {
+          slug: 'category-1',
+          title: 'Category 1',
+          refs: [
+            {
+              type: 'audit',
+              plugin: PLUGIN_1_SLUG,
+              slug: AUDIT_1_SLUG,
+              weight: 1,
+            },
+          ],
+        },
+      ],
+      plugins: [reportPlg as any],
+    } satisfies Report),
+  );
+}

packages/models/test/index.ts

@@ -1,6 +1,6 @@
 export * from './memfs';
 export { report } from './fixtures/report.mock';
-export { config, minimalConfig } from './fixtures/config.mock';
+export { config, minimalConfig, minimalReport } from './fixtures/config.mock';
 
 export { eslintPluginConfig } from './fixtures/eslint-plugin.mock';
 export { lighthousePluginConfig } from './fixtures/lighthouse-plugin.mock';

packages/utils/src/index.ts

@@ -1,3 +1,4 @@
+export { ScoredReport, scoreReport } from './lib/scoring';
 export { verboseUtils } from './lib/verbose-utils';
 export {
   CliArgsObject,

packages/utils/src/lib/__snapshots__/report-to-md.spec.ts.snap

@@ -15,11 +15,11 @@ _Audits: 52_
 
 |Category|Score|Audits|
 |:--:|:--:|:--:|
-|Performance|1|2/1|
-|Bug prevention|19|16/19|
-|Code style|13|13/13|
+|Performance|0.9215000000000001|2/1|
+|Bug prevention|0.6842105263157895|16/19|
+|Code style|0.5384615384615384|13/13|
 
-**Performance 1**
+**Performance 0.9215000000000001**
 
 - <details>
 <summary>Disallow missing \`key\` props in iterators/collection literals (0) ESLint</summary>
@@ -29,7 +29,7 @@ ESLint rule **jsx-key**, from _react_ plugin.
 
 </details>
 
-**Bug prevention 19**
+**Bug prevention 0.6842105263157895**
 - <details>
 <summary>Disallow assignment operators in conditional expressions (1) ESLint</summary>
 undefined
@@ -158,7 +158,7 @@ ESLint rule **exhaustive-deps**, from _react-hooks_ plugin.
 
 </details>
 
-**Code style 13**
+**Code style 0.5384615384615384**
 - <details>
 <summary>Disallow unused variables (1) ESLint</summary>
 1 warning
@@ -280,11 +280,11 @@ _Audits: 52_
 
 |Category|Score|Audits|
 |:--:|:--:|:--:|
-|Performance|1|2/1|
-|Bug prevention|19|16/19|
-|Code style|13|13/13|
+|Performance|0.9215000000000001|2/1|
+|Bug prevention|0.6842105263157895|16/19|
+|Code style|0.5384615384615384|13/13|
 
-**Performance 1**
+**Performance 0.9215000000000001**
 
 - <details>
 <summary>Disallow missing \`key\` props in iterators/collection literals (0) ESLint</summary>
@@ -294,7 +294,7 @@ ESLint rule **jsx-key**, from _react_ plugin.
 
 </details>
 
-**Bug prevention 19**
+**Bug prevention 0.6842105263157895**
 - <details>
 <summary>Disallow assignment operators in conditional expressions (1) ESLint</summary>
 undefined
@@ -423,7 +423,7 @@ ESLint rule **exhaustive-deps**, from _react-hooks_ plugin.
 
 </details>
 
-**Code style 13**
+**Code style 0.5384615384615384**
 - <details>
 <summary>Disallow unused variables (1) ESLint</summary>
 1 warning

packages/utils/src/lib/__snapshots__/report-to-stdout.spec.ts.snap

@@ -6,141 +6,21 @@ exports[`report-to-stdout > should contain all sections when using the fixture r
 Package Name: @code-pushup/core
 Version: 0.1.0
 Commit: feat(cli): add logic for markdown report - 7eba125ad5643c2f90cb21389fc3442d786f43f9
-[3m[90mDate: 2023-10-18T07:49:45.506Z[39m[23m
-[3m[90mDuration: 1652ms[39m[23m
-[3m[90mPlugins: 2[39m[23m
-[3m[90mAudits: 52[39m[23m
+[3m[90mDate: today[39m[23m
+[3m[90mDuration: 42ms[39m[23m
+[3m[90mPlugins: 1[39m[23m
+[3m[90mAudits: 1[39m[23m
 ---
 
 
  Category            Score               Audits
- Performance         1                   2/1
- Bug prevention      19                  16/19
- Code style          13                  13/13
+ Category 1          0                   1/1
 
 
-Performance 1
-- Disallow missing \`key\` props in iterators/collection literals (0)
-  ESLint rule **jsx-key**, from _react_ plugin.
-  https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules/jsx-key.md 
-
-Bug prevention 19
-- Disallow assignment operators in conditional expressions (1)
-  ESLint rule **no-cond-assign**.
-  https://eslint.org/docs/latest/rules/no-cond-assign 
-
-- Disallow reassigning \`const\` variables (1)
-  ESLint rule **no-const-assign**.
-  https://eslint.org/docs/latest/rules/no-const-assign 
-
-- Disallow the use of \`debugger\` (1)
-  ESLint rule **no-debugger**.
-  https://eslint.org/docs/latest/rules/no-debugger 
-
-- Disallow invalid regular expression strings in \`RegExp\` constructors (1)
-  ESLint rule **no-invalid-regexp**.
-  https://eslint.org/docs/latest/rules/no-invalid-regexp 
-
-- Disallow the use of undeclared variables unless mentioned in \`/*global */\` comments (1)
-  ESLint rule **no-undef**.
-  https://eslint.org/docs/latest/rules/no-undef 
-
-- Disallow loops with a body that allows only one iteration (1)
-  ESLint rule **no-unreachable-loop**.
-  https://eslint.org/docs/latest/rules/no-unreachable-loop 
-
-- Disallow negating the left operand of relational operators (1)
-  ESLint rule **no-unsafe-negation**.
-  https://eslint.org/docs/latest/rules/no-unsafe-negation 
-
-- Disallow use of optional chaining in contexts where the \`undefined\` value is not allowed (1)
-  ESLint rule **no-unsafe-optional-chaining**.
-  https://eslint.org/docs/latest/rules/no-unsafe-optional-chaining 
-
-- Require calls to \`isNaN()\` when checking for \`NaN\` (1)
-  ESLint rule **use-isnan**.
-  https://eslint.org/docs/latest/rules/use-isnan 
-
-- Enforce comparing \`typeof\` expressions against valid strings (1)
-  ESLint rule **valid-typeof**.
-  https://eslint.org/docs/latest/rules/valid-typeof 
-
-- Require the use of \`===\` and \`!==\` (1)
-  ESLint rule **eqeqeq**.
-  https://eslint.org/docs/latest/rules/eqeqeq 
-
-- Disallow missing \`key\` props in iterators/collection literals (2)
-  ESLint rule **jsx-key**, from _react_ plugin.
-  https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules/jsx-key.md 
-
-- Disallow missing props validation in a React component definition (1)
-  ESLint rule **prop-types**, from _react_ plugin.
-  https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules/prop-types.md 
-
-- Disallow missing React when using JSX (1)
-  ESLint rule **react-in-jsx-scope**, from _react_ plugin.
-  https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules/react-in-jsx-scope.md 
-
-- enforces the Rules of Hooks (2)
-  ESLint rule **rules-of-hooks**, from _react-hooks_ plugin.
-  https://reactjs.org/docs/hooks-rules.html 
-
-- verifies the list of dependencies for Hooks like useEffect and similar (2)
-  ESLint rule **exhaustive-deps**, from _react-hooks_ plugin.
-  https://github.com/facebook/react/issues/14920 
-
-Code style 13
-- Disallow unused variables (1)
-  ESLint rule **no-unused-vars**.
-  https://eslint.org/docs/latest/rules/no-unused-vars 
-
-- Require braces around arrow function bodies (1)
-  ESLint rule **arrow-body-style**.
-  https://eslint.org/docs/latest/rules/arrow-body-style 
-
-- Enforce camelcase naming convention (1)
-  ESLint rule **camelcase**.
-  https://eslint.org/docs/latest/rules/camelcase 
-
-- Enforce consistent brace style for all control statements (1)
-  ESLint rule **curly**.
-  https://eslint.org/docs/latest/rules/curly 
-
-- Require the use of \`===\` and \`!==\` (1)
-  ESLint rule **eqeqeq**.
-  https://eslint.org/docs/latest/rules/eqeqeq 
-
-- Enforce a maximum number of lines of code in a function (1)
-  ESLint rule **max-lines-per-function**.
-  https://eslint.org/docs/latest/rules/max-lines-per-function 
-
-- Enforce a maximum number of lines per file (1)
-  ESLint rule **max-lines**.
-  https://eslint.org/docs/latest/rules/max-lines 
-
-- Require or disallow method and property shorthand syntax for object literals (1)
-  ESLint rule **object-shorthand**.
-  https://eslint.org/docs/latest/rules/object-shorthand 
-
-- Require using arrow functions for callbacks (1)
-  ESLint rule **prefer-arrow-callback**.
-  https://eslint.org/docs/latest/rules/prefer-arrow-callback 
-
-- Require \`const\` declarations for variables that are never reassigned after declared (1)
-  ESLint rule **prefer-const**.
-  https://eslint.org/docs/latest/rules/prefer-const 
-
-- Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead (1)
-  ESLint rule **prefer-object-spread**.
-  https://eslint.org/docs/latest/rules/prefer-object-spread 
-
-- Require or disallow \\"Yoda\\" conditions (1)
-  ESLint rule **yoda**.
-  https://eslint.org/docs/latest/rules/yoda 
-
-- Require \`let\` or \`const\` instead of \`var\` (1)
-  ESLint rule **no-var**.
-  https://eslint.org/docs/latest/rules/no-var 
+Category 1 0
+- Audit Title (1)
+  audit description
+  http://www.my-docs.dev 
 
 
 

packages/utils/src/lib/report-to-md.spec.ts

@@ -1,10 +1,11 @@
 import { describe } from 'vitest';
 import { report } from '@code-pushup/models/testing';
 import { reportToMd } from './report-to-md';
+import { scoreReport } from './scoring';
 
 describe('report-to-md', () => {
   it('should contain all sections when using the fixture report', () => {
-    const mdReport = reportToMd(report());
+    const mdReport = reportToMd(scoreReport(report()));
     expect(mdReport).toMatchSnapshot(mdReport);
   });
 });