Merge branch 'main' into history

# Conflicts:
#	packages/utils/src/index.ts

.github/CODEOWNERS

@@ -0,0 +1,16 @@
+# Testing
+*.test.ts @Tlacenka
+/e2e/ @Tlacenka
+/testing/ @Tlacenka
+vite.config*.ts @Tlacenka
+
+# Mocks
+mocks/ @Tlacenka
+/examples/react-todos-app/ @matejchalk
+/testing/test-utils/src/lib/utils/dynamic-mocks/ @matejchalk
+
+# Plugins
+/packages/plugin-eslint/ @matejchalk
+/packages/plugin-coverage/ @Tlacenka
+/packages/plugin-lighthouse/ @BioPhoton
+/examples/plugins/ @BioPhoton

.github/labeler.yml

@@ -37,7 +37,7 @@
           - '**/mocks/**'
           - e2e/**
           - testing/**
-          - '**/vitest.config*.ts'
+          - '**/vite.config*.ts'
           - 'vitest.workspace.ts'
 
 🦾 CI/CD:

.github/workflows/pr-title-commitlint-check.yml → .github/workflows/pr-commitlint.yml

@@ -1,11 +1,12 @@
-name: PR Title Commitlint Check
+name: PR Commitlint
 
 on:
   pull_request:
     types: [opened, synchronize, edited]
 
 jobs:
   check:
+    name: Check PR title
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository

.github/workflows/pr-labeler.yml

@@ -6,6 +6,7 @@ on:
 
 jobs:
   label:
