revert

Author: BioPhoton

packages/cli/docs/nx-caching.md

@@ -49,17 +49,9 @@ export default {
         "coverage.reportsDirectory": "{projectRoot}/coverage/unit-test"
       }
     },
-    "code-pushup-js-packages": {
-      "cache": false,
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "npx @code-pushup/cli collect",
-        "args": ["--config={projectRoot}/code-pushup.config.ts", "--cache.write=true", "--persist.skipReports=true", "--persist.outputDir={projectRoot}/.code-pushup", "--upload.project={projectName}"]
-      }
-    },
     "code-pushup-coverage": {
       "cache": true,
-      "outputs": ["{projectRoot}/.code-pushup/coverage/runner-output.json"],
+      "outputs": ["{projectRoot}/.code-pushup/coverage"],
       "executor": "nx:run-commands",
       "options": {
         "command": "npx @code-pushup/cli collect",
@@ -69,13 +61,13 @@ export default {
     },
     "code-pushup": {
       "cache": true,
-      "outputs": ["{projectRoot}/.code-pushup/report.*"],
+      "outputs": ["{projectRoot}/.code-pushup"],
       "executor": "nx:run-commands",
       "options": {
         "command": "npx @code-pushup/cli",
         "args": ["--config={projectRoot}/code-pushup.config.ts", "--cache.read=true", "--persist.outputDir={projectRoot}/.code-pushup", "--upload.project={projectName}"]
       },
-      "dependsOn": ["code-pushup-coverage", "code-pushup-js-packages"]
+      "dependsOn": ["code-pushup-coverage"]
     }
   }
 }
@@ -88,14 +80,12 @@ This configuration creates the following task dependency graph:
 **Legend:**
 
 - 🐳 = Cached target
-- 💾 = Parallel execution
 
 ```mermaid
 graph TD
-  A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup-coverage 💾🐳]
-  A --> C[lib-a:code-pushup-js-packages 💾]
-  B --> C[lib-a:unit-test 💾🐳]
-  B --> D[lib-a:int-test 💾🐳]
+  A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup-coverage 🐳]
+  B --> C[lib-a:unit-test 🐳]
+  B --> D[lib-a:int-test 🐳]
 ```
 
 ## Command Line Example
@@ -110,7 +100,7 @@ nx affected --target=code-pushup
 
 This approach has the following benefits:
 
-1. **💾 Parallel Execution**: Plugins can run in parallel
-2. **🐳 Fine-grained Caching**: Code level cache invalidation enables usage of [affected](https://nx.dev/recipes/affected-tasks) command
+1. **Parallel Execution**: Plugins can run in parallel
+2. **Fine-grained Caching**: Code level cache invalidation enables usage of [affected](https://nx.dev/recipes/affected-tasks) command
 3. **Dependency Management**: Leverage Nx task dependencies and its caching strategy
 4. **Clear Separation**: Each plugin has its own target for better debugging and maintainability

packages/nx-plugin/.env.lint.local

@@ -0,0 +1 @@
+NODE_OPTIONS=--experimental-require-module

packages/nx-plugin/README.md

@@ -0,0 +1,68 @@
+# @code-pushup/nx-plugin
+
+### Plugin
+
+Register this plugin in your `nx.json` to leverage a set of generators and executors to integrate Code PushUp into a Nx workspace.
+
+#### Registration
+
+```jsonc
+// nx.json
+{
+  //...
+  "plugins": ["@code-pushup/nx-plugin"],
+}
+```
+
+Resulting targets:
+
+- `nx run <project-name>:code-pushup--configuration` (no config file present)
+- `nx run <project-name>:code-pushup` (`code-pushup.config.{ts,mjs,js}` is present)
+
+### Generators
+
+#### Init
+
+Install JS packages and register plugin.
+See [init generator docs](./src/generators/init/README.md) for details
+
+Examples:
+
+- `nx g @code-pushup/nx-plugin:init` - setup code-pushup in the workspace
+- `nx g @code-pushup/nx-plugin:init  --skipPackageJson` - skip `package.json` update
+
+#### Configuration
+
+Adds a `code-pushup` target to your `project.json`.
+See [configuration generator docs](./src/generators/configuration/README.md) for details
+
+Examples:
+
+- `nx g @code-pushup/nx-plugin:configuration --project=<project-name>`
+- `nx g @code-pushup/nx-plugin:configuration --project=<project-name> --targetName=cp`
+
+### Executor
+
+#### CLI
+
+Install JS packages configure a target in your project json.
+See [CLI executor docs](./src/executors/cli/README.md) for details
+
+Examples:
+
+```json
+{
+  "name": "my-project",
+  "targets": {
+    "code-pushup": {
+      "executor": "@code-pushup/nx-plugin:cli",
+      "options": {
+        "projectPrefix": "workspace-name"
+      }
+    }
+  }
+}
+```
+
+- `nx run <project-name>:code-pushup`
+- `nx run <project-name>:code-pushup print-config --persist.filename=custom-report`

packages/nx-plugin/docs/images/nx-plugin-dynamic-target-configuration.png

@@ -0,0 +1,51 @@
+const tseslint = require('typescript-eslint');
+const baseConfig = require('../../eslint.config.js').default;
+
+module.exports = tseslint.config(
+  ...baseConfig,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      // Nx plugins don't yet support ESM: https://github.com/nrwl/nx/issues/15682
+      'unicorn/prefer-module': 'off',
+      // used instead of verbatimModuleSyntax tsconfig flag (requires ESM)
+      '@typescript-eslint/consistent-type-imports': [
+        'warn',
+        {
+          fixStyle: 'inline-type-imports',
+          disallowTypeAnnotations: false,
+        },
+      ],
+      '@typescript-eslint/consistent-type-exports': [
+        'warn',
+        { fixMixedExportsWithInlineTypeSpecifier: true },
+      ],
+      // `import path from 'node:path'` incompatible with CJS runtime, prefer `import * as path from 'node:path'`
+      'unicorn/import-style': [
+        'warn',
+        { styles: { 'node:path': { namespace: true } } },
+      ],
+    },
+  },
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': 'error',
+    },
+  },
+  {
+    files: ['**/package.json', '**/generators.json'],
+    rules: {
+      '@nx/nx-plugin-checks': 'error',
+    },
+  },
+);

