chore: update code-pushup targets

BioPhoton · BioPhoton · commit 07ace2f76215 · 2025-08-12T16:06:17.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -69,6 +69,41 @@ You can control the execution of long-running tests over the `INCLUDE_SLOW_TESTS
 To change this setup, open (or create) the `.env` file in the root folder.
 Edit or add the environment variable there as follows: `INCLUDE_SLOW_TESTS=true`.
 
+### Testing with pkg-new
+
+You can test the CLI using published packages from pull requests via [pkg-new](https://pkg.pr.new/). This is useful for testing changes before they are merged.
+
+To test a specific PR (replace `<PR_NUMBER>` with the actual PR number):
+
+```bash
+# Install required dependencies first
+npm install \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/models@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/core@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@<PR_NUMBER>
+```
+
+Update nx.json to use pkg-new:
+
+```jsonc
+{
+  "targetDefaults": {
+    "code-pushup": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npx https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@<PR_NUMBER>", // instead of "command": "node packages/cli/src/index.ts"
+        "args": [
+          // ...
+        ],
+      },
+    },
+  },
+}
+```
+
+**Note:** The `@code-pushup/portal-client` package may not be available via pkg-new, but it's an optional peer dependency and won't affect collect functionality. Only the upload command is not working.
+
 ## Git
 
 Commit messages must follow [conventional commits](https://conventionalcommits.org/) format.
diff --git a/e2e/create-cli-e2e/project.json b/e2e/create-cli-e2e/project.json
@@ -1,7 +1,7 @@
 {
   "name": "create-cli-e2e",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "examples/create-cli-e2e/src",
+  "sourceRoot": "e2e/create-cli-e2e/src",
   "projectType": "application",
   "targets": {
     "lint": {},
diff --git a/examples/plugins/project.json b/examples/plugins/project.json
@@ -4,6 +4,12 @@
   "sourceRoot": "examples/plugins/src",
   "projectType": "library",
   "targets": {
+    "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
+      "dependsOn": ["unit-test", "int-test"]
+    },
     "build": {
       "executor": "@nx/js:tsc",
       "outputs": ["{options.outputPath}"],
diff --git a/nx.json b/nx.json
@@ -3,25 +3,60 @@
   "targetDefaults": {
     "code-pushup": {
       "cache": true,
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{projectRoot}/.code-pushup/*.md",
+        "{projectRoot}/.code-pushup/*.json"
+      ],
       "executor": "nx:run-commands",
       "options": {
-        "command": "node packages/cli/src/index.ts --no-progress --verbose",
-        "config": "{projectRoot}/code-pushup.config.ts",
-        "persist": {
-          "filename": "{projectName}-report",
-          "outputDir": "{projectRoot}/.code-pushup"
-        },
-        "upload": {
-          "project": "cli-{projectName}"
-        },
+        "command": "npx https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1059",
+        "args": [
+          "--no-progress",
+          "--verbose",
+          "--config",
+          "{projectRoot}/code-pushup.config.ts",
+          "--persist.filename",
+          "{projectName}-report",
+          "--persist.outputDir",
+          "{projectRoot}/.code-pushup",
+          "--upload.project",
+          "cli-{projectName}"
+        ],
         "outputPath": "{projectRoot}/.code-pushup",
         "env": {
           "NODE_OPTIONS": "--import tsx",
           "TSX_TSCONFIG_PATH": "tsconfig.base.json"
         }
       }
     },
+    "code-pushup-coverage": {
+      "cache": true,
+      "outputs": ["{projectRoot}/.code-pushup/coverage"],
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npm install https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1059 https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1059 && npx --yes https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1059",
+        "args": [
+          "--no-progress",
+          "--verbose",
+          "--config",
+          "{projectRoot}/code-pushup.config.ts",
+          "--cache.write",
+          "true",
+          "--onlyPlugins",
+          "coverage",
+          "--persist.skipReports",
+          "true",
+          "--persist.outputDir",
+          "{projectRoot}/.code-pushup",
+          "--upload.project",
+          "{projectName}"
+        ],
+        "env": {
+          "NODE_OPTIONS": "--import tsx",
+          "TSX_TSCONFIG_PATH": "tsconfig.base.json"
+        }
+      }
+    },
     "build": {
       "dependsOn": ["^build"],
       "inputs": ["production", "^production"],
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -22,7 +22,9 @@
     "node": ">=22.14"
   },
   "dependencies": {
+    "@code-pushup/models": "https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1059",
     "@code-pushup/portal-client": "^0.15.0",
+    "@code-pushup/utils": "https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1059",
     "@isaacs/cliui": "^8.0.2",
     "@nx/devkit": "19.8.13",
     "@poppinss/cliui": "6.4.1",
diff --git a/packages/ci/project.json b/packages/ci/project.json
@@ -4,6 +4,12 @@
   "sourceRoot": "packages/ci/src",
   "projectType": "library",
   "targets": {
+    "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
+      "dependsOn": ["unit-test", "int-test"]
+    },
     "build": {},
     "lint": {},
     "unit-test": {
diff --git a/packages/cli/project.json b/packages/cli/project.json
@@ -5,7 +5,10 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
-      "dependsOn": ["unit-test", "int-test"]
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
+      "dependsOn": ["unit-test", "int-test", "e2e-test"]
     },
     "build": {},
     "lint": {},
diff --git a/packages/core/project.json b/packages/core/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/create-cli/project.json b/packages/create-cli/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/models/code-pushup.config.ts b/packages/models/code-pushup.config.ts
@@ -21,6 +21,7 @@ const config: CoreConfig = {
   plugins: [],
 };
 
+// This part should use mergeConfig in a normal setup, but here we are manually merging to avoid circular dependencies
 export default [
   await eslintCoreConfigNx(projectName),
   await coverageCoreConfigNx(projectName),
@@ -41,20 +42,3 @@ export default [
   });
   return acc;
 }, config);
-/*
-//import { mergeConfigs } from '../../packages/utils/src/index.js';
-
-export default mergeConfigs(
-  config,
-  await eslintCoreConfigNx(projectName),
-  await coverageCoreConfigNx(projectName),
-  await jsPackagesCoreConfig('package.json'), // Use workspace root package.json
-  await typescriptPluginConfig({
-    tsconfig: `packages/${projectName}/tsconfig.lib.json`,
-  }),
-  jsDocsCoreConfig([
-    `packages/${projectName}/src/**\/*.ts`,
-    ...jsDocsExclusionPatterns,
-  ]),
-);
-*/
diff --git a/packages/models/project.json b/packages/models/project.json
@@ -11,6 +11,9 @@
       "outputs": ["{projectRoot}/docs/models-reference.md"]
     },
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {
diff --git a/packages/models/transformers/project.json b/packages/models/transformers/project.json
@@ -4,6 +4,10 @@
   "sourceRoot": "packages/models/transformers/src",
   "projectType": "library",
   "targets": {
+    "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {},
     "build": {
       "executor": "@nx/js:tsc",
       "outputs": ["{options.outputPath}"],
diff --git a/packages/nx-plugin/project.json b/packages/nx-plugin/project.json
@@ -6,6 +6,9 @@
   "implicitDependencies": ["cli"],
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {
diff --git a/packages/plugin-coverage/project.json b/packages/plugin-coverage/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/plugin-eslint/project.json b/packages/plugin-eslint/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/plugin-js-packages/project.json b/packages/plugin-js-packages/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/plugin-jsdocs/project.json b/packages/plugin-jsdocs/project.json
@@ -6,6 +6,9 @@
   "tags": ["scope:plugin", "type:feature", "publishable"],
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/plugin-lighthouse/project.json b/packages/plugin-lighthouse/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/plugin-typescript/project.json b/packages/plugin-typescript/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/packages/utils/project.json b/packages/utils/project.json
@@ -5,6 +5,9 @@
   "projectType": "library",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"]
+    },
+    "code-pushup-coverage": {
       "dependsOn": ["unit-test", "int-test"]
     },
     "build": {},
diff --git a/project.json b/project.json
@@ -3,10 +3,12 @@
   "$schema": "node_modules/nx/schemas/project-schema.json",
   "targets": {
     "code-pushup": {
+      "dependsOn": ["code-pushup-coverage"],
       "options": {
         "config": "{workspaceRoot}/code-pushup.config.ts",
         "upload.project": "cli"
       }
-    }
+    },
+    "code-pushup-coverage": {}
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "create-cli-e2e",`
`3`	`3`	`"$schema": "../../node_modules/nx/schemas/project-schema.json",`
`4`		`- "sourceRoot": "examples/create-cli-e2e/src",`
	`4`	`+ "sourceRoot": "e2e/create-cli-e2e/src",`
`5`	`5`	`"projectType": "application",`
`6`	`6`	`"targets": {`
`7`	`7`	`"lint": {},`