Angular monorepo报TS6059错误 跨库引用服务构建失败如何解决
问题描述
我创建了3个Angular库/包:
@example/ng-youtube-player:包含YoutubePlayerComponent和YoutubeApiService@example/ng-dailymotion-player:包含DailymotionPlayerComponent和DailymotionApiService@example/ng-vimeo-player:包含VimeoPlayerComponent和VimeoApiService
现在我要创建一个包含VideoPlayerComponent的库,仅需使用上述三个Api服务对应的包。为了避免不必要引入其他组件,我打算将3个库各自拆分,实现仅安装Service类的需求。
你可能会提出Angular自带tree-shaking机制,未使用的组件不会被打包到应用中,但我还是希望将这些依赖拆分,保证结构简洁。
我尝试搭建了包含2个库和1个测试应用的monorepo,但一旦在一个库中引用另一个库的服务,构建就会失败。我做了一个最简示例工作空间可复现问题:
npm install ng build @mintplayer/ng-youtube-api ng build @mintplayer/ng-youtube-player ng build ng-youtube-player-demo # 所有项目编译成功 # 现在打开NgYoutubePlayerComponent,取消构造函数中第16行注入参数的注释 ng build @mintplayer/ng-youtube-player
构建失败,抛出大量如下错误:
✖ Compiling with Angular sources in Ivy partial compilation mode. projects/mintplayer/ng-youtube-api/src/lib/ng-youtube-api.service.ts:1:1 - error TS6059: File 'C:/Users/user/source/repos/Tmp/mintplayer-ng-youtube-player/projects/mintplayer/ng-youtube-api/src/lib/ng-youtube-api.service.ngtypecheck.ts' is not under 'rootDir' 'C:\Users\user\source\repos\Tmp\mintplayer-ng-youtube-player\projects\mintplayer\ng-youtube-player\src'. 'rootDir' is expected to contain all source files. 1 import { Injectable } from '@angular/core'; projects/mintplayer/ng-youtube-api/src/public-api.ts:1:1 - error TS6059: File 'C:/Users/user/source/repos/Tmp/mintplayer-ng-youtube-player/projects/mintplayer/ng-youtube-api/src/public-api.ngtypecheck.ts' is not under 'rootDir' 'C:\Users\user\source\repos\Tmp\mintplayer-ng-youtube-player\projects\mintplayer\ng-youtube-player\src'. 'rootDir' is expected to contain all source files.
这里有两个核心问题:
- 必须按正确顺序单独构建每个项目
- 无法在一个Angular库中使用其他库的服务
我主要修改了根目录的tsconfig.json:
{ ... "compilerOptions": { ..., "paths": { "@mintplayer/ng-youtube-api": [ "projects/mintplayer/ng-youtube-api/src/public-api.ts" ], "@mintplayer/ng-youtube-player": [ "projects/mintplayer/ng-youtube-player/src/public-api.ts" ] } } }
我之前已经搭建过包含1个库和1个应用的工作空间,应用消费库中的类没有任何问题,但只要库之间互相消费类,构建就会失败。请问我该如何修复这个问题,实现包含2个库和1个测试应用的单工作空间正常运行?
解决方案
该报错是Angular库构建时默认读取其他库的源文件引用,导致超出当前库的rootDir校验范围导致,按以下步骤修改即可解决:
- 调整路径映射规则
将根目录tsconfig.json中paths配置的依赖库路径从源文件地址改为构建后的产物地址:
{ "compilerOptions": { "paths": { "@mintplayer/ng-youtube-api": ["dist/mintplayer/ng-youtube-api"], "@mintplayer/ng-youtube-player": ["dist/mintplayer/ng-youtube-player"] } } }
调整后库构建时会优先读取已编译好的产物,不会直接拉取其他库的源代码,自然不会触发rootDir校验错误。
2. 明确声明库依赖
在依赖其他库的库的package.json中明确声明依赖关系,比如@mintplayer/ng-youtube-player的package.json中添加:
{ "dependencies": { "@mintplayer/ng-youtube-api": "^1.0.0" } }
版本号和你实际本地构建的版本保持一致即可。
3. 固定构建顺序
先构建被依赖的库,再构建依赖它的库。你可以在根package.json中新增脚本简化操作:
{ "scripts": { "build:all": "ng build @mintplayer/ng-youtube-api && ng build @mintplayer/ng-youtube-player && ng build ng-youtube-player-demo" } }
开发时如果需要实时更新,可以分别开两个终端执行ng build @mintplayer/ng-youtube-api --watch和ng build @mintplayer/ng-youtube-player --watch,修改依赖库代码后会自动同步到产物,不需要手动重复构建。
按以上步骤调整后,库之间互相引用服务、应用消费库的逻辑都可以正常运行。
内容的提问来源于stack exchange,提问作者Pieterjan

