Lerna support

Detector properties

The Lerna detector will register in the presence of a lerna.json file.

It will then execute a lerna command to retrieve all the packages defined in the project.

Each package has a location within the project structure.

It is expected to find a package.json and some type of lock file. Supported lockfile types are package-lock.json, npm-shrinkwrap.json, and yarn.lock.

If no lockfile is present in the package, it will be assumed that all the dependencies defined within the package's package.json file will be resolved in the lockfile at the root of the project. If no lockfile is present at the root of the project, Lerna extraction will fail.

The Lerna detector will execute the same code as the NPM package lock detector.

The NPM package lock detector related properties also apply.

Since the Lerna detector is currently not using the NPM Cli, the only property that applies is detect.npm.dependency.types.excluded.

The Lerna detector will execute the same code as the NPM shrinkwrap detector.

The NPM shrinkwrap detector related properties also apply.

Since the Lerna detector is currently not using the NPM Cli, the only property that applies is detect.npm.dependency.types.excluded.

The Lerna detector will execute the same code as the Yarn detector.

The Yarn detector related properties also apply.

Yarn workspaces are not currently supported by the Lerna detector.

With the detect.lerna.package.types.excluded property, users can specify whether or not to include private packages as defined by Lerna.

Detect executes commands against the Lerna executable to determine package information.

Detect will attempt to find the Lerna executable, but if the user wishes to override the executable Detect uses, they can supply a path to the executable using detect.lerna.path

The Lerna detector includes/excludes Lerna packages found when it runs lerna ls --all --json as specified by detect.lerna.packages.included and detect.lerna.packages.excluded.