首页 > 其他分享 >大型项目管理神器:掌握yarn monorepo的安装和使用

大型项目管理神器:掌握yarn monorepo的安装和使用

时间:2024-03-30 11:59:27浏览次数:35  
标签:依赖 workspaces 项目 项目管理 代码 yarn monorepo

I. 引言

在当今的前端开发中,由于项目规模的不断增长和多团队协同,Monorepo成为了越来越流行的开发模式。Monorepo指的是将多个相关项目或者模块打包在一起的软件开发模式,它可以让开发人员更好地组织管理代码,减少重复的代码,提高可复用性和开发效率。在前端开发中,使用yarn monorepo能够更好地管理依赖和代码的复用,符合现代Web应用程序开发的趋势。

本文将介绍yarn monorepo的概念和应用场景,并通过实例详细介绍yarn monorepo的安装和使用方法。本文的写作目标主要有以下几点:

1. 帮助读者了解什么是yarn monorepo以及其在前端开发中的作用。
2. 具体介绍如何安装和配置yarn monorepo,包括创建一个新的monorepo、向monorepo中添加包等基本操作的指南。
3. 深度讲解如何管理yarn monorepo中的依赖关系,如何管理yarn monorepo中的库和应用程序以及如何通过monorepo打包部署应用程序等实践操作。
4. 为读者提供实用的建议和技巧,在项目开发过程中更好地使用yarn monorepo。
总之,本文旨在帮助读者了解和掌握yarn monorepo的基本原理和实用技巧,让读者能够更加高效地管理项目中的代码和依赖,从而更好地开发出高质量的Web应用程序。

II. 什么是yarn monorepo

1. 定义

yarn monorepo是一种Monorepo(单仓库)的代码组织方式,通过一个仓库管理多个相关的项目或库,这些项目或库可以是应用程序、库模块、组件等。在monorepo中,项目之间共享相同的代码库,可以实现更高效的代码复用和管理。

2. 特点

(1)便于管理: yarn monorepo中多项目可以共享相同代码库,避免了多个代码库之间不必要的重复。

(2)更好的可维护性: yarn monorepo可以让开发人员更专注于代码,而不是仓库结构、依赖管理等问题。

(3)精简依赖: yarn monorepo依赖管理只需一份,避免了多份依赖库引起的冲突,也避免了多次相同的依赖安装。

(4)更高的可扩展性: yarn monorepo能够随着项目的增长进行扩展,无论是新增项目还是新增业务特性,都可以更加高效地管理。

3. 与其他包管理器的区别

yarn monorepo是一种比较新的Monorepo模式,相较于其他包管理器,它有以下区别:

(1)yarn monorepo可以使用yarn workspaces实现对多个项目或库的管理,而npm和yarn使用linking作为管理方式。

(2)yarn monorepo能够更好地管理代码复用和依赖,由于项目共享代码库,依赖管理更为精简。

(3)yarn monorepo能够更好地管理多个项目之间的相互依赖关系,从而减少重复代码,避免出现冲突和错误。

总之,yarn monorepo作为一个Monorepo模式的代表,它具有更好的管理、可维护性、精简依赖和可扩展性等优势,适合于管理复杂的前端项目或者多个库模块。

III. yarn monorepo的优点和应用场景

1. 优点

(1)减少重复:yarn monorepo可以实现代码复用,让不同项目共享相同的代码库,减少重复编写代码的问题。

(2)便于管理:yarn monorepo能够更好地管理多个项目或模块之间的依赖关系,避免依赖管理冲突的问题。

(3)统一管理: yarn monorepo可以实现统一的依赖管理,同时也可以实现包括构建、测试、发布等操作的自动化集成,统一管理不同项目的开发流程。

(4)维护过程更为简洁: yarn monorepo只需要一个代码库和一个该仓库下的自插件,使维护过程更为简洁明了。

(5)提高开发效率:yarn monorepo极大的化简了繁琐的代码管理流程,优化了代码依赖关系的管理,从而可以提高整个开发过程的效率。

2. 应用场景

