@hutson/lerna-config

Standard lerna configuration as used by projects maintained by Hutson Betts (@hutson).

Configuration package for the lerna mono-repository management tool using its support for loading configuration from an npm package.

Table of Contents

• Features
• Installation
• Usage
• Node Support Policy
• Contributing

Features

• [x] Hoist common packages to the project's top-level package.json file.
• [x] Use yarn as the package manager instead of the default npm package manager.
• [x] Configure lerna to expect all packages in the mono-repository to be located within the packages/ directory.
• [x] Configure lerna to version each package in the mono-repository independently.

Installation

To install the @hutson/lerna-config configuration package for use in your project please run the following command:

yarn add --dev @hutson/lerna-config

Usage

Extend this package in the mono-repository's top-level lerna.json file:

{
  "extends": "@hutson/lerna-config"
}

Node Support Policy

We only support Long-Term Support versions of Node.

We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.

It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.

As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.

We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.

JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.

Contributing

Please read our contributing guide to see how you may contribute to this project.