Skip to content

Commit

Permalink
Update packages/plugin-doc-coverage/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
  • Loading branch information
aramirezj and BioPhoton authored Dec 23, 2024
1 parent 49e5b56 commit 54d1621
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/plugin-doc-coverage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Measured documentation types are mapped to Code PushUp audits in the following w
pnpm add --save-dev @code-pushup/doc-coverage-plugin
```

3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.js`).
3. Add this plugin to the `plugins` array in your Code PushUp CLI config file (e.g. `code-pushup.config.ts`).

Pass the target files to analyze and optionally specify which types of documentation you want to track.
You can skip for example tests by defining in the sourceGlob the path to the tests folder or pattern to match the tests files with the `!` symbol.
Expand Down

0 comments on commit 54d1621

Please sign in to comment.