pnpm-{audit, outdated}: add page (#12437)

* feat: add pnpm audit commands and fix tldr-lint errors

* feat: add pnpm outdated commands and fix tldr-lint errors

* feat(pnpm-audit): add severity level of vulnerabilities option

* fix: improve general description based on tldr style-guide

* fix(pnpm-audit): improve general writing

* fix: resolve code review suggestion

* fix: apply code review suggestion of @kbdharun
pull/23/head
Mouaz Aldakkak 2024-03-03 10:45:44 +01:00 committed by GitHub
parent 611b8902a9
commit cca1c921b4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 74 additions and 0 deletions

View File

@ -0,0 +1,37 @@
# pnpm audit
> Scan project dependencies.
> Check for known security issues with the installed packages.
> More information: <https://pnpm.io/cli/audit>.
- Identify vulnerabilities in the project:
`pnpm audit`
- Automatically fix vulnerabilities:
`pnpm audit fix`
- Generate a security report in JSON format:
`pnpm audit --json > {{path/to/audit-report.json}}`
- Audit only [D]ev dependencies:
`pnpm audit --dev`
- Audit only [P]roduction dependencies:
`pnpm audit --prod`
- Exclude optional dependencies from the audit:
`pnpm audit --no-optional`
- Ignore registry errors during the audit process:
`pnpm audit --ignore-registry-errors`
- Filter advisories by severity (low, moderate, high, critical):
`pnpm audit --audit-level {{severity}}`

View File

@ -0,0 +1,37 @@
# pnpm outdated
> Check for outdated packages.
> The check can be limited to a subset of the installed packages by providing arguments (patterns are supported).
> More information: <https://pnpm.io/cli/outdated>.
- Check for outdated packages:
`pnpm outdated`
- Check for outdated dependencies found in every workspace package:
`pnpm outdated -r`
- Filter outdated packages using a package selector:
`pnpm outdated --filter {{package_selector}}`
- List outdated packages [g]lobally:
`pnpm outdated --global`
- Print details of outdated packages:
`pnpm outdated --long`
- Print outdated dependencies in a specific format:
`pnpm outdated --format {{format}}`
- Print only versions that satisfy specifications in `package.json`:
`pnpm outdated --compatible`
- Check only outdated [D]ev dependencies:
`pnpm outdated --dev`