(1)多项目共存管理: 对于多个相关的项目,如各模块的功能块、拆分的前端应用程序和后端服务等,可以使用yarn monorepo进行管理。

(2)不同应用程序的多个版本: 对于不同版本的同一应用程序,可以使用yarn monorepo进行管理,可以保证项目中所有相关的应用的版本都保持一致。

(3)多个库模块共存使用: 对于多个库模块,可以使用yarn monorepo管理,让不同项目共享相同的代码库,减少代码复制的问题。

总之,yarn monorepo适用于管理庞大、多项目或者多库模块的前端项目,可以提高代码复用、减少重复代码和依赖管理冲突等管理问题,同时也可以提高整个开发过程的效率。无论是对于大型应用,还是对于团队协作等场景,使用yarn monorepo都可以让开发过程更加简单和高效。

IV. 安装 yarn monorepo

1. yarn monorepo的安装方法

yarn mon ore po是yarn的扩展,是一个针对monorepo模式的包管理工具。yarn本身可以执行替代npm的操作,并提供了更好的性能和功能。为了安装yarn monorepo,需要先安装yarn:

全局安装yarn命令:

shell
npm install -g yarn

由于yarn monorepo并不是yarn的默认功能,因此我们需要安装yarn workspaces插件。这可以通过使用以下命令来安装:

yarn global add workspaces

2. 全局和本地安装的优缺点

全局安装yarn monorepo可以让您在任何地方使用它,无论在哪里都可以使用此插件。然而,这种方法通常需要使用sudo权限,可能会影响您的系统或开发环境的其他部分。

另一方面,本地安装yarn monorepo可以使安装过程更加方便。这种方式通常需要创建一个新的yarn项目,然后在本地这个项目的目录下安装yarn monorepo。这种做法不会对全局系统造成任何影响,但它也意味着在每个新项目中都必须用相同的依赖项重复一遍。

3. 安装实现方式

接下来,我们将介绍如何在项目中安装yarn monorepo。

(1)在新项目中安装yarn monorepo

    a. 首先需建立一个新项目的目录,例如my-project。
   
    b. 在my-project目录中生成一个新的yarn项目:
 

 yarn init -y

    c. 通过以下命令安装yarn monorepo:

yarn add -D workspaces


    d. 修改my-project目录下的package.json文件来开启yarn workspaces:

     {
          "name": "my-project",
          "private": true,
          "workspaces": [
              "packages/*"
          ]
       }

    这里workspaces后面的值是指在my-project目录下的packages文件夹下存放所有的monorepo项目。    
(2)在现有项目中添加yarn monorepo

如果您的项目已经存在,可以按以下步骤添加yarn monorepo:

    a. 进入项目的根目录。
    
    b. 在package.json中添加workspaces设置:

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

    这里的packages路径需要修改以符合您文件结构的实际情况。
    
    c. 运行以下命令安装yarn monorepo:

   yarn add -D workspaces

总之,安装yarn monorepo可以让您充分利用monorepo中的最佳做法,可以更好地管理一个大型仓库中的依赖关系。通过将所有中的相关项目都放在同一个代码库下,可以使整个开发流程更为轻松。

V. 创建 yarn monorepo

在创建一个新的 yarn monorepo 之前,需要先明确你的项目类型和结构,以确保创建一个可维护和易于管理的项目结构。在本部分中,我们将介绍如何创建一个完整的 yarn monorepo,包括如何创建基础目录结构和如何配置文件。你可以根据你的实际情况和项目要求进行自定义和调整。

1. 创建基础目录结构

在创建新的 yarn monorepo 之前,需要先创建一个存储所有模块和包的文件夹。你可以为文件夹选择任何名称,但建议使用“packages” 或 “modules”。

- project-root
   - packages

在 packages 目录下创建多个文件夹以表示不同的包,每个文件夹代表一个单独的 npm 包。在每个文件夹中,都需要包含一个 package.json 文件,用于作为每个单独的 npm 包的明细配置。以下是基础目录结构:

- project-root
   - packages
     - package-1
       - package.json
       - src
     - package-2
       - package.json
       - src

