feat(ci): new package with code extracted from github-action

e2e/ci-e2e/.eslintrc.json

@@ -0,0 +1,12 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "code-pushup.config*.ts"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["e2e/ci-e2e/tsconfig.*?.json"]
+      }
+    }
+  ]
+}

e2e/ci-e2e/mocks/fixtures/code-pushup.config.ts

@@ -0,0 +1,49 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import type { CoreConfig } from '@code-pushup/models';
+import { crawlFileSystem } from '@code-pushup/utils';
+
+const config: CoreConfig = {
+  plugins: [
+    {
+      slug: 'ts-migration',
+      title: 'TypeScript migration',
+      icon: 'typescript',
+      audits: [
+        {
+          slug: 'ts-files',
+          title: 'Source files converted from JavaScript to TypeScript',
+        },
+      ],
+      runner: async () => {
+        const paths = await crawlFileSystem({
+          directory: fileURLToPath(dirname(import.meta.url)),
+          pattern: /\.[jt]s$/,
+        });
+        const jsPaths = paths.filter(path => path.endsWith('.js'));
+        const tsPaths = paths.filter(path => path.endsWith('.ts'));
+        const jsFileCount = jsPaths.length;
+        const tsFileCount = tsPaths.length;
+        const ratio = tsFileCount / (jsFileCount + tsFileCount);
+        const percentage = Math.round(ratio * 100);
+        return [
+          {
+            slug: 'ts-files',
+            value: percentage,
+            score: ratio,
+            displayValue: `${percentage}% converted`,
+            details: {
+              issues: jsPaths.map(file => ({
+                message: 'Use .ts file extension instead of .js',
+                severity: 'warning',
+                source: { file },
+              })),
+            },
+          },
+        ];
+      },
+    },
+  ],
+};
+
+export default config;

e2e/ci-e2e/project.json

@@ -0,0 +1,23 @@
+{
+  "name": "ci-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "e2e/ci-e2e/src",
+  "projectType": "application",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["e2e/ci-e2e/**/*.ts"]
+      }
+    },
+    "e2e": {
+      "executor": "@nx/vite:test",
+      "options": {
+        "configFile": "e2e/ci-e2e/vite.config.e2e.ts"
+      }
+    }
+  },
+  "implicitDependencies": ["models", "utils", "core", "cli", "ci"],
+  "tags": ["scope:tooling", "type:e2e"]
+}

e2e/ci-e2e/tests/__snapshots__/report-diff.md

