封装Vue组件库(二)、Monorepo 方式组织项目代码

本文主要是介绍封装Vue组件库(二)、Monorepo 方式组织项目代码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Monorepo 方式组织项目代码

开发一个组件库,其中可能会有很多的组件。

当组件库开发完毕后,还要发布到NPM或私有仓库供其他人使用。

在使用 ElementUI 的时候,可以完整的引入,也可以根据需要按需引入部分组件以减少打包的体积。

按需引入还需要安装Babel的插件babel-plugin-component,配置.babelrc,比较麻烦。

组件库为了让用户使用方便,可以把每一个组件作为一个单独的包发布到 NPM 上,用户在使用的时候,可以只下载它需要的组件。

当然也可以把所有的组件打包到一起发布。

项目的组织方式

  • Multirepo(Multiple Repository) - 多仓库,每一个包创建一个单独的项目
    • 每个组件都需要一个仓库,都有自己的脚手架package.json,都要下载和管理自己的依赖,都需要单独进行发布。
    • 并且多个组件可能会有相同的依赖,避免不了重复下载这些依赖,还会占用硬盘空间
  • Monorepo(Monolithic Repository) - 一个项目仓库中管理多个模块/包
    • 这种方式只创建一个项目,根目录以脚手架为主
    • 主要内容(所有组件)都放在根目录下的一个统一的目录下,一般命名为 packages。
    • 每个组件在这个目录中配置一个子文件夹
    • 所有的组件都可以放在根目录下的一个统一的目录下,这个目录可以叫做 packages。
      • 使用monorepo的时候,要把所有的包(组件)放到根目录下一个指定的文件夹下
      • 这个文件夹一般命名 packages,也可以叫其他名字
    • 每一个组件在这个目录中配置一个子文件夹,设置为包。
    • 因为所有组件的管理方式都比较类似,相关的配置可以放在根目录。
    • 不同的组件可能会有相同的依赖,这时只需下载一份。
    • 将来的测试、打包、发布也可以在当前项目进行统一的管理。
    • 这样管理项目,对组件库开发来说更方便。
    • 通过monorepo的方式组织代码的结构,可以让每一个包,都可以单独测试,单独发布,以统一管理它们的依赖。

Monorepo 介绍

Monorepo 是项目代码的一种管理方式。

这种方式在一个项目仓库(repo)中管理多个模块/包(package)。

根目录以脚手架为主,主要内容(所有开发的模块,对组件库来说就是组件)都放在根目录下一个统一的目录下,一般命名为 packages。

每个组件在这个目录中配置一个子文件夹,作为一个包,它们遵循比较统一的目录结构。

将来可以通过一些工具管理这些包,还能管理其他工作,例如打包、发布、测试等。

因为所有组件的管理方式都比较类似,相关的配置可以放在根目录。

  • 配合 lerna 或 yarn workspaces 可以管理每个组件的依赖,相同依赖避免重复安装。

  • 将来的测试、打包、发布也可以在当前项目进行统一管理。

  • 并且可以让每一个包都可以单独测试、单独发布,以统一管理它们的依赖。

这个方式管理项目,对组件库开发来说更方便。

很多知名的开源库都是使用这种方式来管理项目的,例如 Vue3、React、Babel 等。

查看这些项目,根目录的内容以脚手架为主,主要内容都在 packages 目录中,分多个 package 进行管理。

|- packages
|  |- pkg1
|  |  |- package.json
|  |- pkg2
|  |  |- package.json
|- package.json

vue3 源码结构

vue-next

package.json
{// 禁止把当前的包发布到NPM,Vue3 发布的是packages下的所有包"private": true,// yarn workspacesworkspaces: ["packages/*"]// ...
}
packages

packages 目录下的内容就是 Vue3 的源码,每一个文件夹就是一个包。

Vue3 把不同功能的代码放到不同的包中进行管理。

  • compiler-xxx 存储和编译器相关的代码
  • reactivity 响应式相关代码
  • runtime-xxx 运行时相关代码

这些包可以单独发布,使用者可以单独去下载使用。

查看单独的包

随便查看一个包的结构(例如 packages/compiler-core):

  • __tests_ 存储测试相关的代码
  • src 当前包的源码
  • LICENSE 版权,内容是开源协议的描述
  • README.md
  • api-extractor.json 配置文件
  • index.js 打包时候的入口
  • package.json
// package.json
{// 将来发布到NPM展示的名字"name": "@vue/compiler-core",// 版本号"version": "3.0.0-rc.10",// 描述"description": "@vue/compiler-core",// 包的入口"main": "index.js",// ...
}

其他的包的目录结构都一样。

使用monorepo管理项目的时候,应尽可能让每一个包的目录结构都是相同的,这样方便将来的管理。

React 源码结构

packge.json

与Vue3中的package.json一样,都包含这两个属性:

{// 禁止把当前的包发布到NPM,Vue3 发布的是packages下的所有包"private": true,// yarn workspacesworkspaces: ["packages/*"]// ...
}
packages

React也是把不同的功能放到不同的包,也可以单独发布到NPM使用。

包的结构

例如查看 packages/create-subscription

  • npm
  • src 源码
  • README.md
  • index.js 打包入口
  • package.json

按照Monorepo的方式组织代码结构

在项目根目录创建 packages 文件夹,这个文件夹下存放所有要开发的组件。

每一个组件对应一个文件夹,每一个文件夹就是一个可以单独发布到NPM的包。

包的结构:

  • packages
    • button - 组件名
      • __test__ - 存放测试相关代码
      • dist - 打包的目录
      • src - 存放源码(.vue文件)
      • index.js - 打包的入口文件
        • 定义组件的install方法,内容是注册组件
        • 导出组件
        • 这样就提供了插件安装和单独注册两个方式去使用这个组件
      • LICENSE - 版权信息(MIT)
      • package.json - 组件的描述信息
      • README.md - 组件的文档

最终效果如:

在这里插入图片描述

之后可以使用plop基于模板快速生成包结构。

这篇关于封装Vue组件库(二)、Monorepo 方式组织项目代码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1097990

相关文章

Springboot处理跨域的实现方式(附Demo)

《Springboot处理跨域的实现方式(附Demo)》:本文主要介绍Springboot处理跨域的实现方式(附Demo),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录Springboot处理跨域的方式1. 基本知识2. @CrossOrigin3. 全局跨域设置4.

springboot security使用jwt认证方式

《springbootsecurity使用jwt认证方式》:本文主要介绍springbootsecurity使用jwt认证方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录前言代码示例依赖定义mapper定义用户信息的实体beansecurity相关的类提供登录接口测试提供一

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

springboot security之前后端分离配置方式

《springbootsecurity之前后端分离配置方式》:本文主要介绍springbootsecurity之前后端分离配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的... 目录前言自定义配置认证失败自定义处理登录相关接口匿名访问前置文章总结前言spring boot secu

SpringBoot中封装Cors自动配置方式

《SpringBoot中封装Cors自动配置方式》:本文主要介绍SpringBoot中封装Cors自动配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot封装Cors自动配置背景实现步骤1. 创建 GlobalCorsProperties

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

Flutter打包APK的几种方式小结

《Flutter打包APK的几种方式小结》Flutter打包不同于RN,Flutter可以在AndroidStudio里编写Flutter代码并最终打包为APK,本篇主要阐述涉及到的几种打包方式,通... 目录前言1. android原生打包APK方式2. Flutter通过原生工程打包方式3. Futte

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录,测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的