Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@netly/npm-audit-markdown

DmytroMysak1.6kMIT1.2.0

Generate a markdown report for NPM Audit

npm audit, npm audit markdown, npm audit markdown report

readme

@netly/npm-audit-markdown

A simple tool to create an NPM audit report in markdown language. Especially useful to post reports to communicators supporting markdown. Just make more suitable for CI

Getting Started

`bash script npm install -g @netly/npm-audit-markdown


## Usage

To generate a report, run the following:

```bash script
npm audit --json | @netly/npm-audit-markdown

By default the report will be saved to npm-audit.md

If you want to specify the output file, add the --output option:

`bash script npm audit --json | @netly/npm-audit-markdown --output report.md


## CI

```bash script
npm audit --json | npx @netly/npm-audit-markdown --output report.md

Acknowledgements

Forked from https://gitlab.com/engrave/npm-audit-markdown

Licence

MIT

changelog

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.2.0 (2023-07-14)

Features

  • readable: improve readable style from tty (9a16b63)

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.1.1 (2023-07-14)

Bug Fixes

  • package: fixed command execution (d526651)

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.1.0 (2023-07-14)

Features

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.3 (2023-07-14)

Bug Fixes

  • package: fixed command name in package-lock.json (9909575)

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.2 (2023-07-14)

Bug Fixes

  • package.json: fixed command execution name (96a9cc9)

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.1 (2023-07-14)

Bug Fixes

📓 Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0 (2023-07-14)

Features

  • init: added @netly/npm-audit-markdown (3306c5d)