ci: configure cached code-pushup targets per project

Author: matejchalk

code-pushup.preset.ts

@@ -27,14 +27,14 @@ import typescriptPlugin, {
   getCategories,
 } from './packages/plugin-typescript/src/index.js';
 
-export function configureUpload(): CoreConfig {
+export function configureUpload(projectName?: string): CoreConfig {
   return {
     ...(process.env['CP_API_KEY'] && {
       upload: {
         server: 'https://api.staging.code-pushup.dev/graphql',
         apiKey: process.env['CP_API_KEY'],
         organization: 'code-pushup',
-        project: process.env['NX_TASK_TARGET_PROJECT'] ?? 'cli-workspace',
+        project: projectName ? `cli-${projectName}` : 'cli-workspace',
       },
     }),
     plugins: [],
@@ -89,20 +89,19 @@ export async function configureEslintPlugin(
 export async function configureCoveragePlugin(
   projectName?: string,
 ): Promise<CoreConfig> {
+  const targets = ['unit-test', 'int-test'];
   const config: CoveragePluginConfig = projectName
     ? // We do not need to run a coverageToolCommand. This is handled over the Nx task graph.
       {
-        reports: [
-          {
-            pathToProject: `packages/${projectName}`,
-            resultsPath: `packages/${projectName}/coverage/lcov.info`,
-          },
-        ],
+        reports: targets.map(target => ({
+          pathToProject: `packages/${projectName}`,
+          resultsPath: `coverage/${projectName}/${target}s/lcov.info`,
+        })),
       }
     : {
-        reports: await getNxCoveragePaths(['unit-test', 'int-test']),
+        reports: await getNxCoveragePaths(targets),
         coverageToolCommand: {
-          command: 'npx nx run-many -t unit-test,int-test',
+          command: `npx nx run-many -t ${targets.join(',')}`,
         },
       };
   return {

nx.json

@@ -12,7 +12,7 @@
       "!{projectRoot}/zod2md.config.ts",
       "!{projectRoot}/eslint.config.?(c)js",
       "!{workspaceRoot}/**/.code-pushup/**/*",
-      "!{projectRoot}/code-pushup.config.?(*.).?(m)[jt]s",
+      "!{projectRoot}/code-pushup.config.?(m)[jt]s",
       "!{projectRoot}/@(test|mocks|mock)/**/*",
       "!{projectRoot}/**/?(*.)test.[jt]s?(x)?(.snap)",
       "!{projectRoot}/**/?(*.)mocks.[jt]s?(x)",
@@ -122,8 +122,7 @@
         "args": [
           "--config={projectRoot}/code-pushup.config.ts",
           "--cache.read",
-          "--persist.outputDir={projectRoot}/.code-pushup",
-          "--upload.project=cli-{projectName}"
+          "--persist.outputDir={projectRoot}/.code-pushup"
         ],
         "env": {
           "NODE_OPTIONS": "--import tsx",
@@ -132,11 +131,11 @@
       }
     },
     "code-pushup-coverage": {
+      "dependsOn": ["*-test"],
       "cache": true,
       "inputs": ["default", "code-pushup-inputs"],
       "outputs": ["{projectRoot}/.code-pushup/coverage/runner-output.json"],
       "executor": "nx:run-commands",
-      "dependsOn": ["*-test"],
       "options": {
         "command": "node packages/cli/src/index.ts collect",
         "args": [
@@ -153,6 +152,7 @@
       }
     },
     "code-pushup-eslint": {
+      "dependsOn": ["lint"],
       "cache": true,
       "inputs": ["default", "code-pushup-inputs"],
       "outputs": ["{projectRoot}/.code-pushup/eslint/runner-output.json"],

packages/ci/code-pushup.config.ts

@@ -0,0 +1,19 @@
+import 'dotenv/config';
+import {
+  configureCoveragePlugin,
+  configureEslintPlugin,
+  configureJsDocsPlugin,
+  configureTypescriptPlugin,
+  configureUpload,
+} from '../../code-pushup.preset.js';
+import { mergeConfigs } from '../utils/src/index.js';
+
+const projectName = 'ci';
+
+export default mergeConfigs(
+  configureUpload(projectName),
+  await configureEslintPlugin(projectName),
+  await configureCoveragePlugin(projectName),
+  configureTypescriptPlugin(projectName),
+  configureJsDocsPlugin(projectName),
+);

packages/ci/project.json

@@ -8,7 +8,12 @@
     "lint": {},
     "lint-report": {},
     "unit-test": {},
-    "int-test": {}
+    "int-test": {},
+    "code-pushup": {},
+    "code-pushup-eslint": {},
+    "code-pushup-coverage": {},
+    "code-pushup-typescript": {},
+    "code-pushup-jsdocs": {}
   },
   "tags": ["scope:tooling", "type:feature", "publishable"]
 }

packages/cli/code-pushup.config.ts

@@ -0,0 +1,19 @@
+import 'dotenv/config';
+import {
+  configureCoveragePlugin,
+  configureEslintPlugin,
+  configureJsDocsPlugin,
+  configureTypescriptPlugin,
+  configureUpload,
+} from '../../code-pushup.preset.js';
+import { mergeConfigs } from '../utils/src/index.js';
+
+const projectName = 'cli';
+
+export default mergeConfigs(
+  configureUpload(projectName),
+  await configureEslintPlugin(projectName),
+  await configureCoveragePlugin(projectName),
+  configureTypescriptPlugin(projectName),
+  configureJsDocsPlugin(projectName),
+);

packages/cli/project.json

@@ -9,24 +9,11 @@
     "lint-report": {},
     "unit-test": {},
     "int-test": {},
-    "run-help": {
-      "command": "npx dist/packages/cli --help",
-      "dependsOn": ["build"]
-    },
-    "run-collect": {
-      "command": "npx ../../dist/packages/cli collect --persist.format=json --persist.format=md",
-      "options": {
-        "cwd": "examples/react-todos-app"
-      },
-      "dependsOn": ["build"]
-    },
-    "run-print-config": {
-      "command": "npx ../../dist/packages/cli print-config",
-      "options": {
-        "cwd": "examples/react-todos-app"
-      },
-      "dependsOn": ["build"]
-    }
+    "code-pushup": {},
+    "code-pushup-eslint": {},
+    "code-pushup-coverage": {},
+    "code-pushup-typescript": {},
+    "code-pushup-jsdocs": {}
   },
   "tags": ["scope:core", "type:app", "publishable"]
 }

packages/core/code-pushup.config.ts

@@ -0,0 +1,19 @@
+import 'dotenv/config';
+import {
+  configureCoveragePlugin,
+  configureEslintPlugin,
+  configureJsDocsPlugin,
+  configureTypescriptPlugin,
+  configureUpload,
+} from '../../code-pushup.preset.js';
+import { mergeConfigs } from '../utils/src/index.js';
+
+const projectName = 'core';
+
+export default mergeConfigs(
+  configureUpload(projectName),
+  await configureEslintPlugin(projectName),
+  await configureCoveragePlugin(projectName),
+  configureTypescriptPlugin(projectName),
+  configureJsDocsPlugin(projectName),
+);

packages/core/project.json

@@ -8,7 +8,12 @@
     "lint": {},
     "lint-report": {},
     "unit-test": {},
-    "int-test": {}
+    "int-test": {},
+    "code-pushup": {},
+    "code-pushup-eslint": {},
+    "code-pushup-coverage": {},
+    "code-pushup-typescript": {},
+    "code-pushup-jsdocs": {}
   },
   "tags": ["scope:core", "type:feature", "publishable"]
 }

packages/create-cli/code-pushup.config.ts

@@ -0,0 +1,19 @@
+import 'dotenv/config';
+import {
+  configureCoveragePlugin,
+  configureEslintPlugin,
+  configureJsDocsPlugin,
+  configureTypescriptPlugin,
+  configureUpload,
+} from '../../code-pushup.preset.js';
+import { mergeConfigs } from '../utils/src/index.js';
+
+const projectName = 'create-cli';
+
+export default mergeConfigs(
+  configureUpload(projectName),
+  await configureEslintPlugin(projectName),
+  await configureCoveragePlugin(projectName),
+  configureTypescriptPlugin(projectName),
+  configureJsDocsPlugin(projectName),
+);

packages/create-cli/project.json

@@ -8,16 +8,11 @@
     "lint": {},
     "lint-report": {},
     "unit-test": {},
-    "exec-node": {
-      "dependsOn": ["build"],
-      "command": "node ./dist/packages/create-cli/src/index.js",
-      "options": {}
-    },
-    "exec-npm": {
-      "dependsOn": ["^build"],
-      "command": "npm exec ./dist/packages/create-cli",
-      "options": {}
-    }
+    "code-pushup": {},
+    "code-pushup-eslint": {},
+    "code-pushup-coverage": {},
+    "code-pushup-typescript": {},
+    "code-pushup-jsdocs": {}
   },
   "tags": ["scope:tooling", "type:app", "publishable"]
 }