Lerna-script-tasks-dependencies NPM

lerna-script-tasks-dependencies

lerna-script tasks for managing dependency versions across lerna repo.

install

npm install --save-dev lerna-script-tasks-dependencies

Usage

TBD

const {extraneous, unmanaged, sync, latest} = require('lerna-script-tasks-dependencies');

module.exports['deps:sync'] = sync();
module.exports['deps:extraneous'] = extraneous();
module.exports['deps:unmanaged'] = unmanaged();
module.exports['deps:latest'] = latest();

API

sync({packages})(log): Promise

Task that syncs dependency versions (dependencies, devDependencies, peerDependencies) with those defined in lerna.json as managed*Dependencies.

Parameters:

packages - custom package list, or defaults as defined by lerna.json
log - npmlog instance passed-in by lerna-script;

Say you have lerna.json in root of your project like:

{
  "managedDependencies": {
    "lodash": "~1.0.0"
  }
}

upon invocation of this task for all submodules that have lodash defined in dependencies or devDependencies version of lodash will be updated to ~1.0.0.

unmanaged({packages})(log): Promise

List dependencies, that are present in modules dependencies, devDependencies, peerDependencies, but not defined in lerna.json as managed*Dependencies.

Parameters:

packages - custom package list, or defaults as defined by lerna.json
log - npmlog instance passed-in by lerna-script;

extraneous({packages})(log): Promise

List dependencies, that are present in lerna.json as managed*Dependencies, but not defined in modules dependencies, devDependencies, peerDependencies.

Parameters:

packages - custom package list, or defaults as defined by lerna.json
log - npmlog instance passed-in by lerna-script;

latest({addRange, silent})(log): Promise

List dependencies, that are present in lerna.json as managed*Dependencies and needs updating based on latest version published in npmjs.org. The lerna.json can contain the following autoSelect rules which will automatically mark the relevant packages as selected

{
  "managedDependencies": {
    "lodash": "~1.0.0",
    "dontUpdateMe": "3.0.5"
  },
  "autoselect": {
    "versionDiff": ["minor", "patch"],
    "exclude": ["dontUpdateMe"]
  }
}

In the above example, if a minor or a patch update is found for one of the packages, they will be selected by default unless the package name is dontUpdateMe

Parameters:

addRange - when updating version in lerna.json to add range operator ('~', '^', ...). By default it sets fixed version.
silent - does not prompt with the list of dependencies and automatically updates auto-selected packages versions in the lerna.json file
log - npmlog instance passed-in by lerna-script;