mcpField
N
nx-workspace

nx-workspace

github.com/tech-leads-club开发7.1k197 次安装今天更新
代码仓库

关于 nx-workspace

面向开发者和编码 Agent 的 Nx 工作区管理技能，适用于包含应用与库的工作区。它提供项目发现、解析后配置查询、任务执行、变更影响分析及工作区实践指南。

主要功能

  1. 01列出并筛选工作区项目
  2. 02查看解析后的项目配置
  3. 03运行项目及受影响任务
  4. 04查看依赖关系图
  5. 05查找配置与 CI 指南

适用场景

  1. 01盘点应用和库
  2. 02检查项目可用目标
  3. 03运行变更项目的测试

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tech-leads-club/agent-skills --skill nx-workspace

安装后在 Claude Code 中输入/nx-workspace确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

reference/
best-practices.md
ci-cd.md
commands.md
configuration.md

详细介绍

Nx 工作区管理

快速入门

浏览工作区：nx show projects 和 nx show project <name> --json
运行任务：nx <target> <project>（例如，nx build my-app）
受影响分析：nx show projects --affected 或 nx affected -t <target>

注意：如果未全局安装 nx，请在命令前加上 npx/pnpx/yarn。

核心命令

列出和浏览项目
# List all projects
nx show projects

# Filter by type, pattern, or target
nx show projects --type app
nx show projects --projects "apps/*"
nx show projects --withTarget build

# Find affected projects
nx show projects --affected --base=main
获取项目信息

重要：始终使用 nx show project <name> --json 获取完整的解析后配置。不要直接读取 project.json——它只包含部分配置。

# Get full configuration
nx show project my-app --json

# Extract targets
nx show project my-app --json | jq '.targets | keys'

配置架构：

  • 工作区：node_modules/nx/schemas/nx-schema.json
  • 项目：node_modules/nx/schemas/project-schema.json
运行任务
# Run specific project
nx build web --configuration=production

# Run affected
nx affected -t test --base=main

# View dependency graph
nx graph

工作区架构

workspace/
├── apps/              # Deployable applications
├── libs/              # Shared libraries
│   ├── shared/        # Shared across scopes
│   └── feature/       # Feature-specific
├── nx.json            # Workspace configuration
└── tools/             # Custom executors/generators
库类型
类型用途示例
feature业务逻辑、智能组件feature-auth
ui展示型组件ui-buttons
data-accessAPI 调用、状态管理data-access-users
util纯函数、辅助工具util-formatting

详细资源

配置：参阅 reference/configuration.md，了解：

  • nx.json 模板和选项
  • project.json 结构
  • 模块边界规则
  • 远程缓存设置

命令：参阅 reference/commands.md，了解：

  • 完整的命令参考
  • 高级筛选选项
  • 常见工作流

CI/CD：参阅 reference/ci-cd.md，了解：

  • GitHub Actions 配置
  • GitLab CI 设置
  • Jenkins、Azure Pipelines、CircleCI 示例
  • 流水线中的受影响命令

最佳实践：参阅 reference/best-practices.md，了解：

  • 应做和不应做的事项
  • 完整的故障排除指南
  • 性能优化
  • 迁移指南

常见工作流

“这个工作区里有什么？”

nx show projects --type app  # List applications
nx show projects --type lib  # List libraries

“如何运行项目 X？”

nx show project X --json | jq '.targets | keys'

“有哪些变更？”

nx show projects --affected --base=main

快速故障排除

  • 未显示目标：使用 nx show project <name> --json，不要使用 project.json
  • 受影响分析无法正常工作：确保有可用的 Git 历史记录（在 CI 中设置 fetch-depth: 0）
  • 缓存问题：运行 nx reset

详细的故障排除信息，请参阅 reference/best-practices.md。

评论

支持 Markdown