@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

// 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 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 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 for details

Examples:

{
  "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