Angular 报错：Workspace extension with invalid name (defaultProject) found 解决方案

问题描述

当你运行 Angular CLI 命令（如 ng serve）时，可能会遇到以下错误提示：

Workspace extension with invalid name (defaultProject) found.

此错误表明 Angular 工作区配置中使用了无效的 defaultProject 属性。常见触发场景包括：

• 从旧版本 Angular 升级项目
• 从模板或示例复制了过时的配置
• 手动修改了 angular.json 文件中包含废弃属性

注意

该错误无法通过 npm install --legacy-peer-deps 或其他依赖管理命令修复，根本原因在于配置文件的结构问题。

---

根本原因

defaultProject 属性在 Angular CLI 中已被弃用。自 Angular 12+ 起：

1. CLI 不再支持此配置项
2. 保留该属性会导致验证失败
3. 相关变更源于 Angular 团队对配置系统的优化（GitHub Issue #11111）

配置对比

{
  ...
  "defaultProject": "my-app", // 已废弃属性！
  "projects": {
    "my-app": { ... },
    "other-project": { ... }
  }
}

{
  ...
  // 无 defaultProject 属性
  "projects": {
    "my-app": { ... },
    "other-project": { ... }
  }
}

---

解决方案

移除 angular.json 文件中的 defaultProject 属性

步骤详解

1. 打开项目根目录下的 angular.json 文件
2. 定位顶层配置对象中的 defaultProject 键
3. 删除整行 "defaultProject": "your-project-name"
4. 保存文件更改
5. 重新运行命令 ng serve

示例修改

操作前（含错误配置）：

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "defaultProject": "abc", // 删除此行
  "projects": {
    "abc": {
      "projectType": "application",
      ...
    }
  }
}

操作后（修复版配置）：

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "projects": {
    "abc": {
      "projectType": "application",
      ...
    }
  }
}

---

其他注意事项

1. 多项目工作区处理：
   如果您有多个项目（如主应用+多个库），运行命令时需明确指定项目：

   ng serve your-main-project-name

2. CLI 版本兼容性：
   确保使用的 Angular CLI 版本 ≥ 12.x：

   ng version
   # 若版本过低
   ng update @angular/cli @angular/core

3. 配置文件完整验证：
   修复后可通过以下命令确认配置有效性：

   ng lint
   ng build

4. 历史版本影响：
   若项目需兼容 Angular 11 或更早版本：

   • 维护两份配置文件（仅旧环境保留 defaultProject）
   • 建议升级至当前 LTS 版本获得完整支持

---

替代解决方案（不推荐）

虽然移除 defaultProject 是标准做法，但在特殊情况下可尝试：

# 在 package.json 脚本中硬编码项目名
"scripts": {
  "start": "ng serve your-project-name"
}

TIP

此方法仅作临时缓解，仍建议永久移除废弃属性以遵循最佳实践。

---

关键结论：defaultProject 是过时的配置项，直接删除即可解决该错误。升级后项目可通过显式指定项目名来管理多项目工作流。Angular CLI 将持续优化配置机制，建议定期检查 官方更新日志 了解废弃 API 变动。