+    name: Add PR labels
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.26.1](https://github.com/code-pushup/cli/compare/v0.26.0...v0.26.1) (2024-03-07)
+
+# [0.26.0](https://github.com/code-pushup/cli/compare/v0.25.7...v0.26.0) (2024-03-06)
+
+### Features
+
+- **cli:** include commit info in report.json ([5965900](https://github.com/code-pushup/cli/commit/596590082c76b0b7915b2b339fa27baee9eaa678))
+
+## [0.25.7](https://github.com/code-pushup/cli/compare/v0.25.6...v0.25.7) (2024-03-06)
+
 ## [0.25.6](https://github.com/code-pushup/cli/compare/v0.25.5...v0.25.6) (2024-03-05)
 
 ### Bug Fixes

e2e/cli-e2e/tests/collect.e2e.test.ts

@@ -14,14 +14,13 @@ describe('CLI collect', () => {
     duration,
     version,
     ...report
-  }: Report | PluginReport) => report;
-  /* eslint-enable @typescript-eslint/no-unused-vars */
-
-  const omitVariableReportData = (report: Report) =>
+  }: Omit<Report, 'commit'> | PluginReport) => report;
+  const omitVariableReportData = ({ commit, ...report }: Report) =>
     omitVariableData({
       ...report,
       plugins: report.plugins.map(omitVariableData) as PluginReport[],
     });
+  /* eslint-enable @typescript-eslint/no-unused-vars */
 
   beforeEach(async () => {
     await cleanTestFolder('tmp/e2e');
@@ -37,7 +36,7 @@ describe('CLI collect', () => {
     expect(code).toBe(0);
     expect(stderr).toBe('');
 
-    const report = await readJsonFile('tmp/react-todos-app/report.json');
+    const report = await readJsonFile('tmp/e2e/react-todos-app/report.json');
 
     expect(() => reportSchema.parse(report)).not.toThrow();
     expect(omitVariableReportData(report as Report)).toMatchSnapshot();
@@ -90,7 +89,7 @@ describe('CLI collect', () => {
     expect(code).toBe(0);
     expect(stderr).toBe('');
 
-    const report = await readJsonFile('tmp/react-todos-app/report.json');
+    const report = await readJsonFile('tmp/e2e/react-todos-app/report.json');
 
     expect(() => reportSchema.parse(report)).not.toThrow();
     expect(omitVariableReportData(report as Report)).toMatchSnapshot();
@@ -106,7 +105,7 @@ describe('CLI collect', () => {
     expect(code).toBe(0);
     expect(stderr).toBe('');
 
-    const md = await readTextFile('tmp/react-todos-app/report.md');
+    const md = await readTextFile('tmp/e2e/react-todos-app/report.md');
 
     expect(md).toContain('# Code PushUp Report');
     expect(md).toContain(exampleCategoryTitle);

examples/react-todos-app/code-pushup.config.js

@@ -10,7 +10,7 @@ const eslintAuditRef = (slug, weight) => ({
 
 export default {
   persist: {
-    outputDir: '../../tmp/react-todos-app',
+    outputDir: '../../tmp/e2e/react-todos-app',
   },
   plugins: [
     await coveragePlugin({

global-setup.e2e.ts

@@ -1,9 +1,6 @@
 import { execSync } from 'child_process';
-import {
-  setup as globalSetup,
-  teardown as globalTeardown,
-} from './global-setup';
-import { setupTestFolder } from './testing/test-setup/src';
+import { setup as globalSetup } from './global-setup';
+import { setupTestFolder, teardownTestFolder } from './testing/test-setup/src';
 import startLocalRegistry from './tools/scripts/start-local-registry';
 import stopLocalRegistry from './tools/scripts/stop-local-registry';
 
@@ -21,5 +18,6 @@ export async function teardown() {
   execSync('npm uninstall @code-pushup/cli');
   execSync('npm uninstall @code-pushup/eslint-plugin');
   execSync('npm uninstall @code-pushup/coverage-plugin');
-  await globalTeardown();
+  await teardownTestFolder('tmp/e2e');
+  await teardownTestFolder('tmp/local-registry');
 }

global-setup.ts

@@ -1,9 +1,3 @@
-import { teardownTestFolder } from './testing/test-setup/src';
-
 export async function setup() {
   process.env.TZ = 'UTC';
 }
-
-export async function teardown() {
-  await teardownTestFolder('tmp');
-}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli-source",
-  "version": "0.25.6",
+  "version": "0.26.1",
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli#readme",
   "bugs": {

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.25.6",
+  "version": "0.26.1",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"

packages/cli/src/lib/autorun/autorun-command.ts

@@ -6,7 +6,6 @@ import {
   collectAndPersistReports,
   upload,
 } from '@code-pushup/core';
-import { getLatestCommit, validateCommitData } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   collectSuccessfulLog,
@@ -50,10 +49,7 @@ export function yargsAutorunCommandObject() {
 
       if (options.upload) {
         const { url } = await upload(options);
-        const commitData = await getLatestCommit();
-        if (validateCommitData(commitData, { throwError: true })) {
-          uploadSuccessfulLog(url);
-        }
+        uploadSuccessfulLog(url);
       } else {
         ui().logger.warning('Upload skipped because configuration is not set.');
         renderIntegratePortalHint();

packages/cli/src/lib/upload/upload-command.ts

@@ -1,7 +1,6 @@
 import chalk from 'chalk';
 import { ArgumentsCamelCase, CommandModule } from 'yargs';
 import { UploadOptions, upload } from '@code-pushup/core';
-import { getLatestCommit, validateCommitData } from '@code-pushup/utils';
 import { CLI_NAME } from '../constants';
 import {
   renderIntegratePortalHint,
@@ -24,11 +23,7 @@ export function yargsUploadCommandObject() {
         throw new Error('Upload configuration not set');
       }
       const { url } = await upload(options);
-
-      const commitData = await getLatestCommit();
-      if (validateCommitData(commitData, { throwError: true })) {
-        uploadSuccessfulLog(url);
-      }
+      uploadSuccessfulLog(url);
     },
   } satisfies CommandModule;
 }

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.25.6",
+  "version": "0.26.1",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/models": "*",

packages/core/src/lib/collect-and-persist.unit.test.ts

@@ -4,7 +4,10 @@ import {
   MINIMAL_CONFIG_MOCK,
   MINIMAL_REPORT_MOCK,
 } from '@code-pushup/test-utils';
-import { collectAndPersistReports } from './collect-and-persist';
+import {
+  CollectAndPersistReportsOptions,
+  collectAndPersistReports,
+} from './collect-and-persist';
 import { collect } from './implementation/collect';
 import { logPersistedResults, persistReport } from './implementation/persist';
 
@@ -19,7 +22,8 @@ vi.mock('./implementation/persist', () => ({
 
 describe('collectAndPersistReports', () => {
   it('should call collect and persistReport with correct parameters in non-verbose mode', async () => {
-    const nonVerboseConfig = {
+    const nonVerboseConfig: CollectAndPersistReportsOptions = {
+      categories: [],
       ...MINIMAL_CONFIG_MOCK,
       persist: {
         outputDir: 'output',
@@ -33,12 +37,15 @@ describe('collectAndPersistReports', () => {
 
     expect(collect).toHaveBeenCalledWith(nonVerboseConfig);
 
-    expect(persistReport).toHaveBeenCalledWith(
+    expect(persistReport).toHaveBeenCalledWith<
+      Parameters<typeof persistReport>
+    >(
       {
         packageName: '@code-pushup/core',
         version: '0.0.1',
         date: expect.stringMatching(ISO_STRING_REGEXP),
         duration: 666,
+        commit: expect.any(Object),
         categories: expect.any(Array),
         plugins: expect.any(Array),
       },
@@ -53,7 +60,8 @@ describe('collectAndPersistReports', () => {
   });
 
   it('should call collect and persistReport with correct parameters in verbose mode', async () => {
-    const verboseConfig = {
+    const verboseConfig: CollectAndPersistReportsOptions = {
+      categories: [],
       ...MINIMAL_CONFIG_MOCK,
       persist: {
         outputDir: 'output',

packages/core/src/lib/implementation/collect.integration.test.ts

@@ -1,12 +1,14 @@
 import { vol } from 'memfs';
 import { describe, expect, it } from 'vitest';
+import { commitSchema } from '@code-pushup/models';
 import { MEMFS_VOLUME, MINIMAL_CONFIG_MOCK } from '@code-pushup/test-utils';
 import { collect } from './collect';
 
 describe('collect', () => {
   it('should execute with valid options', async () => {
     vol.fromJSON({}, MEMFS_VOLUME);
     const report = await collect({
+      categories: [],
       ...MINIMAL_CONFIG_MOCK,
       verbose: true,
       progress: false,
@@ -27,5 +29,7 @@ describe('collect', () => {
         },
       }),
     );
+
+    expect(() => commitSchema.parse(report.commit)).not.toThrow();
   });
 });

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

@@ -1,5 +1,5 @@
 import { CoreConfig, Report } from '@code-pushup/models';
-import { calcDuration } from '@code-pushup/utils';
+import { calcDuration, getLatestCommit } from '@code-pushup/utils';
 import { name, version } from '../../../package.json';
 import { GlobalOptions } from '../types';
 import { executePlugins } from './execute-plugin';
@@ -17,8 +17,10 @@ export async function collect(options: CollectOptions): Promise<Report> {
   const { plugins, categories } = options;
   const date = new Date().toISOString();
   const start = performance.now();
+  const commit = await getLatestCommit();
   const pluginOutputs = await executePlugins(plugins, options);
   return {
+    commit,
     packageName: name,
     version,
     date,

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

@@ -6,11 +6,9 @@ import {
   directoryExists,
   generateMdReport,
   generateStdoutSummary,
-  getLatestCommit,
   logMultipleFileResults,
   scoreReport,
   sortReport,
-  validateCommitData,
 } from '@code-pushup/utils';
 
 export class PersistDirError extends Error {
@@ -35,24 +33,20 @@ export async function persistReport(
   console.warn(generateStdoutSummary(sortedScoredReport));
 
   // collect physical format outputs
-  const results = await Promise.all(
-    format.map(async reportType => {
-      switch (reportType) {
-        case 'json':
-          return {
-            format: 'json',
-            content: JSON.stringify(report, null, 2),
-          };
-        case 'md':
-          const commitData = await getLatestCommit();
-          validateCommitData(commitData);
-          return {
-            format: 'md',
-            content: generateMdReport(sortedScoredReport, commitData),
-          };
-      }
-    }),
-  );
+  const results = format.map(reportType => {
+    switch (reportType) {
+      case 'json':
+        return {
+          format: 'json',
+          content: JSON.stringify(report, null, 2),
+        };
+      case 'md':
+        return {
+          format: 'md',
+          content: generateMdReport(sortedScoredReport),
+        };
+    }
+  });
 
   if (!(await directoryExists(outputDir))) {
     try {

packages/core/src/lib/upload.ts

@@ -3,7 +3,7 @@ import {
   uploadToPortal,
 } from '@code-pushup/portal-client';
 import { PersistConfig, Report, UploadConfig } from '@code-pushup/models';
-import { getLatestCommit, loadReport } from '@code-pushup/utils';
+import { loadReport } from '@code-pushup/utils';
 import { reportToGQL } from './implementation/report-to-gql';
 import { GlobalOptions } from './types';
 
@@ -27,15 +27,14 @@ export async function upload(
     ...options.persist,
     format: 'json',
   });
-  const commitData = await getLatestCommit();
-  if (!commitData) {
-    throw new Error('no commit data available');
+  if (!report.commit) {
+    throw new Error('Commit must be linked in order to upload report');
   }
 
   const data: SaveReportMutationVariables = {
     organization,
     project,
-    commit: commitData.hash,
+    commit: report.commit.hash,
     ...reportToGQL(report),
   };