Lerna 入门小教程

2024-02-23 21:55:58

在前端开发领域，我们经常会遇到需要开发和维护多个JavaScript项目的场景。这些项目之间可能存在相互依赖的关系，例如一个UI组件库被多个应用程序使用。这时，如果我们手动管理这些项目的依赖、构建和发布流程，将会非常繁琐且容易出错。为了解决这个问题，我们可以使用Lerna——一个强大的工具，专门用于管理包含多个package的JavaScript项目。

Lerna的核心思想是将一个大型的代码库拆分成多个独立的package，这些package可以存放在同一个代码仓库中，也可以存放在不同的代码仓库中。Lerna提供了一系列命令，帮助我们管理这些package之间的依赖关系、执行构建、测试和发布等操作。

Lerna如何工作？

Lerna通过两种模式来管理package：

Fixed/Locked mode (默认模式): 在这种模式下，所有package的版本号都保持一致。当我们发布一个新的版本时，所有package的版本号都会更新到相同的版本。这种模式适用于package之间存在强依赖关系，并且需要保持版本同步的场景。
Independent mode: 在这种模式下，每个package可以拥有独立的版本号。当我们发布一个新的版本时，只有被修改过的package的版本号才会更新。这种模式适用于package之间依赖关系较弱，或者需要独立发布版本的场景。

使用Lerna的步骤

安装Lerna:
我们可以使用npm或yarn全局安装Lerna:
```
npm install -g lerna
```
初始化项目:
在项目根目录下执行以下命令，初始化一个Lerna项目:
```
lerna init
```
这将会创建一个 lerna.json 文件和 packages 文件夹。lerna.json 文件用于配置Lerna的各种选项，而 packages 文件夹用于存放各个package。
创建package:
我们可以使用 lerna create 命令创建新的package:
```
lerna create my-package
```
这将会在 packages 文件夹下创建一个名为 my-package 的新package，并引导我们设置package的名称、版本号、等信息。
管理依赖:
Lerna提供了一系列命令来管理package之间的依赖关系。例如，我们可以使用 lerna add 命令将一个package添加到另一个package的依赖中:
```
lerna add my-package --scope=my-app 
```
这将会将 my-package 添加到 my-app package的依赖中。
执行命令:
Lerna可以帮助我们批量地在各个package中执行命令。例如，我们可以使用 lerna run 命令在所有package中执行 build 命令:
```
lerna run build
```
发布package:
Lerna可以帮助我们批量地发布package到npm或其他registry。例如，我们可以使用 lerna publish 命令发布所有被修改过的package:
```
lerna publish
```

Lerna的优势

简化多package项目的管理： Lerna提供了一个统一的工具来管理多个package，避免了手动管理的繁琐和容易出错。
提高开发效率： Lerna可以帮助我们批量地执行命令、管理依赖和发布package，从而提高开发效率。
促进代码复用： Lerna鼓励我们将代码拆分成独立的package，从而促进代码复用。

Lerna的局限性

学习曲线： Lerna的学习曲线相对较高，需要花费一定的时间来学习和掌握。
不适用于所有项目： Lerna更适合于包含多个相互依赖的package的项目，对于一些简单的项目，使用Lerna可能会显得过于复杂。

常见问题

如何升级所有package的版本号？

可以使用 lerna version 命令来升级所有package的版本号。Lerna会自动检测哪些package被修改过，并提示我们选择合适的版本号更新策略。
如何解决package之间的循环依赖问题？

Lerna不允许package之间存在循环依赖。如果出现循环依赖，我们需要重新设计package的结构，消除循环依赖。
如何使用Lerna管理私有package？

Lerna可以与私有npm registry一起使用，例如Verdaccio或Nexus。我们需要在 lerna.json 文件中配置registry的地址，并在发布package时指定 --registry 参数。
如何调试Lerna项目？

我们可以使用 lerna run 命令在单个package中执行调试命令，例如 npm run debug 或 yarn debug。
如何处理Lerna项目中的冲突？

当多个开发者同时修改同一个package时，可能会出现冲突。我们可以使用Git的合并工具来解决冲突。