2. 配置文件

为了让 yarn 知道你的项目是一个 monorepo,你需要在你的项目根目录中添加一个 workspace 选项列表。该文件必须命名为 package.json,所以你需要编辑该文件来包含 workspaces。

{
  "name": "project-root",
  "version": "0.0.0",
  "private": true, // 这里是告诉yarn,这不是一个公开的npm包
  "workspaces": [
    "packages/*"
  ]
}

这段代码中workspaces列表表示了所有在 packages 文件夹下的 npm 包被视为与父文件夹同一级别,覆盖了 npm 的默认层次结构。

在每个子文件夹(每个单独的npm包)中,都需要包含一个 package.json 文件,其中包含模块的名称、版本等详细信息。

3. 自定义项目

可以根据项目的具体情况和要求自定义 yarn monorepo。例如,如果您希望在单一的 git 存储库中维护其他资源,如文档或演示,请在项目根目录下添加一个名为 docs(或demo)的文件夹,并在 package.json 文件的工作空间列表中包含该文件夹。

你可以完全自定义项目的目录结构和配置文件,只需要在 package.json 文件中声明您选择的目录。

总之,创建 yarn monorepo 将利用 monorepo 提供的最佳实践,从而更好地管理大型仓库中的依赖关系。此外,将所有相关的项目都放在同一个代码库中,可以让整个开发流程更加简单。你可以根据你的实际情况和项目要求进行自定义和调整,灵活应对不同的开发场景和要求。

VI. 添加包

向 monorepo 中添加不同类型的包,包括应用程序和库模块,通常需要执行以下步骤:

1. 创建一个新的包(模块)

使用以下命令创建一个新的包(模块):

yarn workspace package-name init

这会在 monorepo 的 packages 文件夹中创建一个新的文件夹 package-name,并在其中创建一个新的 package.json 文件。


2. 添加依赖项

添加需要的依赖项和开发依赖项:

yarn workspace package-name add <package-name> // 添加新的依赖
yarn workspace package-name add -D <package-name> // 添加新的开发依赖

对于 monorepo,我们可以在根目录下的 package.json 文件中添加各种依赖,并在每个包(模块)的 package.json 文件中指定包的特定依赖项。

3. 编写应用程序或库

- 应用程序(Application)

编写应用程序时,可以使用任何您想要的框架。在包(模块)的 src 文件夹中编写代码,并将其编译到 public 文件夹中。您可以使用 webpack 或其他编译器,将 src 中的代码打包到 public 文件夹中,供浏览器使用。

例如,在 monorepo 中创建 React 应用程序:

yarn workspace my-react-app add react react-dom

在 src/index.js 中编写 React 代码,将其打包并写入 public 文件夹中。

- 库模块(Library)

作为库模块,我们可以为他们指定通用的入口或模块输出。可以在 package.json 中添加以下内容:

{
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "files": [
    "dist"
  ],
  // ...
}

使用 Rollup 或 Webpack 等构建工具将源文件打包在一起并输出到 dist 文件夹中。

比如,在 monorepo 中提供一个脚手架库:

yarn workspace my-tool add chalk commander

在 src/index.js 中编写库代码,将其打包,并将 dist 中的代码作为引用。

4. 安装包(模块)

由于 monorepo 使用了本地文件路径来引用包(模块)之间的依赖,我们不能直接使用 npm install 命令来安装 monorepo 中的依赖。

为了安装 monorepo 中的包(模块),我们需要使用 yarn 和 workspaces 库。可以通过以下命令安装 monorepo 中的所有依赖项:

yarn install --check-files

或者,可以只安装特定的包或模块:

yarn workspace package-name install

也可以安装所有的包和模块:

yarn install

总之,向 monorepo 中添加不同类型的包(模块)需要执行上述步骤。具体来说,需要创建一个新的包(模块)、添加依赖项和开发依赖项、编写应用程序或库,最后使用像 yarn install 这样的命令来安装这些包。这个流程有助于构建一个自包含和灵活的 monorepo,提高代码复用率和开发效率。

