/lerna-audit

Micro util to run npm audit in lerna monorepos

Primary LanguageJavaScript

Lerna Audit

Micro util to run npm audit for lerna packages (with autofix).

How to use

Install

In the root of your lerna monorepo run:

npm i lerna-audit -D

or

yarn add lerna-audit -D

Use

In the root of your lerna monorepo run:

npx lerna-audit [OPTIONS]

Or add a script to your package.json in root:

{
  "scripts"{
    "audit": "lerna-audit"
  }
}

Options

Parameter Default Description
--no-fix false (optional) Do not fix the found vulnerabilities, just audit

Why

Lerna works in a way that it manages "internal" dependencies within your monorepo by managing all relevant npm link commands for you in local development. So you can keep the dependencies to other packages in the monorepo in your package.json while linking the latest versions during development. The downside is that all commands that depend on the dependencies defined in package.jsons will fail because "internal" packages are just linked and not yet published. One of this commands is npm audit because it tires to analyse the dependency tree. lerna-audit mimics the behavior of lerna - removing internal packages from package.json, run the command, restore package.json - to run a npm fix in every lerna managed package.