掌握 Lerna：管理 JavaScript Monorepos 的指南

目錄

1. 簡介
2. 第一章：Lerna 是什麼？
   • 為什麼選擇 Monorepos？
3. 第 2 章：安裝與設定 Lerna
   • 先決條件
   • 分步安裝指南
   • 設定您的第一個 Lerna 項目
4. 第 3 章：Lerna 中的依賴關係管理
   • 獨立依賴
   • 提升共享相依性
   • 引導包
5. 第 4 章：跨套件執行腳本
   • 全域執行腳本
   • 針對特定包
6. 第 5 章：使用 Lerna 進行版本控制與發布
   • 固定模式與獨立模式
   • 將包裝發佈到 npm
7. 第 6 章：將 Lerna 與 Yarn 工作區結合使用
   • 在 Lerna 中啟用 Yarn 工作區
   • 使用 Lerna Yarn 工作區最佳化工作流程
8. 第 7 章：Lerna 高階用法
   • 過濾指令
   • 建立自訂指令
9. 第 8 章：Lerna Monorepos 的最佳實踐
   • 邏輯包組織
   • 自動化測試與建置
   • CI/CD 整合
10. 結論
11. 附錄：常用 Lerna 指令

---

簡介

管理涉及多個相互依賴的套件的大型 JavaScript 或 TypeScript 專案對於開發人員和開發團隊來說可能是一項重大挑戰。通常，開發人員依賴每個套件的多個儲存庫，這會導致程式碼維護、依賴項管理和協作方面的開銷。

Lerna 是一個為管理 monorepos 開發的強大工具，它簡化了這個過程。 Monorepos 使團隊能夠在單一儲存庫中託管多個套件，從而簡化依賴關係管理並使團隊之間的協作更加順暢。

這本電子書旨在提供使用 Lerna 有效管理您的 monorepos 的完整指南。無論您處理的是元件庫還是具有多個互連套件的大型項目，您都會發現有價值的見解，幫助您透過 Lerna 最大限度地提高生產力。

---

第一章：Lerna 是什麼？

Lerna 是一個開源工具，有助於管理 monorepo 中的多個套件。它提供了自動依賴管理、版本控制和發布等強大功能，使大規模維護 JavaScript 和 TypeScript 專案變得更加容易。

為什麼選擇 Monorepos？

Monorepos 是許多大型專案的架構選擇，因為它們提供了多種好處：

• 共享程式碼庫：使用 monorepos，程式碼重複使用更容易。這減少了重複並確保項目之間的一致性。
• 簡化協作：當所有套件都集中在一個地方時，開發人員可以更有效地協作。
• 統一建置流程：跨多個套件的標準化建置、測試和部署變得更加容易。

儘管有這些好處，管理單一儲存庫也會帶來獨特的挑戰，特別是在管理依賴項和版本控制方面。 Lerna 旨在正面應對這些挑戰，為 monorepos 提供最佳化的工作流程。

---

第 2 章：安裝與設定 Lerna

先決條件

開始之前，請確保您已安裝 Node.js 和 npm（或 Yarn）。 Lerna 與 npm 和 Yarn 相容。

第 1 步：安裝 Lerna

您可以透過 npm 在全域安裝 Lerna：

npm install --global lerna

或者，您可以將 Lerna 新增為專案中的開發依賴項：

npm install --save-dev lerna

第 2 步：初始化 Lerna Monorepo

安裝後，透過導航到專案目錄並運行來初始化您的 monorepo：

lerna init

這將創建必要的配置文件，包括 lerna.json，並設置一個包文件夾來存放您的各個包。

第 3 步：新增套件

在 Lerna 專案中，每個套件都位於 packages 下自己的子資料夾中。每個套件必須有自己的 package.json 檔案用於依賴管理。

範例結構：

/my-project
  /packages
    /package-a
    /package-b
  lerna.json
  package.json

---

