架构-单一代码库-monorepo-pnpm-workspace:基本使用 / 一个代码仓库中包含了多个软件包(package)并进行开发

20 篇文章 0 订阅

一、官网文档

pnpm 内置了对单一存储库(也称为多包存储库、多项目存储库或单体存储库)的支持, 你可以创建一个 workspace 以将多个项目合并到一个仓库中。

一个 workspace 的根目录下必须有 pnpm-workspace.yaml 文件, 也可能会有 .npmrc 文件。

工作空间(Workspace) | pnpm

https://www.pnpm.cn/pnpm-workspace_yaml

二、pnpm-workspace环境搭建

2.1、创建目录

monorepo-pnpm-workspace-base

2.2、初始化项目

pnpm init

2.3、package.json 删除 main、test

去掉后

2.4、创建 pnpm-workspace.yaml 文件

packages:
  # all packages in direct subdirs of packages/
  - 'packages/*'
  # all packages in subdirs of components/
  - 'common/**'
  # exclude packages that are inside test directories
  - '!**/test/**'

2.5、创建目录common、packages

2.6、package.json增加"private": true,

2.7、进入packages创建项目

cd packages

pnpm create vite app-base --template vue-ts

pnpm create vite app1 --template vue-ts

2.8、根目录下package.json增加如下红框内容

2.9、packages目录下app-base、app1、app2的package.json删除如下图红框内容

2.10、在整个项目根目录下(monorepo-pnpm-workspace-base)安装依赖

pnpm i

2.11、app-base、app1、app2分别在vite.config.ts中设置端口号

server: {
    port: 5173
}

2.12、根项目package.json配置

2.13、启动项目

pnpm run dev-base

启动成功,同理启动 app1、app2

三、pnpm公共组件库

3.1、创建common目录及文件如下

3.2、common/components/snow/index.vue

<template>
    <div>snow components index</div>
</template>

<script setup lang="ts">
</script>

<style scoped>
</style>

3.3、common/components/index.js

export * from "./snow"

3.4、common/components/package.json

{
  "name": "@common/components",
  "version": "1.0.0",
  "description": "pnpm-workspace-common-components",
  "pricate": true,
  "keywords": [],
  "author": "",
  "license": "MIT",
  "main": "index.ts"
}

3.5、 安装workspace依赖

下边命令式packages下所有项目都安装,也可以指定项目安装见3.8

pnpm i @common/components -w

package.json 增加内容如下

3.6、app-base/src/App.vue引入使用组件snow

3.7、启动项目 pnpm run dev-base,运行成功,组件内容已使用成功。

3.8、指定项目按照common下依赖

pnpm i @common/components --filter app-base

安装后package.json增加依赖,子项目node_modules增加依赖,同样运行成功。 

四、pnpm-workspace项目部署-思路

有本人“三”看出,组件部分式放在了node_modules下,由package.json管理,和普通的项目其实是一样了,部署思路同普通项目。

CentOS部署vue项目_snow@li的博客-CSDN博客

Docker部署前端项目(nuxt)_nuxt docker_snow@li的博客-CSDN博客

五、拓展

git modules也可以实现使用公共代码/组件的效果

git:git modules_gitmodules_snow@li的博客-CSDN博客

六、欢迎交流指正。

参考连接

架构-单一代码库-monorepo-lerna(8.0.0):lerna-pnpm-vue3-vite-ts 实践 / 用于管理包含多个软件包(package)的 JavaScript 项目-CSDN博客

工作空间(Workspace) | pnpm

pnpm-workspace.yaml | pnpm中文文档 | pnpm中文网

pnpm工作区,节省磁盘空间,共享组件_哔哩哔哩_bilibili

  • 7
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 9
    评论
pnpm-workspace 是 pnpm 包管理器的一个功能,它允许你在一个项目管理多个子包。了解了这一点后,我们可以根据引用内容来回答你的问题。 要启用 pnpmworkspace 功能,需要在工程根目录下创建一个名为 pnpm-workspace.yaml 的配置文件,并且在其指定工作空间的目录。在你提供的示例,这个文件内容如下:packages: - 'packages/*'。这表示你的项目的子包都放在名为 packages 的目录下。 在使用 pnpmworkspace 功能时,当你运行 pnpm publish 命令时,会自动将 package.json workspace 字段修正为对应的版本号。这样可以确保子包之间的依赖关系正确。 为了说明这一过程,让我们来看一下你提供的项目结构示例: /pnpm_workspace ├── package.json ├── packages │ ├── add-one │ │ ├── index.js │ │ ├── package.json │ │ └── test.test.js │ ├── add-two │ │ ├── index.js │ │ ├── package.json │ │ └── test.test.js │ └── adder │ ├── index.js │ └── package.json ├── pnpm-lock.yaml └── pnpm-workspace.yaml 现在,让我们通过一系列步骤来构建这样一个项目: 1. 首先,创建一个名为 pnpm_workspace 的文件夹,并进入该文件夹。 2. 在该文件夹运行 pnpm init -y 命令,以初始化根目录的项目。 3. 创建一个名为 pnpm-workspace.yaml 的文件,并在其添加 packages: - 'packages/*' 的内容,以指定工作空间的目录。 4. 在 packages 目录下创建三个子包(add-one、add-two 和 adder),并分别初始化它们的 package.json 文件。 5. 在 adder 子包,通过运行 pnpm add add-one --workspace 和 pnpm add add-two --workspace 命令,将 add-one 和 add-two 子包添加为 adder 的依赖。 通过以上步骤,你已经成功构建了一个具有 pnpmworkspace 功能的项目。 请注意,以上过程只是一个示例,你可以根据实际需要进行相应的调整和修改。希望这个回答对你有所帮助。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 9
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值