@code-pushup/nx-plugin 0.51.0

package/README.md

@@ -0,0 +1,23 @@
+# @code-pushup/nx-plugin
+
+### Generators
+
+#### Init
+
+Install JS packages and register plugin.
+See [init 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 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`

package/executors.json

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

package/generators.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"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@code-pushup/nx-plugin",
+  "version": "0.51.0",
+  "license": "MIT",
+  "description": "Nx plugin to integrate the Code PushUp CLI into your workspace 🛠️",
+  "homepage": "code-pushup.dev",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/code-pushup/cli.git",
+    "directory": "packages/nx-plugin"
+  },
+  "dependencies": {
+    "@nx/devkit": "^17.1.3",
+    "tslib": "^2.6.2",
+    "nx": "^17.1.3",
+    "@code-pushup/models": "0.51.0",
+    "zod": "^3.22.4",
+    "@code-pushup/utils": "0.51.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "generators": "./generators.json",
+  "executors": "./executors.json"
+}

package/src/executors/autorun/README.md

@@ -0,0 +1,61 @@
+# Autorun Executor
+
+This executor is used to run the code-pushup CLI autorun command in a Nx workspace.
+For details on the CLI command read the [CLI autorun documentation](https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#autorun-command).
+
+#### @code-pushup/nx-plugin:autorun
+
+## Usage
+
+// project.json
+
+```json
+{
+  "name": "my-project",
+  "targets": {
+    "code-pushup": {
+      "executor": "@code-pushup/nx-plugin:autorun"
+    }
+  }
+}
+```
+
+By default, the Nx plugin will derive the options from the executor config.
+
+The following things happen:
+
+- the output directory defaults to `${workspaceRoot}/.code-pushup/${projectName}`
+- the config file defaults to `${projectRoot}/code-pushup.config.ts`
+- parses terminal arguments and forwards them to the CLI command (they override the executor config)
+- the CLI command is executed
+
+```jsonc
+{
+  "name": "my-project",
+  "targets": {
+    "code-pushup": {
+      "executor": "@code-pushup/nx-plugin:autorun",
+      "options": {
+        "projectPrefix": "cli", // upload.project = cli-my-project
+        "verbose": true,
+        "progress": false
+        // persist and upload options as defined in CoreConfig
+      }
+    }
+  }
+}
+```
+
+Show what will be executed without actually executing it:
+
+`nx run my-project:code-pushup --dryRun`
+
+## Options
+
+| Name              | type      | description                                                        |
+| ----------------- | --------- | ------------------------------------------------------------------ |
+| **projectPrefix** | `string`  | prefix for upload.project on non root projects                     |
+| **dryRun**        | `boolean` | To debug the executor, dry run the command without real execution. |
+| **bin**           | `string`  | Path to Code PushUp CLI                                            |
+
+For all other options see the [CLI autorun documentation](../../cli/packages/cli/README.md#autorun-command).

package/src/executors/autorun/constants.d.ts

@@ -0,0 +1 @@
+export declare const AUTORUN_COMMAND = "autorun";

package/src/executors/autorun/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUTORUN_COMMAND = void 0;
+exports.AUTORUN_COMMAND = 'autorun';
+//# sourceMappingURL=constants.js.map

package/src/executors/autorun/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/autorun/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,SAAS,CAAC"}

package/src/executors/autorun/executor.d.ts

@@ -0,0 +1,15 @@
+import { type ExecutorContext } from '@nx/devkit';
+import type { AutorunCommandExecutorOptions } from './schema';
+export type ExecutorOutput = {
+    success: boolean;
+    command?: string;
+    error?: Error;
+};
+export default function runAutorunExecutor(terminalAndExecutorOptions: AutorunCommandExecutorOptions, context: ExecutorContext): Promise<{
+    success: boolean;
+    command: string;
+    error: unknown;
+}> | Promise<{
+    success: true;
+    command: string;
+}>;

package/src/executors/autorun/executor.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+// eslint-disable-next-line n/no-sync
+const node_child_process_1 = require("node:child_process");
+const cli_1 = require("../internal/cli");
+const context_1 = require("../internal/context");
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+function runAutorunExecutor(terminalAndExecutorOptions, context) {
+    const normalizedContext = (0, context_1.normalizeContext)(context);
+    const cliArgumentObject = (0, utils_1.parseAutorunExecutorOptions)(terminalAndExecutorOptions, normalizedContext);
+    const { dryRun, verbose } = terminalAndExecutorOptions;
+    const command = (0, cli_1.createCliCommand)(constants_1.AUTORUN_COMMAND, cliArgumentObject);
+    const commandOptions = context.cwd ? { cwd: context.cwd } : {};
+    if (verbose) {
+        devkit_1.logger.info(`Run ${constants_1.AUTORUN_COMMAND} executor`);
+        devkit_1.logger.info(`Command: ${command}`);
+    }
+    if (dryRun) {
+        devkit_1.logger.warn(`DryRun execution of: ${command}`);
+    }
+    else {
+        try {
+            // @TODO use executeProcess instead of execSync -> non blocking, logs #761
+            // eslint-disable-next-line n/no-sync
+            (0, node_child_process_1.execSync)(command, commandOptions);
+        }
+        catch (error) {
+            devkit_1.logger.error(error);
+            return Promise.resolve({
+                success: false,
+                command,
+                error,
+            });
+        }
+    }
+    return Promise.resolve({
+        success: true,
+        command,
+    });
+}
+exports.default = runAutorunExecutor;
+//# sourceMappingURL=executor.js.map

package/src/executors/autorun/executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/autorun/executor.ts"],"names":[],"mappings":";;AAAA,uCAA0D;AAC1D,qCAAqC;AACrC,2DAA8C;AAC9C,yCAAmD;AACnD,iDAAuD;AACvD,2CAA8C;AAE9C,mCAAsD;AAQtD,SAAwB,kBAAkB,CACxC,0BAAyD,EACzD,OAAwB;IAExB,MAAM,iBAAiB,GAAG,IAAA,0BAAgB,EAAC,OAAO,CAAC,CAAC;IACpD,MAAM,iBAAiB,GAAG,IAAA,mCAA2B,EACnD,0BAA0B,EAC1B,iBAAiB,CAClB,CAAC;IACF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,0BAA0B,CAAC;IACvD,MAAM,OAAO,GAAG,IAAA,sBAAgB,EAAC,2BAAe,EAAE,iBAAiB,CAAC,CAAC;IACrE,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,IAAI,OAAO,EAAE,CAAC;QACZ,eAAM,CAAC,IAAI,CAAC,OAAO,2BAAe,WAAW,CAAC,CAAC;QAC/C,eAAM,CAAC,IAAI,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,eAAM,CAAC,IAAI,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,0EAA0E;YAC1E,qCAAqC;YACrC,IAAA,6BAAQ,EAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,eAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,OAAO,EAAE,KAAK;gBACd,OAAO;gBACP,KAAK;aACN,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC,OAAO,CAAC;QACrB,OAAO,EAAE,IAAI;QACb,OAAO;KACiB,CAAC,CAAC;AAC9B,CAAC;AArCD,qCAqCC"}

package/src/executors/autorun/schema.d.ts

@@ -0,0 +1,7 @@
+import type { PersistConfig, UploadConfig } from '@code-pushup/models';
+import type { CollectExecutorOnlyOptions, GeneralExecutorOnlyOptions, GlobalExecutorOptions, ProjectExecutorOnlyOptions } from '../internal/types';
+export type AutorunCommandExecutorOnlyOptions = ProjectExecutorOnlyOptions & CollectExecutorOnlyOptions & GeneralExecutorOnlyOptions;
+export type AutorunCommandExecutorOptions = Partial<{
+    upload: Partial<UploadConfig>;
+    persist: Partial<PersistConfig>;
+} & AutorunCommandExecutorOnlyOptions & GlobalExecutorOptions>;

package/src/executors/autorun/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/src/executors/autorun/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/autorun/schema.ts"],"names":[],"mappings":""}

package/src/executors/autorun/schema.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "AutorunExecutorOptions",
+  "title": "CodePushup CLI autorun executor",
+  "description": "Executes the @code-pushup/cli autorun command See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#autorun-command",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "x-prompt": "Which project should configure Code Pushup?",
+      "x-dropdown": "projects",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Print the commands that would be run, but don't actually run them"
+    },
+    "bin": {
+      "type": "string",
+      "description": "Path to Code PushUp CLI"
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Print additional logs"
+    },
+    "progress": {
+      "type": "boolean",
+      "description": "Print additional logs"
+    },
+    "onlyPlugins": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Only run the specified plugins"
+    },
+    "config": {
+      "type": "string",
+      "description": "Path to the configuration file"
+    },
+    "projectPrefix": {
+      "type": "string",
+      "description": "Prefix for project name"
+    },
+    "persist": {
+      "type": "object",
+      "properties": {
+        "filename": {
+          "type": "string",
+          "description": "Filename to save the configuration"
+        },
+        "outputDir": {
+          "type": "string",
+          "description": "Directory to save the configuration"
+        },
+        "format": {
+          "type": "array",
+          "enum": ["json", "md"],
+          "description": "Format to save the report in"
+        }
+      }
+    },
+    "upload": {
+      "type": "object",
+      "properties": {
+        "server": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL of deployed portal API"
+        },
+        "apiKey": {
+          "type": "string",
+          "description": "API key with write access to portal (use `process.env` for security)"
+        },
+        "organization": {
+          "type": "string",
+          "pattern": "^[a-z\\d]+(?:-[a-z\\d]+)*$",
+          "maxLength": 128,
+          "description": "Organization slug from Code PushUp portal"
+        },
+        "project": {
+          "type": "string",
+          "pattern": "^[a-z\\d]+(?:-[a-z\\d]+)*$",
+          "maxLength": 128,
+          "description": "Project slug from Code PushUp portal"
+        },
+        "timeout": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "description": "Request timeout in minutes"
+        }
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/src/executors/autorun/utils.d.ts

@@ -0,0 +1,4 @@
+import type { NormalizedExecutorContext } from '../internal/context';
+import type { AutorunCommandExecutorOnlyOptions, AutorunCommandExecutorOptions } from './schema';
+export declare function parseAutorunExecutorOnlyOptions(options: Partial<AutorunCommandExecutorOnlyOptions>): AutorunCommandExecutorOnlyOptions;
+export declare function parseAutorunExecutorOptions(options: Partial<AutorunCommandExecutorOptions>, normalizedContext: NormalizedExecutorContext): AutorunCommandExecutorOptions;

package/src/executors/autorun/utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAutorunExecutorOptions = exports.parseAutorunExecutorOnlyOptions = void 0;
+const config_1 = require("../internal/config");
+function parseAutorunExecutorOnlyOptions(options) {
+    const { projectPrefix, dryRun, onlyPlugins } = options;
+    return {
+        ...(projectPrefix && { projectPrefix }),
+        ...(dryRun != null && { dryRun }),
+        ...(onlyPlugins && { onlyPlugins }),
+    };
+}
+exports.parseAutorunExecutorOnlyOptions = parseAutorunExecutorOnlyOptions;
+function parseAutorunExecutorOptions(options, normalizedContext) {
+    const { projectPrefix, persist, upload } = options;
+    return {
+        ...parseAutorunExecutorOnlyOptions(options),
+        ...(0, config_1.globalConfig)(options, normalizedContext),
+        persist: (0, config_1.persistConfig)({ projectPrefix, ...persist }, normalizedContext),
+        upload: (0, config_1.uploadConfig)({ projectPrefix, ...upload }, normalizedContext),
+    };
+}
+exports.parseAutorunExecutorOptions = parseAutorunExecutorOptions;
+//# sourceMappingURL=utils.js.map

package/src/executors/autorun/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/autorun/utils.ts"],"names":[],"mappings":";;;AAAA,+CAA+E;AAO/E,SAAgB,+BAA+B,CAC7C,OAAmD;IAEnD,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IACvD,OAAO;QACL,GAAG,CAAC,aAAa,IAAI,EAAE,aAAa,EAAE,CAAC;QACvC,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;QACjC,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;KACpC,CAAC;AACJ,CAAC;AATD,0EASC;AAED,SAAgB,2BAA2B,CACzC,OAA+C,EAC/C,iBAA4C;IAE5C,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACnD,OAAO;QACL,GAAG,+BAA+B,CAAC,OAAO,CAAC;QAC3C,GAAG,IAAA,qBAAY,EAAC,OAAO,EAAE,iBAAiB,CAAC;QAC3C,OAAO,EAAE,IAAA,sBAAa,EAAC,EAAE,aAAa,EAAE,GAAG,OAAO,EAAE,EAAE,iBAAiB,CAAC;QACxE,MAAM,EAAE,IAAA,qBAAY,EAAC,EAAE,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,iBAAiB,CAAC;KACtE,CAAC;AACJ,CAAC;AAXD,kEAWC"}

package/src/executors/internal/cli.d.ts

@@ -0,0 +1,10 @@
+export declare function createCliCommand(command: string, args: Record<string, unknown>, options?: {
+    bin: string;
+}): string;
+type ArgumentValue = number | string | boolean | string[];
+export type CliArgsObject<T extends object = Record<string, ArgumentValue>> = T extends never ? // eslint-disable-next-line @typescript-eslint/naming-convention
+Record<string, ArgumentValue | undefined> | {
+    _: string;
+} : T;
+export declare function objectToCliArgs<T extends object = Record<string, ArgumentValue>>(params?: CliArgsObject<T>): string[];
+export {};

package/src/executors/internal/cli.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectToCliArgs = exports.createCliCommand = void 0;
+function createCliCommand(command, args, options) {
+    const { bin = '@code-pushup/cli' } = options ?? {};
+    return `npx ${bin} ${command} ${objectToCliArgs(args).join(' ')}`;
+}
+exports.createCliCommand = createCliCommand;
+// @TODO import from @code-pushup/utils => get rid of poppins for cjs support
+// eslint-disable-next-line sonarjs/cognitive-complexity
+function objectToCliArgs(params) {
+    if (!params) {
+        return [];
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return Object.entries(params).flatMap(([key, value]) => {
+        // process/file/script
+        if (key === '_') {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return Array.isArray(value) ? value : [`${value}`];
+        }
+        const prefix = key.length === 1 ? '-' : '--';
+        // "-*" arguments (shorthands)
+        if (Array.isArray(value)) {
+            return value.map(v => `${prefix}${key}="${v}"`);
+        }
+        if (typeof value === 'object') {
+            return Object.entries(value).flatMap(
+            // transform nested objects to the dot notation `key.subkey`
+            ([k, v]) => objectToCliArgs({ [`${key}.${k}`]: v }));
+        }
+        if (typeof value === 'string') {
+            return [`${prefix}${key}="${value}"`];
+        }
+        if (typeof value === 'number') {
+            return [`${prefix}${key}=${value}`];
+        }
+        if (typeof value === 'boolean') {
+            return [`${prefix}${value ? '' : 'no-'}${key}`];
+        }
+        if (value === undefined) {
+            return [];
+        }
+        throw new Error(`Unsupported type ${typeof value} for key ${key}`);
+    });
+}
+exports.objectToCliArgs = objectToCliArgs;
+//# sourceMappingURL=cli.js.map

package/src/executors/internal/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/internal/cli.ts"],"names":[],"mappings":";;;AAAA,SAAgB,gBAAgB,CAC9B,OAAe,EACf,IAA6B,EAC7B,OAEC;IAED,MAAM,EAAE,GAAG,GAAG,kBAAkB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACnD,OAAO,OAAO,GAAG,IAAI,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACpE,CAAC;AATD,4CASC;AAQD,6EAA6E;AAC7E,wDAAwD;AACxD,SAAgB,eAAe,CAE7B,MAAyB;IACzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,+DAA+D;IAC/D,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACrD,sBAAsB;QACtB,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YAChB,+DAA+D;YAC/D,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7C,8BAA8B;QAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,CAAC,OAAO;YAC7D,4DAA4D;YAC5D,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CACpD,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,MAAM,GAAG,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,KAAK,YAAY,GAAG,EAAE,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC;AA9CD,0CA8CC"}

package/src/executors/internal/config.d.ts

@@ -0,0 +1,5 @@
+import type { PersistConfig, UploadConfig } from '@code-pushup/models';
+import type { BaseNormalizedExecutorContext, GlobalExecutorOptions, ProjectExecutorOnlyOptions } from './types';
+export declare function globalConfig(options: Partial<GlobalExecutorOptions & Record<string, unknown>>, context: BaseNormalizedExecutorContext): GlobalExecutorOptions;
+export declare function persistConfig(options: Partial<PersistConfig & ProjectExecutorOnlyOptions>, context: BaseNormalizedExecutorContext): Partial<PersistConfig>;
+export declare function uploadConfig(options: Partial<UploadConfig & ProjectExecutorOnlyOptions>, context: BaseNormalizedExecutorContext): Partial<UploadConfig>;

package/src/executors/internal/config.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadConfig = exports.persistConfig = exports.globalConfig = void 0;
+const node_path_1 = require("node:path");
+const env_1 = require("./env");
+function globalConfig(options, context) {
+    const { projectConfig } = context;
+    const { root: projectRoot = '' } = projectConfig ?? {};
+    // For better debugging use `--verbose --no-progress` as default
+    const { verbose, progress, config } = options;
+    return {
+        verbose: !!verbose,
+        progress: !!progress,
+        config: config ?? (0, node_path_1.join)(projectRoot, 'code-pushup.config.ts'),
+    };
+}
+exports.globalConfig = globalConfig;
+function persistConfig(options, context) {
+    const { projectConfig, workspaceRoot } = context;
+    const { name: projectName = '' } = projectConfig ?? {};
+    const { format, outputDir = (0, node_path_1.join)(workspaceRoot, '.code-pushup', projectName), // always in <root>/.code-pushup/<project-name>,
+    filename, } = options;
+    return {
+        outputDir,
+        ...(format ? { format } : {}),
+        ...(filename ? { filename } : {}),
+    };
+}
+exports.persistConfig = persistConfig;
+function uploadConfig(options, context) {
+    const { projectConfig, workspaceRoot } = context;
+    const { name: projectName } = projectConfig ?? {};
+    const { projectPrefix, server, apiKey, organization, project, timeout } = options;
+    const applyPrefix = workspaceRoot === '.';
+    const prefix = projectPrefix ? `${projectPrefix}-` : '';
+    return {
+        ...(projectName
+            ? {
+                project: applyPrefix ? `${prefix}${projectName}` : projectName, // provide correct project
+            }
+            : {}),
+        ...(0, env_1.parseEnv)(process.env),
+        ...Object.fromEntries(Object.entries({ server, apiKey, organization, project, timeout }).filter(([_, v]) => v !== undefined)),
+    };
+}
+exports.uploadConfig = uploadConfig;
+//# sourceMappingURL=config.js.map

package/src/executors/internal/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/internal/config.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAEjC,+BAAiC;AAOjC,SAAgB,YAAY,CAC1B,OAAiE,EACjE,OAAsC;IAEtC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAClC,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,aAAa,IAAI,EAAE,CAAC;IACvD,gEAAgE;IAChE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC9C,OAAO;QACL,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,MAAM,EAAE,MAAM,IAAI,IAAA,gBAAI,EAAC,WAAW,EAAE,uBAAuB,CAAC;KAC7D,CAAC;AACJ,CAAC;AAbD,oCAaC;AAED,SAAgB,aAAa,CAC3B,OAA4D,EAC5D,OAAsC;IAEtC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAEjD,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,aAAa,IAAI,EAAE,CAAC;IACvD,MAAM,EACJ,MAAM,EACN,SAAS,GAAG,IAAA,gBAAI,EAAC,aAAa,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,gDAAgD;IAC9G,QAAQ,GACT,GAAG,OAAO,CAAC;IAEZ,OAAO;QACL,SAAS;QACT,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAClC,CAAC;AACJ,CAAC;AAlBD,sCAkBC;AAED,SAAgB,YAAY,CAC1B,OAA2D,EAC3D,OAAsC;IAEtC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAEjD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,aAAa,IAAI,EAAE,CAAC;IAClD,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,GACrE,OAAO,CAAC;IACV,MAAM,WAAW,GAAG,aAAa,KAAK,GAAG,CAAC;IAC1C,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,0BAA0B;aAC3F;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,IAAA,cAAQ,EAAC,OAAO,CAAC,GAAG,CAAC;QACxB,GAAG,MAAM,CAAC,WAAW,CACnB,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CACvE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAC5B,CACF;KACF,CAAC;AACJ,CAAC;AAxBD,oCAwBC"}

package/src/executors/internal/context.d.ts

@@ -0,0 +1,6 @@
+import type { ExecutorContext } from 'nx/src/config/misc-interfaces';
+import type { BaseNormalizedExecutorContext } from './types';
+export type NormalizedExecutorContext = BaseNormalizedExecutorContext & {
+    projectName: string;
+};
+export declare function normalizeContext(context: ExecutorContext): NormalizedExecutorContext;

package/src/executors/internal/context.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeContext = void 0;
+function normalizeContext(context) {
+    const { projectName = '', root: workspaceRoot, projectsConfigurations, } = context;
+    return {
+        projectName,
+        projectConfig: projectsConfigurations?.projects[projectName],
+        workspaceRoot,
+    };
+}
+exports.normalizeContext = normalizeContext;
+//# sourceMappingURL=context.js.map

package/src/executors/internal/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/internal/context.ts"],"names":[],"mappings":";;;AAOA,SAAgB,gBAAgB,CAC9B,OAAwB;IAExB,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,IAAI,EAAE,aAAa,EACnB,sBAAsB,GACvB,GAAG,OAAO,CAAC;IACZ,OAAO;QACL,WAAW;QACX,aAAa,EAAE,sBAAsB,EAAE,QAAQ,CAAC,WAAW,CAAC;QAC5D,aAAa;KACd,CAAC;AACJ,CAAC;AAbD,4CAaC"}

package/src/executors/internal/env.d.ts

@@ -0,0 +1,2 @@
+import type { UploadConfig } from '@code-pushup/models';
+export declare function parseEnv(env?: unknown): Partial<UploadConfig>;

package/src/executors/internal/env.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEnv = void 0;
+const zod_1 = require("zod");
+// load upload configuration from environment
+const envSchema = zod_1.z
+    .object({
+    CP_SERVER: zod_1.z.string().url().optional(),
+    CP_API_KEY: zod_1.z.string().min(1).optional(),
+    CP_ORGANIZATION: zod_1.z.string().min(1).optional(),
+    CP_PROJECT: zod_1.z.string().min(1).optional(),
+    CP_TIMEOUT: zod_1.z.string().regex(/^\d+$/).optional(),
+})
+    .partial();
+function parseEnv(env = {}) {
+    const upload = envSchema.parse(env);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return Object.fromEntries(Object.entries(upload).map(([envKey, value]) => {
+        switch (envKey) {
+            case 'CP_SERVER':
+                return ['server', value];
+            case 'CP_API_KEY':
+                return ['apiKey', value];
+            case 'CP_ORGANIZATION':
+                return ['organization', value];
+            case 'CP_PROJECT':
+                return ['project', value];
+            case 'CP_TIMEOUT':
+                return Number(value) >= 0 ? ['timeout', Number(value)] : [];
+            default:
+                return [];
+        }
+    }));
+}
+exports.parseEnv = parseEnv;
+//# sourceMappingURL=env.js.map

package/src/executors/internal/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/internal/env.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAGxB,6CAA6C;AAC7C,MAAM,SAAS,GAAG,OAAC;KAChB,MAAM,CAAC;IACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;CACjD,CAAC;KACD,OAAO,EAAE,CAAC;AAIb,SAAgB,QAAQ,CAAC,MAAe,EAAE;IACxC,MAAM,MAAM,GAAkB,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnD,+DAA+D;IAC/D,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7C,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,WAAW;gBACd,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3B,KAAK,YAAY;gBACf,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3B,KAAK,iBAAiB;gBACpB,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YACjC,KAAK,YAAY;gBACf,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAC5B,KAAK,YAAY;gBACf,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AArBD,4BAqBC"}

package/src/executors/internal/types.d.ts

@@ -0,0 +1,39 @@
+import type { ProjectConfiguration } from 'nx/src/config/workspace-json-project-json';
+/**
+ * Types used in the executor only
+ */
+export type GeneralExecutorOnlyOptions = {
+    dryRun?: boolean;
+};
+/**
+ * executor types that apply for a subset of exector's.
+ * In this case the project related options
+ *
+ */
+export type ProjectExecutorOnlyOptions = {
+    projectPrefix?: string;
+};
+/**
+ * CLI types that apply globally for all commands.
+ */
+export type GlobalExecutorOptions = {
+    bin?: string;
+    verbose?: boolean;
+    progress?: boolean;
+    config?: string;
+};
+/**
+ * CLI types that apply for a subset of commands.
+ * In this case the collection of data (collect, autorun, history)
+ */
+export type CollectExecutorOnlyOptions = {
+    onlyPlugins?: string[];
+};
+/**
+ * context that is normalized for all executor's
+ */
+export type BaseNormalizedExecutorContext = {
+    projectConfig?: ProjectConfiguration;
+} & {
+    workspaceRoot: string;
+};

package/src/executors/internal/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/src/executors/internal/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/executors/internal/types.ts"],"names":[],"mappings":""}