You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`projects`|`string[] \| null`|`null`| Custom projects configuration for [monorepo mode](#monorepo-mode)|
101
101
|`task`|`string`|`'code-pushup'`| Name of command to run Code PushUp per project in [monorepo mode](#monorepo-mode)|
102
-
|`nxProjectsFilter`|`string \| string[]`|`'--with-target={task}'`| Arguments passed to [`nx show projects`](https://nx.dev/nx-api/nx/documents/show#projects), only relevant for Nx in [monorepo mode](#monorepo-mode)[^3]|
102
+
|`nxProjectsFilter`|`string \| string[]`|`'--with-target={task}'`| Arguments passed to [`nx show projects`](https://nx.dev/nx-api/nx/documents/show#projects), only relevant for Nx in [monorepo mode](#monorepo-mode)[^2]|
103
103
|`directory`|`string`|`process.cwd()`| Directory in which Code PushUp CLI should run |
104
104
|`config`|`string \| null`|`null`[^1]| Path to config file (`--config` option) |
105
105
|`silent`|`boolean`|`false`| Toggles if logs from CLI commands are printed |
106
106
|`bin`|`string`|`'npx --no-install code-pushup'`| Command for executing Code PushUp CLI |
107
107
|`detectNewIssues`|`boolean`|`true`| Toggles if new issues should be detected and returned in `newIssues` property |
108
108
|`logger`|`Logger`|`console`| Logger for reporting progress and encountered problems |
109
-
|`output`|`string`|`'.code-pushup'`| Directory where Code PushUp reports will be created (interpolates project name [^2]) |
110
109
111
110
[^1]: By default, the `code-pushup.config` file is autodetected as described in [`@code-pushup/cli` docs](../cli/README.md#configuration).
112
111
113
-
[^2]: In monorepo mode, any occurrence of `{project}` in the `output` path will be replaced with a project name. This separation of folders per project (e.g. `output: '.code-pushup/{project}'`) may be useful for caching purposes.
114
-
115
-
[^3]: The `{task}` pattern is replaced with the `task` value, so the default behaviour is to list projects using `npx nx show projects --with-target=code-pushup --json`. The `nxProjectsFilter` options gives Nx users the flexibility to filter projects in alternative ways supported by the Nx CLI (e.g. `--affected`, `--projects`, `--exclude`, `--type`) - refer to [options in Nx docs](https://nx.dev/nx-api/nx/documents/show#options) for details.
112
+
[^2]: The `{task}` pattern is replaced with the `task` value, so the default behaviour is to list projects using `npx nx show projects --with-target=code-pushup --json`. The `nxProjectsFilter` options gives Nx users the flexibility to filter projects in alternative ways supported by the Nx CLI (e.g. `--affected`, `--projects`, `--exclude`, `--type`) - refer to [options in Nx docs](https://nx.dev/nx-api/nx/documents/show#options) for details.
116
113
117
114
The `Logger` object has the following required properties:
0 commit comments