VII. 管理依赖

在 monorepo 中管理依赖关系非常重要,因为它可以防止依赖冲突和重复安装依赖项。当项目规模较大时,依赖管理可为大型代码库的开发和维护带来显著的效率提升。

yarn 提供了名为 workspaces 的特性,使得同时安装和管理多个包的依赖项成为可能。workspaces 将整个 monorepo 视为统一的 packages 子目录,从而能够跨越整个 monorepo 检测并安装依赖项。

以下是如何使用 yarn workspaces 来管理各个包之间的依赖关系:

1. 新建 monorepo

首先,需要新建一个 monorepo。如前所述,在 monorepo 根目录和文件夹中创建一个 package.json 文件,并在其中添加 workspaces 字段。

{
  "name": "my-monorepo",
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

2. 安装依赖项

要安装依赖项,我们可以使用通常的 yarn add 命令,在 package.json 文件中添加依赖项。然后运行 `yarn install` 命令会安装 monorepo 所有包的依赖项,并对所有包进行扫描。这样每个包就都可以使用 monorepo 内安装的任何依赖项。

注意要使用 workspaces 特性指定本地依赖,将其指定为 "link: ../path-to-dependency" 的形式。这样可以保证 monorepo 内的所有包都使用同一个依赖项版本。

{
  "dependencies": {
    "dependency-1": "link: ../path-to-dependency-1",
    "dependency-2": "link: ../path-to-dependency-2"
  }
}

3. 避免重复安装

在使用 monorepo 时,我们需要注意避免重复安装依赖项。为此,我们可以使用 yarn workspaces 命令。

可以使用 yarn workspaces info 命令查看 monorepo 中各个包的依赖项信息。使用 yarn workspaces list 命令可以查看 monorepo 中所有包及其依赖项的列表。

如果需要列出所有已安装的依赖项的详细信息,则可以运行 yarn workspaces info --json。这会显示出 monorepo 中所有包的所有依赖项的详细信息。

4. 手动控制依赖

当 monorepo 中包含第三方依赖项且不同包之间需要使用不同的依赖项版本时,需要手动控制依赖项。

我们可以使用 yarn resolutions 来强制 monorepo 中所有包都使用相同版本的依赖项。例如,以下代码示例强制使用 lodash 4.x 版本:

{
  "resolutions": {
    "lodash": "4.x"
  }
}

总之,使用 yarn workspaces 可以轻松管理 monorepo 中各个包之间的依赖关系。通过使用 workspaces 功能,可以更轻松地处理 monorepo 中的依赖项,从而避免重复安装依赖和依赖冲突,提高开发和维护效率。为了避免手动控制依赖,确定每个依赖项的版本并通过 resolutions 配置指定依赖项的版本也是一个解决方案。

VIII. 线上发布

部署 monorepo 项目需要经过多个步骤,包括构建、编译、打包、部署和最终运行。这些步骤需要根据项目的需求进行自定义和调整,以确保在线上环境中成功部署项目。

1. 构建/编译/打包

在将 monorepo 项目部署到生产环境之前,需要针对每个子包执行构建、编译或打包等任务,以生成可在生产环境中运行的代码和资源。

例如,在部署 Node.js 包时,需要使用 babel 或 TypeScript 编译器对代码进行打包、编译或转换。另外,还需要将代码、依赖项和运行时资源打包成一个唯一的文件或集合,例如使用 webpack 或 rollup 等打包工具。

2. 部署

一旦完成构建和打包任务,可以将生成的代码部署到线上服务器或云环境。对于 Node.js 包,可以使用 pm2 等进程管理器来启动和管理 monorepo 项目。

对于 Web 应用程序和库模块,可以使用容器化平台,例如 Docker 和 Kubernetes,来部署和运行 monorepo 项目。在使用容器化平台时,可以轻松部署和升级 monorepo 项目,并将其扩展到多个节点,从而实现高可用性和性能。

3. 运行

一旦 monorepo 项目成功部署并在生产环境中运行,可以通过 Web 浏览器或 API 请求来访问它。在生产环境中,需要对 monorepo 项目进行测试和监视,以确保其稳定运行和高性能。

总之,部署 monorepo 项目是一个包含多个步骤的复杂过程。需要针对每个子包执行构建、编译或打包等任务,并使用 pm2 或 Docker 等工具部署代码到线上服务器或云平台中。最终需要对 monorepo 项目进行测试和监视,以确保其稳定运行和高性能。在整个部署过程中,需要不断调整和优化项目,以最大程度地实现其性能和效率优势。

IX. 总结

本文主要介绍了如何使用 yarn monorepo 来构建、管理和部署具有多个包或模块的项目。我们讨论了 monorepo 的优势及其在大型项目开发中的应用。我们还介绍了如何设置 monorepo 项目,并详细描述了如何管理依赖关系、添加子包、构建和部署项目。在本文中,我们还讨论了 monorepo 的最佳实践,以及如何实际应用这些技术来提高代码库的维护和开发效率。 最后,本文提出了一些建议,以帮助您在使用 monorepo 时获得最佳体验:

1. 确认 monorepo 是否适合您的项目:在决定使用 monorepo 前,需要确认 monorepo 是否适合您的项目。如果您的项目包含多个紧密关联的包或模块,并且需要在这些包之间进行频繁的代码重用和依赖管理,则 monorepo 是一个不错的选择。

2. 确保清晰的单一职责原则:为了确保 monorepo 的成功,每个包或模块应如清晰的单一职责原则一样,具有特定的功能或用途。这可以帮助简化对代码库的理解和管理。

3. 使用工具集优化开发流程:使用 monorepo 有助于提高代码复用率和开发效率,但在实际操作中,需要使用适当的工具来优化开发流程。 例如,使用 ESLint、Prettier 和 TypeScript 等工具来提高代码规范和可读性,并使用自动化工具(如流水线和部署流程)来简化开发流程。

4. 遵循最佳实践:为了从 monorepo 中获得最大收益,需要遵循最佳实践,例如限制使用共享状态、避免复杂的跨包依赖关系等。应该在使用 monorepo 时保持灵活,并根据项目需求进行适当调整和改进。

总的来说,yarn monorepo 是一个强大的工具,可以帮助开发人员在大型项目中快速构建和管理多个包或模块。通过使用 monorepo,可以提高代码复用率和开发效率,并使代码库更易于理解、维护和扩展。为了从 monorepo 中获得最大收益,需要遵循最佳实践,并在实际应用中进行适当调整和改进。

X. 参考文献

1. "A Beginner's Guide to Yarn Workspaces for Monorepos." Pusher Blog, 3 Oct. 2019, pusher.com/tutorials/yarn-workspaces-monorepo.

2. "Develop Your Web Development Projects Faster with Yarn Workspaces." Auth0 Blog, 11 Mar. 2019, auth0.com/blog/develop-your-web-development-projects-faster-with-yarn-workspaces.

3. "Monorepos - Yarn Workspaces and Lerna.js." Dev.to, 20 Jan. 2020, dev.to/greenbrandonc/monorepos-yarn-workspaces-and-lerna-js-1845.

4. "Yarn Workspaces - Lerna Alternative for Monorepo." Codeburst, 22 May 2019, codeburst.io/yarn-workspaces-lerna-alternative-for-monorepos-2d05f3fd6be2.

5. "Managing Monorepos with Lerna & Yarn Workspaces." Carbon Five, 6 Sept. 2018, carbonfive.com/blog/managing-monorepos-with-lerna-yarn-workspaces.

6. "Yarn Workspaces Documentation." Yarnpkg.com, yarnpkg.com/features/workspaces.

7. "Lerna.js Documentation." Lerna.js.org, lerna.js.org.

8. "Monorepos: Why You Should Consider Them for Your Project." Smashing Magazine, 1 Nov. 2018, smashingmagazine.com/2018/11/monorepos-in-git-and-packages.

标签:依赖,workspaces,项目,项目管理,代码,yarn,monorepo
From: https://blog.csdn.net/2301_78348935/article/details/137168907

相关文章

  • yarn 的安装和使用
    Yarn是一个快速、可靠和安全的JavaScript包管理工具,它帮助开发者管理项目的依赖关系。以下是关于Yarn的安装和使用方法的详细指南。安装Yarn通过npm安装在大多数情况下,推荐通过npm(Node.js的包管理器)来安装Yarn。如果你还没有安装Node.js,可以在Node.js官网......
  • 软件项目管理(开发/实施/运维/安全/交付)全套文档模板
      前言:在软件项目管理中,每个阶段都有其特定的目标和活动,确保项目的顺利进行和最终的成功交付。以下是软件项目管理各个阶段的详细资料:软件项目全套文档资料下载:点我获取1.需求阶段目标:收集、分析和定义用户需求和业务目标。主要活动:需求调研:与用户沟通,了解他们的需求......
  • hatch python 现代项目管理工具
    hatchpython现代项目管理工具,以下是一些简单试用安装clibrewinstallhatch一些推荐配置这样我们的venv直接在执行目录中,比较方便使用hatchconfigsetdirs.env.virtual.hatch简单项目clihatchnewdalongdemo......
  • 追光几何Lite用户分享之项目管理
    在我作为项目管理人员的职业生涯中,面对众多跨领域的项目,我不断地寻找高效的方法和工具来优化项目文件的管理。在众多尝试中,我发现了追光几何Lite,一款简洁实用的本地文件版本管理软件,它极大地提升了我的工作效率和文件管理的质量。项目管理过程中会产生众多文件和文档,从项目计......
  • 软件项目管理全套文档模板(开发/实施/运维/安全/交付)
     前言:在软件项目管理中,每个阶段都有其特定的目标和活动,确保项目的顺利进行和最终的成功交付。以下是软件项目管理各个阶段的详细资料:软件项目全套文档资料下载:点我获取1.需求阶段目标:收集、分析和定义用户需求和业务目标。主要活动:需求调研:与用户沟通,了解他们的需求和......
  • yarn的安装和使用
    Yarn是一个JavaScript包管理工具,用于管理项目中的依赖项。它可以替代npm,并提供更快的下载速度和更可靠的依赖管理。下面是关于Yarn的安装和使用方法:安装Yarn使用npm安装Yarn(需要先安装Node.js):npminstall-gyarn使用Homebrew(适用于macOS用户):brewins......
  • 软件项目管理全套通用模板(规格说明书~详细设计~测试计划~验收报告)
     前言:在软件开发过程中,文档资料是非常关键的一部分,它们帮助团队成员理解项目需求、设计、实施、测试、验收等各个环节,确保项目的顺利进行。以下是针对您提到的各个阶段的文档资料概述:所有资料获取:点击获取开发阶段需求规格说明书:详细描述了软件系统的功能需求、非功能......
  • Yarn 的安装和使用
    在前端开发中,包管理工具是必不可少的利器,而Yarn就是其中一个备受欢迎的选择。本文将介绍如何安装和使用Yarn,并解决可能遇到的一些常见问题,让你更高效地管理项目依赖。什么是Yarn?Yarn是由Facebook、Google、Exponent和Tilde联合推出的JavaScript包管理工具。相......
  • YYDS,只用几条命令轻松搭建自己的项目管理平台jira
    简介Jira是一款强大的项目管理工具,它可以帮助团队协作、跟踪任务、管理项目,并提高生产力。在本文中,我们将介绍如何使用Docker快速搭建Jira,让你能够快速部署、方便管理和灵活扩展你的项目管理环境。环境准备如果我们还没在电脑或者服务器中安装docker,那我们需要先安装好docker,......
  • 如何安装和使用 Yarn
    如何安装和使用YarnYarn是一个流行的包管理器,专为JavaScript项目设计,以提高依赖项管理的效率和一致性。与npm相比,Yarn提供了更快的依赖安装速度、更准确的版本控制和改进的安全性,使其成为许多开发者的首选。安装前提条件在安装Yarn之前,请确保您的系统已安装Nod......