Lerna をマスターする: JavaScript Monorepos 管理ガイド

目次

1. はじめに
2. 第 1 章: レルナとは何ですか?
   • モノリポを使用する理由
3. 第 2 章: Lerna のインストールとセットアップ
   • 前提条件
   • ステップバイステップのインストール ガイド
   • 最初の Lerna プロジェクトをセットアップする
4. 第 3 章: Lerna での依存関係管理
   • 独立した依存関係
   • 共有依存関係のホイスト
   • パッケージのブートストラップ
5. 第 4 章: パッケージ間でのスクリプトの実行
   • スクリプトをグローバルに実行する
   • 特定のパッケージをターゲットにする
6. 第 5 章: Lerna を使用したバージョニングと公開
   • 固定モードと独立モード
   • npm へのパッケージの公開
7. 第 6 章: Yarn ワークスペースでの Lerna の使用
   • Lerna で Yarn ワークスペースを有効にする
   • Lerna Yarn ワークスペースによるワークフローの最適化
8. 第 7 章: Lerna の高度な使用法
   • コマンドのフィルタリング
   • カスタム コマンドの作成
9. 第 8 章: Lerna Monorepos のベスト プラクティス
   • 論理パッケージ構成
   • テストとビルドの自動化
   • CI/CD 統合
10. 結論
11. 付録: 一般的な Lerna コマンド

はじめに

複数の相互依存パッケージを含む大規模な JavaScript または TypeScript プロジェクトの管理は、開発者や開発チームにとって大きな課題となる可能性があります。多くの場合、開発者はパッケージごとに複数のリポジトリに依存するため、コードのメンテナンス、依存関係の管理、コラボレーションの点でオーバーヘッドが発生します。

Lerna は、モノリポス を管理するために開発された強力なツールで、このプロセスを合理化します。 Monorepos を使用すると、チームが単一のリポジトリで複数のパッケージをホストできるようになり、依存関係の管理が簡素化され、チーム間のコラボレーションがよりスムーズになります。

この電子ブックは、Lerna を使用してモノリポジトリを効率的に管理するための完全なガイドを提供することを目的としています。コンポーネント ライブラリを扱う場合でも、複数の相互接続されたパッケージを含む大規模プロジェクトを扱う場合でも、Lerna を使用すると生産性を最大化するのに役立つ貴重な洞察が得られます。

第 1 章: レルナとは何ですか?

Lerna は、モノリポ 内の複数のパッケージの管理を容易にするオープンソース ツールです。自動依存関係管理、バージョン管理、公開などの強力な機能を提供し、大規模な JavaScript および TypeScript プロジェクトの保守を容易にします。

モノリポを使用する理由

Monorepos にはいくつかの利点があるため、多くの大規模プロジェクトにとってアーキテクチャ上の選択肢となります。

• 共有コードベース: モノリポジトリを使用すると、コードの再利用が簡単になります。これにより重複が減り、プロジェクト間の一貫性が確保されます。
• コラボレーションの簡素化: すべてのパッケージが 1 か所にあると、開発者はより効率的に共同作業できます。
• 統合ビルド プロセス: 複数のパッケージにわたるビルド、テスト、展開の標準化が容易になります。

これらの利点にもかかわらず、モノリポジトリの管理には、特に依存関係とバージョン管理の管理において特有の課題が生じる可能性があります。 Lerna はこれらの課題に正面から取り組むように設計されており、モノリポジトリに最適化されたワークフローを提供します。

第 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 プロジェクトでは、各パッケージはパッケージの下の独自のサブフォルダーに存在します。各パッケージには、依存関係を管理するための独自の 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 モノリポジトリを初期化します。
• lerna bootstrap: 依存関係をインストールし、パッケージをリンクします。
• lerna add [package] --scope=[package-name]: 特定のパッケージに依存関係を追加します。
• lerna run [script]: すべてのパッケージにわたってスクリプトを実行します。
• lerna public: パッケージを npm に公開します。

コーディングを楽しんでください:)

以上がLerna をマスターする: JavaScript Monorepos 管理ガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。