@@ -0,0 +1,14 @@
+# Code PushUp
+
+🥳 Code PushUp report has **improved** – compared target commit `<commit-sha>` with source commit `<commit-sha>`.
+
+<details>
+<summary>👍 <strong>1</strong> audit improved</summary>
+
+## 🛡️ Audits
+
+| 🔌 Plugin            | 🛡️ Audit                                            | 📏 Previous value |   📏 Current value    |                                🔄 Value change                                 |
+| :------------------- | :--------------------------------------------------- | :---------------: | :-------------------: | :----------------------------------------------------------------------------: |
+| TypeScript migration | Source files converted from JavaScript to TypeScript | 🟨 50% converted  | 🟩 **100% converted** | ![↑ +100 %](https://img.shields.io/badge/%E2%86%91%20%2B100%E2%80%89%25-green) |
+
+</details>

e2e/ci-e2e/tests/ci.e2e.test.ts

@@ -0,0 +1,183 @@
+import {
+  copyFile,
+  mkdir,
+  readFile,
+  rename,
+  rm,
+  writeFile,
+} from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import {
+  type DiffResult,
+  type FetchResult,
+  type SimpleGit,
+  simpleGit,
+} from 'simple-git';
+import {
+  type Comment,
+  type GitRefs,
+  type Options,
+  type ProviderAPIClient,
+  type RunResult,
+  runInCI,
+} from '@code-pushup/ci';
+import { initGitRepo } from '@code-pushup/test-utils';
+
+describe('CI package', () => {
+  const fixturesDir = join(
+    fileURLToPath(dirname(import.meta.url)),
+    '..',
+    'mocks',
+    'fixtures',
+  );
+  const workDir = join(
+    process.cwd(),
+    'tmp',
+    'e2e',
+    'ci-e2e',
+    '__test__',
+    'ci-test-repo',
+  );
+  const outputDir = join(workDir, '.code-pushup');
+
+  const options = {
+    directory: workDir,
+  } satisfies Options;
+
+  let git: SimpleGit;
+
+  beforeEach(async () => {
+    await rm(workDir, { recursive: true, force: true });
+    await mkdir(workDir, { recursive: true });
+    await copyFile(
+      join(fixturesDir, 'code-pushup.config.ts'),
+      join(workDir, 'code-pushup.config.ts'),
+    );
+    await writeFile(join(workDir, 'index.js'), 'console.log("Hello, world!")');
+
+    git = await initGitRepo(simpleGit, { baseDir: workDir });
+
+    vi.spyOn(git, 'fetch').mockResolvedValue({} as FetchResult);
+    vi.spyOn(git, 'diffSummary').mockResolvedValue({
+      files: [{ file: 'index.ts', binary: false }],
+    } as DiffResult);
+    vi.spyOn(git, 'diff').mockResolvedValue('');
+
+    await git.add('index.js');
+    await git.add('code-pushup.config.ts');
+    await git.commit('Initial commit');
+  });
+
+  afterAll(async () => {
+    await rm(workDir, { recursive: true, force: true });
+  });
+
+  describe('push event', () => {
+    beforeEach(async () => {
+      await git.checkout('main');
+    });
+
+    it('should collect report', async () => {
+      await expect(
+        runInCI(
+          { head: { ref: 'main', sha: await git.revparse('main') } },
+          {} as ProviderAPIClient,
+          options,
+          git,
+        ),
+      ).resolves.toEqual({
+        mode: 'standalone',
+        artifacts: {
+          report: {
+            rootDir: outputDir,
+            files: [
+              join(outputDir, 'report.json'),
+              join(outputDir, 'report.md'),
+            ],
+          },
+        },
+      } satisfies RunResult);
+
+      const jsonPromise = readFile(join(outputDir, 'report.json'), 'utf8');
+      await expect(jsonPromise).resolves.toBeTruthy();
+      const report = JSON.parse(await jsonPromise) as Report;
+      expect(report).toEqual(
+        expect.objectContaining({
+          plugins: [
+            expect.objectContaining({
+              slug: 'ts-migration',
+              audits: [
+                expect.objectContaining({
+                  score: 0.5,
+                  displayValue: '50% converted',
+                }),
+              ],
+            }),
+          ],
+        }),
+      );
+    });
+  });
+
+  describe('pull request event', () => {
+    const comment: Comment = {
+      id: 42,
+      body: '... <!-- generated by @code-pushup/ci -->',
+      url: 'https://github.com/<owner>/<repo>/pull/1#issuecomment-42',
+    };
+    const api: ProviderAPIClient = {
+      maxCommentChars: 1_000_000,
+      createComment: () => Promise.resolve(comment),
+      updateComment: () => Promise.resolve(comment),
+      listComments: () => Promise.resolve([]),
+    };
+
+    let refs: GitRefs;
+
+    beforeEach(async () => {
+      await git.checkoutLocalBranch('feature-1');
+
+      await rename(join(workDir, 'index.js'), join(workDir, 'index.ts'));
+
+      await git.add('index.ts');
+      await git.commit('Convert JS file to TS');
+
+      refs = {
+        head: { ref: 'feature-1', sha: await git.revparse('feature-1') },
+        base: { ref: 'main', sha: await git.revparse('main') },
+      };
+    });
+
+    it('should compare reports', async () => {
+      await expect(runInCI(refs, api, options, git)).resolves.toEqual({
+        mode: 'standalone',
+        commentId: comment.id,
+        newIssues: [],
+        artifacts: {
+          report: {
+            rootDir: outputDir,
+            files: [
+              join(outputDir, 'report.json'),
+              join(outputDir, 'report.md'),
+            ],
+          },
+          diff: {
+            rootDir: outputDir,
+            files: [
+              join(outputDir, 'report-diff.json'),
+              join(outputDir, 'report-diff.md'),
+            ],
+          },
+        },
+      } satisfies RunResult);
+
+      const mdPromise = readFile(join(outputDir, 'report-diff.md'), 'utf8');
+      await expect(mdPromise).resolves.toBeTruthy();
+      const md = await mdPromise;
+      await expect(
+        md.replace(/[\da-f]{40}/g, '`<commit-sha>`'),
+      ).toMatchFileSnapshot('__snapshots__/report-diff.md');
+    });
+  });
+});

e2e/ci-e2e/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "types": ["vitest"]
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.test.json"
+    }
+  ]
+}

e2e/ci-e2e/tsconfig.test.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"]
+  },
+  "include": [
+    "vite.config.e2e.ts",
+    "tests/**/*.e2e.test.ts",
+    "tests/**/*.d.ts",
+    "mocks/**/*.ts"
+  ]
+}

e2e/ci-e2e/vite.config.e2e.ts

@@ -0,0 +1,22 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite';
+import { tsconfigPathAliases } from '../../tools/vitest-tsconfig-path-aliases';
+
+export default defineConfig({
+  cacheDir: '../../node_modules/.vite/ci-e2e',
+  test: {
+    reporters: ['basic'],
+    testTimeout: 120_000,
+    globals: true,
+    alias: tsconfigPathAliases(),
+    pool: 'threads',
+    poolOptions: { threads: { singleThread: true } },
+    cache: {
+      dir: '../../node_modules/.vitest',
+    },
+    environment: 'node',
+    include: ['tests/**/*.e2e.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    globalSetup: ['../../global-setup.verdaccio.ts'],
+    setupFiles: ['../../testing/test-setup/src/lib/reset.mocks.ts'],
+  },
+});

e2e/cli-e2e/project.json

@@ -23,7 +23,6 @@
     "utils",
     "core",
     "cli",
-    "cli",
     "plugin-eslint",
     "plugin-coverage",
     "plugin-js-packages",

nx.json

@@ -114,15 +114,21 @@
     "./tools/src/debug/debug.plugin.ts",
     {
       "plugin": "./tools/src/npm/npm.plugin.ts",
-      "options": { "verbose": true }
+      "options": {
+        "verbose": true
+      }
     },
     {
       "plugin": "./tools/src/publish/publish.plugin.ts",
-      "options": { "verbose": true }
+      "options": {
+        "verbose": true
+      }
     },
     {
       "plugin": "./tools/src/verdaccio/verdaccio.plugin.ts",
-      "options": { "verbose": true }
+      "options": {
+        "verbose": true
+      }
     }
   ]
 }