Chapter 3: Dependency Management in Lerna

Managing dependencies across multiple packages is one of Lerna’s core strengths.

Independent Dependencies

Lerna allows you to add dependencies to a specific package. For example, if only package-a needs lodash, you can run:

lerna add lodash --scope=package-a

Hoisting Shared Dependencies

When multiple packages share dependencies, you can hoist those dependencies to the root of your monorepo. This reduces redundancy and speeds up installations. To enable hoisting, add this to lerna.json:

{
  "hoist": true
}

Bootstrapping

To install dependencies and link packages that depend on one another, run:

lerna bootstrap

This ensures that all necessary external dependencies are installed and that packages can reference each other properly.

---

Chapter 4: Running Scripts Across Packages

Lerna makes it easy to execute scripts (e.g., build, test, lint) across all packages in your monorepo.

Executing Scripts Globally

To run a script like build across all packages, use:

lerna run build

Targeting Specific Packages

If you only want to run a script in certain packages, use the --scope flag:

lerna run test --scope=package-a

This flexibility allows for more targeted execution, saving time during development.

---

Chapter 5: Versioning and Publishing with Lerna

Lerna provides robust versioning and publishing features, allowing you to easily version and release packages.

1. Fixed Mode

In fixed mode, all packages share the same version number. When any package is updated, the version number is incremented for all.

2. Independent Mode

In independent mode, each package has its own version number. When a package is changed, only that package’s version is updated.

To switch to independent mode, modify lerna.json:

{
  "version": "independent"
}

Publishing Packages

To publish your packages to npm, run:

lerna publish

Lerna will handle versioning and publishing based on your configuration.

---

Chapter 6: Using Lerna with Yarn Workspaces

Combining Lerna with Yarn Workspaces can further optimize dependency management by hoisting even more shared dependencies.

To enable Yarn Workspaces, modify your lerna.json file:

{
  "npmClient": "yarn",
  "useWorkspaces": true
}

Then update your package.json:

{
  "workspaces": ["packages/*"]
}

This integration boosts performance and simplifies managing large-scale projects.

---

Chapter 7: Advanced Lerna Usage

Filtering Commands

Lerna allows filtering to run commands for specific packages or to exclude certain packages.

Example for running on specific packages:

lerna run build --scope=package-a --scope=package-b

Example for excluding packages:

lerna run build --ignore=package-c

Custom Commands

You can define custom Lerna commands within package.json for specialized workflows. These commands can then be run across your packages.

---

Chapter 8: Best Practices for Lerna Monorepos

1. Organize Packages Logically: Group related packages together for better code reuse.
2. Use Hoisting: Hoisting shared dependencies saves space and speeds up install times.
3. Automate Testing: Use lerna run to automate testing across your entire monorepo.
4. CI/CD Pipelines: Implement continuous integration and deployment workflows to automatically test and deploy changes.
5. Yarn Workspaces: Leverage Yarn Workspaces with Lerna for better dependency management.

---

Conclusion

Lerna is an invaluable tool for managing monorepos, offering features that simplify complex workflows, from dependency management to versioning and publishing. By adopting Lerna, teams can reduce complexity, streamline processes, and improve collaboration, making it easier to maintain large-scale projects.

Whether you’re working on a simple component library or a multi-package ecosystem, Lerna provides the tools needed to manage your project effectively. Keep experimenting with Lerna’s advanced features to unlock its full potential.

---

附錄：常用 Lerna 指令

• lerna init：初始化 Lerna monorepo。
• lerna bootstrap：安裝依賴項和連結包。
• lerna add [package] --scope=[package-name]：增加對特定套件的依賴。
• lerna run [script]：在所有套件中執行腳本。
• lernapublish：將包裝發佈到 npm。

---

快樂編碼:)

以上是掌握 Lerna：管理 JavaScript Monorepos 的指南的詳細內容。更多資訊請關注PHP中文網其他相關文章！