Lerna-Lite is a super light version of the original Lerna
- About Lerna-Lite
- Why create this lib/fork?
- See it in Action
- README Badge
- Installation
lerna.jsonconfig file- Migration for Lerna users
- Troubleshooting
- Commands
Lerna-Lite differs from the original Lerna in the sense that it only includes 3 commands (1 is optional) out of 15 commands that the original Lerna has. It also assume that you have already setup a Workspace through NPM, Yarn or any other technology that will take care of the symlinks (Lerna-Lite does not include the bootstrap command hence the need for a pre-setup workspace), so make sure that your workspace is properly setup before installing Lerna-Lite.
Mainly for the following reasons:
- the original Lerna is no longer maintained (dependencies are out of date)
- create a lighter lib that still provide Lerna's approach of Versioning and Publishing by following the Conventional Commits and also automatically create Conventional-Changelog for each package of the workspace. We don't need all packages of Lerna anymore since NPM Workspaces (or other technologies) came out.
- add some little extras while keeping the lib small.
- the lib is smaller because we only copied 3 out of 15 commands from Lerna
- rewrite the lib with TypeScript
- Automate the rolling of new Versions (
independentorfixed) for all your workspace packages- it will automatically add Commit & Tag your new Version in Git & create new GitHub or GitLab Release when enabled
- Automate the creation of Changelogs for all your packages by reading all Conventional Commits
- each package will get its own changelog and a combined changelog will also be created in the root
- Automate the repository Publish of your new versions for all your packages (NPM or other platform)
Run command (optional)
- Run is an optional package that will help you run npm script in parallel and in topological order.
| Package Name | Version | Description | Changes |
|---|---|---|---|
| @lerna-lite/cli |  |
Lerna-Lite Version/Publish comands CLI | changelog |
| @lerna-lite/core | |
Lerna-Lite core & shared methods | changelog |
| @lerna-lite/publish |  |
Publish packages in the current workspace | changelog |
| @lerna-lite/run |  |
Run command and CLI to run npm scripts in the workspace | changelog |
| @lerna-lite/version |  |
Bump Version & write Changelogs | changelog |
You want to see a demo project? Sure, you're looking at it 😉
Yes indeed, this lib was created as an NPM Workspace specifically for the purpose of demoing and testing of its own code. All changelogs and published versions were created by the lib itself, how sweet is that? You will also find that it has its own lerna.json config file just as well as you would when using the lib.
You can see a small video of a new version release on this Release Demo - Wiki - Confused with all the options? Consult the multiple links below.
- Release Demo - Wiki - Lerna-Lite demo (animated gif)
- How to Use Lerna - YouTube video
- Lerna Release Workflow - GitHub Template
Using Lerna-Lite? Add a README badge to show it off:
[](https://github.com/ghiscoding/lerna-lite)Run the following commands to install Lerna-Lite in your project and/or install it globally once with the -g option.
| Command | Install | Description | Included |
|---|---|---|---|
| 📑 version | npm install @lerna-lite/cli |
create new version for each workspace package | Yes |
| ✉️ publish | npm install @lerna-lite/cli |
publish each workspace package | Yes |
| 🏃 run | npm install @lerna-lite/run |
run npm script in each workspace package | Optional |
Note: the default lerna CLI is only including 2 built-in commands (publish and version), while the (run) command is optional and must be installed separately as shown below.
# Lerna CLI which includes `publish`, `version` commands
npm install @lerna-lite/cli # OR yard add @lerna-lite/cli
# install optional `run` command
npm install @lerna-lite/run # OR yarn add @lerna-lite/runAdd custom NPM Scripts or simply run the commands in a shell with Lerna-Lite CLI.
// package.json / npm scripts
"scripts": {
"new-version": "lerna version",
"new-publish": "lerna publish from-package",
"run-tests": "lerna run test", // optional `run` command
}You could configure and run Lerna in 3 different ways:
- via a
lerna.jsonfile - via a
"lerna": {}property directly under yourpackage.json - or by passing arguments directly directly in the shell when executing the command.
You can find more info by reading about the lerna.json - Wiki.
Migration for Lerna Users
If you are migrating from Lerna, it should be fairly easy to just replace Lerna with Lerna-Lite in your dependencies and that's about it, the CLI commands are the same, take a look at the quick steps shown below:
- remove Lerna from your local & global dependencies
npm uninstall lerna # OR yarn remove lerna
npm uninstall -g lerna # OR yarn global remove lerna- install Lerna-Lite CLI to get
versionandpublishcommandsruncommand is optional and can be installed separately as shown below
# Lerna CLI (`version` & `publish` commands)
npm install @lerna-lite/cli
# install optional `run` command
npm install @lerna-lite/runIf you wish to contribute to the project, please follow these steps
- clone the lib:
git clone https://github.com/ghiscoding/lerna-lite
- install with NPM:
npm install
- run a TypeScript (TSC) build
npm run build
- add/run Jest unit tests (make sure to run the previous step first):
npm run jest # OR npm run jest:watch
- you can troubleshoot/debug the code via the VSCode debugger launch configs that were setup
Feel free to contribute any Pull Request, PRs are very welcome. 👷👷♀️
Also please note that I'm just a simple developer & user of this lib, the same as you are, my knowledge of the library is also probably similar to yours but together we can make it better (and lighter).
If you have problems running the lib and your problems are related to Git commands that were executed, then we suggest to first try with the --git-dry-run option to see if it helps in finding the error(s) you may have. Another great, and possibly much more useful suggestion, is to search in the original Lerna issues list and see if any solution could help you (remember that Lerna-Lite is a fork of the original code from Lerna and it works the same way). Lastly, if that is not enough and you wish to troubleshoot yourself, then read this Troubleshooting - Wiki to possibly troubleshoot yourself in your own environment.