Angular 16库测试遇NgModule错误，求npm link替代及构建修复方案

问题背景 #

我正在开发Angular 16库，当前采用以下流程在主应用中测试：

• 监听库文件变更，自动重建库
• 对库的构建文件夹执行npm link
• 主应用配置中设置preserveSymlinks: true

整体运行基本正常，但修改库时（尤其是快速保存文件）频繁触发以下错误：

XXXModule does not appear to be an NgModule class. This likely means that the library (XXX) which declares XXXModule is not compatible with Angular Ivy. Check if a newer version of the library is available, and update if so. Also consider checking with the library's authors to see if the library is expected to be compatible with Ivy.

每次出现错误后，我都得停止并重启所有服务（库的构建监听、主应用的ng serve），每日多次重复这个操作非常麻烦。对比正常与异常的库构建产物发现：异常构建会缺失Ivy相关的导入代码，例如：

import * as i0 from "@angular/core";
import * as i1 from "@angular/cdk/dialog";
import * as i2 from "./layout/layout.module";

而且一旦出现异常构建，后续的增量构建无法自动恢复这些代码，必须重启库的监听构建服务，甚至还要重启主应用才能识别变更。

我的问题 #

1. 有无无需依赖npm link即可使用开发中库的简便方法？
2. 如何无需重启所有服务解决构建异常问题？仅重启库的构建服务也可接受。

解决方案 #

问题1：替代npm link的测试方案 #

推荐使用TypeScript路径映射+库的watch构建，完全不需要npm link和preserveSymlinks配置：

1. 在主应用的tsconfig.json中添加路径映射，指向你的库源码目录（或构建后的输出目录）：

   "compilerOptions": {
     // ...其他配置
     "paths": {
       "@your-library-name/*": ["../path-to-your-library/projects/your-library/src/*"]
     }
   }
   

2. 在库的项目目录下启动watch构建：

   ng build your-library --watch
   

3. 直接启动主应用的开发服务：

   ng serve
   

这种方式下，主应用会直接引用库的源码（或实时构建的产物），文件变更时会自动同步编译，避免了符号链接带来的各种问题。

另外也可以用npm install file:../path-to-your-library的方式将库作为本地依赖安装，但这种方式需要每次更新库后重新执行安装，不如watch+路径映射高效。

问题2：无需全重启的构建异常修复方法 #

临时修复（已出现异常时）

1. 停止库的watch构建进程
2. 清理库的构建缓存：

   ng cache clean
   

3. 重新启动库的watch构建：

   ng build your-library --watch
   

等库构建完成后，主应用会自动重新编译，无需重启主应用的ng serve。

长期预防（避免异常发生）

• 禁用增量构建：在库的angular.json中，找到对应库的architect.build.options，添加"incremental": false，强制每次构建都是全量构建，避免增量构建的缓存bug：

  "projects": {
    "your-library": {
      "architect": {
        "build": {
          "options": {
            // ...其他配置
            "incremental": false
          }
        }
      }
    }
  }
  

• 构建前清空输出目录：启动watch时添加--deleteOutputPath参数，每次构建前先删除旧的输出文件：

  ng build your-library --watch --deleteOutputPath
  

内容的提问来源于stack exchange，提问作者Carrm