Skip to content

Commit f4ad1e0

Browse files
authored
docs(plugin-eslint): adopt docs (#452)
1 parent d8af7b4 commit f4ad1e0

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

packages/plugin-eslint/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,11 @@ Detected ESLint rules are mapped to Code PushUp audits. Audit reports are calcul
8181
};
8282
```
8383

84-
5. (Optional) Reference audits (or groups) which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
84+
5. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
85+
86+
### Optionally set up categories
87+
88+
1. Reference audits (or groups) which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
8589

8690
Assign weights based on what influence each ESLint rule should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
8791
Note that categories can combine multiple plugins.
@@ -174,4 +178,8 @@ Detected ESLint rules are mapped to Code PushUp audits. Audit reports are calcul
174178
};
175179
```
176180

177-
6. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
181+
2. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
182+
183+
## Nx Monorepo Setup
184+
185+
Find all details in our [Nx setup guide](https://github.com/code-pushup/cli/wiki/Code-PushUp-integration-guide-for-Nx-monorepos#eslint-config).

0 commit comments

Comments
 (0)