npm workspace的实践

npm workspace的实践

参考文档,从npm7.x 开始，npm 支持workspace。

什么叫workspace

假如你写了一个lib, 同时你也为这个lib 写了一个演示的应用。那么你的代码结构就会如下：

----root
    package.json
    src
       ----demo
    lib
       ----libsrc
    node_modules

也就是说我们的代码库里有两部分独立模块，demo 依赖lib, 同时，lib, demo 都可以单独编译发布。为了方便同时开发维护这两部分模块，我们引入了workspace 的概念。简单的说workspace 就是指有多个独立模块组成的代码空间。

workspace 解决什么问题

demo源码依赖lib, 这种依赖是通过npm 包的方式实现的。workspace 则在node_modules创建了一个link,指向libsrc的源码。这样就好像我们真的安装了这个lib包，而实际上，我们指向的对象是源码位置。针对lib的改动，无需编译发布安装，demo中立刻拿到最新的代码，因为我们是引用的是lib的源码。

workspace 怎么使用与配置

{
  "workspaces":[],// 列出库函数的文件列表，文件夹到包含package.json为止。
  "devDependencies":{
    "libxxx":"workspace:(xxxversion|*)",
  }
}

这样我们就可以在整个工程里面使用import xxx from 'libxxx'。

当然这种方式，也可以采用tsconfig 里面的path 来实现。但是这种方式更加优雅。