使用PNPM管理单一仓库

简介

以前用过yarn+lerna管理单一仓库,实际使用中还是存在不少问题,pnpm出来以后除了对node_modules管理非常好以为,对workspace支持也非常好。本项目就是使用 father dumi pnpm 技术栈的React组件单一仓库模板。

使用这个项目模板根据下面的说明文档,可以非常快速的完成创建包、编写和展示组件文档、构建和发布到npm仓库。

仓库地址: scfido/pnpm-monorepo: 使用father、dumi、pnpm技术栈的React组件单一仓库模板。 (github.com)

在根目录执行会自动安装所有项目的依赖包。

pnpm install

清理所有依赖

pnpm clean

清理所有依赖并重新安装

pnpm reinstall

启动文档项目

文档项目有两个作用:

  • 介绍组件的使用方法
  • 组件的功能演示
  • pnpm start
    

    在这个模板中新添加一个包,操作流程如下,以创建liba为例:

    cd .\packages\
    mkdir liba
    cd liba
    pnpm dlx create-father ./ 
    # 根据提示选择或输入你的信息。
    # √ Pick target platform(s) » Browser
    # √ Pick NPM client » pnpm
    # √ Input NPM package name ... liba
    # √ Input NPM package description ...
    # √ Input NPM package author (Name <email@example.com>) ...
    

    包目录创建好后,添加react组件之前要对项目参数做一些简单的配置。

    .\packages\liba\tsconfig.json,的compilerOptions中增加jsxesModuleInteropsourceMap三项参数。

    "compilerOptions": { "strict": true, "declaration": true, "skipLibCheck": true, "baseUrl": "./", "jsx": "react", "esModuleInterop": true, "sourceMap": true

    然后添加你要开发的组件依赖包

    # 添加依赖包react
    pnpm add react
    

    添加组件文件.\packages\liba\src\Button.tsx

    // .\packages\liba\src\Button.tsx
    import React from "react";
    export default ()=>{
        return(<button>From lib a</button>)
    
    // .\packages\liba\src\index.ts
    export {default as ButtonA}  from "./Button"
    
    cd .\packages\liba
    pnpm build
    

    生成成功后会在.\packages\liba\dist\esm中看到结果。

    在文档中展示组件

    前面已经创建好了包liba,并创建了组件ButtonA,下面在文档中展示这个组件。

    .\packages\docs包中,添加liba的应用。

     // .\packages\docs\package.json
     "dependencies": {
        // 添加liba的依赖,注意版本号的写法。
        "liba": "workspace:^1.0.0"
        // ... 其它依赖
    

    在创建.\packages\docs\src\libA的目录,并新建展示文档index.md

    # .\packages\docs\src\libA\index.md
      title: Components
      path: /components
    ## Libiary A
    Button A:
    ```tsx
    import React from 'react';
    import {ButtonA} from "liba";
    export default () => {
      return(
        <ButtonA/>
    

    启动文档项目就能看到liba中的组件展示了。

    pnpm start
    

    组件展示文档项目运行起来后,文档自身的修改是能够热更新的,但是引用的liba包中的组件并不能热更新,修改了组件内容后,需要在组件目录运行pnpm build才能生效。要实现组件的热更新,可以在组件包目录中使用pnpm dev来监视文件变更并自动build

    cd .\packages\liba
    pnpm dev
    

    发布分为发布说明文档和组件两种情况。

    将文档发布成网站。

    pnpm docs:build --filter docs
    

    输出目录在packages\docs\docs-dist,这些文件放在web服务中就可以访问。例如使用dotnet-serve工具。

    # 安装dotnet-serve
    dotnet tool install --global dotnet-serve
    # 启动网站
    dotnet serve -o
    

    发布组件非常简单,和npm的操作流程一致。在根目录下执行pnpm publish即可。通过npmjs.org用户注册等一系列操作发布成功。完成后发现并不是我们要的结果,这样是把整个项目作为单个包发布出去了。而我们想要的是发布这三个包。

  • @pnpm-monorepo/liba
  • @pnpm-monorepo/libb
  • @pnpm-monorepo/libc
  • 其实也非常简单,使用filter参数过滤项目,或者分别到各自的目录下去发布就可以了。

    # 使用指定项目名称的方式
    pnpm --filter liba publish 
    pnpm --filter libb publish 
    pnpm --filter libc publish
    # 使用通配符过滤的方式,注意windows下不要单引号。
    pnpm --filter 'lib*' publish
    # 进入到项目目录下发布的方式
    cd  .\packages\liba
    pnpm publish
    cd ..\libb
    pnpm publish
    cd ..\libc
    pnpm publish
    

    或者使用script目录下的publish.ps1脚本。

    统一包版本

    如果希望发布的所有包版本统一,可使用以下命令。脚本会自动把packages目录下的项目设置为指定版本号,并且会自动添加添加git tag。

    ./set-version.ps1 1.1.4
    

    包开发完成后就是给其它项目使用了,按上面的步骤发布到npm仓库后,按常规操作用名称引用即可。

    但是在开发过程中要引用本地包怎么操作呢?分仓库内和仓库外两种引用情况。

    在同一仓库内引用,比如docs项目引用liba。只需要在docs项目中执行添加包命令,并加上-w``--workspace参数,表面是引用workspace中的包。

    # 中项目根目录操作需要带过滤条件
    pnpm add liba -w --filter docs
    # 进入包的目录可以直接添加
    cd .\packages\docs
    pnpm add liba -w
    

    开发时其它仓库需要引用本项目的包时,可使用pnpm的link命令。

  • 在被引用的仓库执行
  • # 例如liba是要被引用的库,将liba注册到全局仓库
    cd .\packages\liba
    pnpm link . --global
    
  • 在引用的仓库执行
  • # 从全局仓库连接 liba
    pnpm link liba --global
    

    注意:连接后会在package.jsondependencies中添加liba。如果你的包从来没有发布过,以后执行install的时候会因为找不到这个包而失败。

    ANTD组件没有加载CSS

    在docs项目中引用ANTD组件,并在文档中增加样式引用。

    import React from 'react';
    import {Button} from "libb";
    import 'antd/dist/antd.css';
    export default () => {
      return(
        <Button/>
    

    包修改以后不生效