packages/nx-plugin/eslint.config.js

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "cli": {
+      "implementation": "./src/executors/cli/executor",
+      "schema": "./src/executors/cli/schema.json",
+      "description": "CodePushup CLI executor. Executes the @code-pushup/cli command's See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#commands"
+    }
+  }
+}

packages/nx-plugin/executors.json

@@ -0,0 +1,14 @@
+{
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/generator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "init generator"
+    },
+    "configuration": {
+      "factory": "./src/generators/configuration/generator",
+      "schema": "./src/generators/configuration/schema.json",
+      "description": "configuration generator"
+    }
+  }
+}

packages/nx-plugin/generators.json

@@ -0,0 +1,7 @@
+export const ENV = {
+  CP_SERVER: 'https://portal.code.pushup.dev',
+  CP_ORGANIZATION: 'code-pushup',
+  CP_PROJECT: 'utils',
+  CP_API_KEY: '23456789098765432345678909876543',
+  CP_TIMEOUT: '9',
+};

packages/nx-plugin/mock/fixtures/env.ts

@@ -0,0 +1,16 @@
+import type { NormalizedExecutorContext } from '../../src/executors/internal/context.js';
+
+export function normalizedExecutorContext(
+  nameOrOpt: string | { projectName: string },
+): NormalizedExecutorContext {
+  const { projectName } =
+    typeof nameOrOpt === 'string' ? { projectName: nameOrOpt } : nameOrOpt;
+  return {
+    projectName,
+    workspaceRoot: 'workspaceRoot',
+    projectConfig: {
+      name: projectName,
+      root: 'root',
+    },
+  };
+}

packages/nx-plugin/mock/utils/executor.ts

@@ -0,0 +1,48 @@
+{
+  "name": "@code-pushup/nx-plugin",
+  "version": "0.74.0",
+  "license": "MIT",
+  "description": "Nx plugin to integrate the Code PushUp CLI into your workspace 🛠️",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://code-pushup.dev",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A\"🧩%20nx-plugin\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/code-pushup/cli.git",
+    "directory": "packages/nx-plugin"
+  },
+  "keywords": [
+    "CLI",
+    "Code PushUp",
+    "Nx",
+    "plugin",
+    "automation",
+    "developer tools",
+    "code quality",
+    "conformance",
+    "build tools"
+  ],
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "dependencies": {
+    "@code-pushup/models": "0.74.0",
+    "@code-pushup/utils": "0.74.0",
+    "@nx/devkit": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "ansis": "^3.3.0",
+    "nx": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "zod": "^4.0.5"
+  },
+  "files": [
+    "src",
+    "./generators.json",
+    "./executors.json",
+    "!**/*.tsbuildinfo"
+  ]
+}