Learn-skills.dev shared-monorepo-nx
Nx monorepo build system — workspace configuration, project graph, task pipelines, caching, generators, plugins, and release management
git clone https://github.com/NeverSight/learn-skills.dev
T=$(mktemp -d) && git clone --depth=1 https://github.com/NeverSight/learn-skills.dev "$T" && mkdir -p ~/.claude/skills && cp -r "$T/data/skills-md/agents-inc/skills/shared-monorepo-nx" ~/.claude/skills/neversight-learn-skills-dev-shared-monorepo-nx && rm -rf "$T"
data/skills-md/agents-inc/skills/shared-monorepo-nx/SKILL.mdMonorepo Orchestration with Nx
Quick Guide: Nx 22 for monorepo orchestration and build intelligence. Project graph for dependency analysis. Task pipelines with topological ordering and
. Local computation caching + Nx Cloud remote caching for massive speed gains. Inferred tasks (Project Crystal) auto-detect targets from tool config files.dependsOnruns only what changed.nx affectedfor versioning, changelogs, and publishing. Generators scaffold code, executors run tasks.nx release
<critical_requirements>
CRITICAL: Before Using This Skill
All code must follow project conventions in CLAUDE.md (kebab-case, named exports, import ordering,
, named constants)import type
(You MUST enable caching with
on cacheable targets — builds, tests, linting — and set "cache": true
or omit for side-effect tasks like "cache": false
)serve
(You MUST define
in targetDefaults for build tasks to ensure topological ordering across the project graph)dependsOn: ["^build"]
(You MUST declare
and inputs
for cached targets so Nx knows what to hash and what to restore)outputs
(You MUST use inferred tasks (Project Crystal) as the default — only add
targets when overriding inferred configuration)project.json
(You MUST use
in CI to only run tasks for changed projects and their dependents)nx affected -t <target>
</critical_requirements>
Auto-detection: Nx workspace, nx.json, project.json, nx generate, nx affected, nx graph, nx release, @nx/ plugins, Nx Cloud, inferred tasks, Project Crystal, nx migrate, targetDefaults, namedInputs, nx run-many, nx serve
When to use:
- Setting up a new Nx monorepo or adding Nx to an existing repo
- Configuring task pipelines, caching, and dependency ordering in nx.json
- Generating projects, libraries, and components with Nx generators
- Running affected commands to optimize CI builds
- Configuring Nx Cloud for remote caching and distributed task execution
- Managing releases with
(versioning, changelogs, publishing)nx release - Setting up module federation for micro-frontend architectures
- Migrating between Nx versions with
nx migrate
When NOT to use:
- Single application with no shared libraries (standard build tools suffice)
- Projects already using Turborepo (do not mix monorepo orchestrators)
- Very small projects where Nx setup overhead exceeds benefits
- When all you need is
without task orchestrationnpm workspaces
Key patterns covered:
- Workspace setup and nx.json configuration
- Task pipelines with
andtargetDefaultsdependsOn - Local + remote caching strategies
- Inferred tasks (Project Crystal) and plugin system
- Affected commands and project graph
- Generators and executors
- Release management (
)nx release - Module federation for micro-frontends
Examples
- Workspace Setup — Directory structure, nx.json config
- Task Pipeline & Caching — dependsOn ordering, namedInputs, cache configuration, affected commands
- Generators — Built-in generators, custom generators, schemas, migrations
- CI & Release Management — GitHub Actions, Nx Cloud, release configuration, module federation
Additional resources:
- For CLI reference and decision frameworks, see reference.md
<philosophy>
Philosophy
Nx is a build intelligence platform for monorepos. Unlike simple task runners, Nx understands the structure of your codebase through the project graph — a directed acyclic graph of projects and their dependencies. This graph enables intelligent task scheduling, fine-grained caching, and affected analysis.
Nx's core value proposition: never run a task that has already been computed, and never run more tasks than necessary.
Key principles:
- Project graph first — Nx analyzes imports, configuration, and dependency relationships to build a graph of your workspace. Every feature (caching, affected, task pipelines) builds on this graph.
- Inferred configuration — Since Project Crystal (Nx 18+), plugins auto-detect tasks from tool configs (vite.config.ts, jest.config.ts, etc.), dramatically reducing boilerplate.
- Computation caching — Every task result is cached by default. Cache keys are computed from file inputs, environment, and dependency graph position.
- Affected analysis —
uses git diff + project graph to determine the minimum set of projects impacted by a change.nx affected
When to use Nx:
- Monorepos with multiple apps sharing libraries
- Teams needing remote cache sharing across developers and CI
- Large codebases where build/test times are a bottleneck
- Projects with complex task dependency chains requiring topological ordering
- Organizations wanting enforced module boundaries between teams
When NOT to use Nx:
- Single-app projects with no shared code (Vite/esbuild directly)
- Polyrepo setups where repos are intentionally independent
- Projects already using Turborepo (pick one orchestrator)
- Prototypes or very small projects where setup cost exceeds benefit
<patterns>
Core Patterns
Pattern 1: Workspace Setup and nx.json Configuration
The
nx.json file is the central configuration for task behavior, caching, plugins, and workspace-wide defaults.
{ "$schema": "./node_modules/nx/schemas/nx-schema.json", "namedInputs": { "production": [ "default", "!{projectRoot}/**/*.spec.ts", "!{projectRoot}/**/*.test.ts" ] }, "targetDefaults": { "build": { "dependsOn": ["^build"], "inputs": ["production", "^production"], "outputs": ["{projectRoot}/dist"], "cache": true } }, "plugins": [ { "plugin": "@nx/vite/plugin", "options": { "buildTargetName": "build" } } ] }
Why good:
namedInputs exclude test files from build cache keys, dependsOn: ["^build"] enforces topological ordering, plugins auto-detect targets
For complete nx.json examples, see examples/core.md.
Pattern 2: Task Pipelines and Dependency Ordering
Task pipelines define execution order using the
dependsOn property. The ^ prefix means "run this target on dependencies first" (topological ordering).
{ "targetDefaults": { "build": { "dependsOn": ["^build"] }, "test": { "dependsOn": ["build"] }, "e2e": { "dependsOn": [{ "target": "serve", "params": "ignore" }] }, "serve": { "continuous": true, "cache": false } } }
— Run"^build"
on dependency projects first (topological)build
— Run"build"
on the same project firstbuild
— Object form, prevents parameter forwarding{ "target": "serve", "params": "ignore" }
— Long-running task (Nx 21+), dependents start immediately"continuous": true
For pipeline examples and ordering walkthrough, see examples/tasks.md.
Pattern 3: Computation Caching (Local + Remote)
Nx caches task results locally by default. When inputs have not changed, cached outputs are restored instantly. Nx Cloud extends this with remote caching shared across the team.
{ "namedInputs": { "production": ["default", "!{projectRoot}/**/*.test.ts"] }, "targetDefaults": { "build": { "inputs": ["production", "^production"], "outputs": ["{projectRoot}/dist"], "cache": true }, "test": { "inputs": [ "default", "^production", { "externalDependencies": ["vitest"] } ], "cache": true }, "serve": { "cache": false, "continuous": true } } }
Key concepts:
production excludes test files from build cache keys, externalDependencies invalidates cache on test runner upgrades, cache: false on serve prevents caching dev servers
For cache strategies and namedInputs scenarios, see examples/tasks.md.
Pattern 4: Inferred Tasks (Project Crystal)
Since Nx 18, plugins automatically infer tasks from tool configuration files. For example,
@nx/vite/plugin detects vite.config.ts and creates build, serve, and test targets without any project.json.
{ "plugins": [ { "plugin": "@nx/vite/plugin", "options": { "buildTargetName": "build", "testTargetName": "test" } }, { "plugin": "@nx/jest/plugin", "include": ["packages/**/*"], "exclude": ["**/*-e2e/**/*"] } ] }
Configuration Precedence
1. Plugin inferred config (lowest priority) 2. targetDefaults in nx.json 3. project.json or package.json targets (highest priority)
When to use: Always prefer inferred tasks as default. Only add
project.json targets when overriding:
{ "name": "my-app", "targets": { "build": { "outputs": ["{projectRoot}/custom-dist"] } } }
Pattern 5: Affected Commands and Project Graph
nx affected uses git diff combined with the project graph to determine which projects need to be rebuilt/tested. This is the primary CI optimization.
npx nx affected -t test # Test affected projects npx nx affected -t build test lint # Multiple targets npx nx affected -t test --base=origin/main --head=HEAD # Explicit base npx nx affected --graph # Visualize impact
Why good: Only runs tasks for changed projects and their dependents
For CI pipeline examples with affected commands, see examples/ci.md.
Pattern 6: Generators (Code Scaffolding)
Generators create and modify code from templates. Set defaults in nx.json
"generators" to enforce organizational standards (bundler, test runner, style format). Use npx nx g <plugin>:<generator> to scaffold projects, libraries, and components.
npx nx g @nx/react:library my-lib --directory=libs/shared/my-lib npx nx g @nx/workspace:move --project=my-lib --destination=packages/shared/my-lib
For built-in generators, custom generator implementation, and generator defaults, see examples/generators.md.
Pattern 7: Release Management (nx release)
nx release orchestrates versioning, changelog generation, and publishing. Supports fixed and independent strategies.
{ "release": { "projects": ["packages/*"], "projectsRelationship": "independent", "version": { "conventionalCommits": true, "updateDependents": "always" }, "changelog": { "projectChangelogs": { "file": "{projectRoot}/CHANGELOG.md", "createRelease": "github" } }, "releaseTag": { "pattern": "{projectName}-v{version}" }, "git": { "commit": true, "tag": true } } }
npx nx release # Full release npx nx release --dry-run # Preview npx nx release plan minor -m "Add new API endpoints" # Version plans
For release configuration examples, see examples/ci.md.
Pattern 8: Module Federation (Micro-Frontends)
Nx provides first-class module federation support, enabling independent teams to deploy separately.
npx nx g @nx/react:host shell --directory=apps/shell npx nx g @nx/react:remote shop --directory=apps/shop --host=shell npx nx serve shell --devRemotes=shop,cart
When to use: Large teams with independent deployment cadences. When to avoid: Small teams where a single app suffices.
For module federation examples, see examples/ci.md.
</patterns><performance>
Performance Optimization
Cache Hit Metrics (typical monorepo with 20+ projects):
- First build: ~60s (no cache, full workspace)
- Cached build: ~1s (local cache hit, 98% faster)
- Affected build: ~15s (only changed projects, 75% faster)
- Remote cache hit: ~5s (download + restore from Nx Cloud)
- Team savings: 10-40 hours/week with Nx Cloud enabled
Optimization Strategies:
- Use
to exclude test/spec files from build cache keysnamedInputs - Set
precisely to only cache what is needed (exclude framework caches)outputs - Enable Nx Cloud for remote caching — one developer's cache hit benefits the team
- Use
in CI to skip unchanged projects entirelynx affected - Configure
in nx.json to control concurrencyparallel - Use
to prevent unbounded cache growthmaxCacheSize
</performance>npx nx build my-app --skip-nx-cache # Skip cache for a specific run npx nx reset # Clear all cached artifacts
<decision_framework>
Decision Framework
When to Use Nx
Is this a monorepo with shared code? ├─ NO → Standard build tools (Vite, esbuild, tsc) └─ YES → Do you need task orchestration and caching? ├─ NO → npm/pnpm/bun workspaces alone may suffice └─ YES → Do you need a project graph and affected analysis? ├─ YES → Nx └─ NO → Turborepo may be simpler
Nx vs Turborepo
Which monorepo tool? ├─ Need project graph analysis → Nx ├─ Need generators and code scaffolding → Nx ├─ Need module federation support → Nx ├─ Need distributed task execution (Nx Agents) → Nx ├─ Need simplest possible config → Turborepo ├─ Already using Vercel ecosystem → Turborepo └─ Need polyglot support (.NET, Java, Gradle) → Nx
Where to Put New Code
New code to write? ├─ Deployable application → apps/ ├─ Shared across 2+ apps → libs/ or packages/ ├─ App-specific code → Feature folder within the app ├─ Build tooling or generators → tools/ └─ Shared configuration → packages/ (e.g., eslint-config, tsconfig)
Fixed vs Independent Releases
How to version packages? ├─ All packages always release together → "fixed" (default) ├─ Packages have different consumers → "independent" ├─ Internal-only packages → Fixed (simpler) └─ Published to npm with different audiences → Independent
For comprehensive decision trees and anti-patterns, see reference.md.
</decision_framework>
<integration>
Integration Guide
Nx integrates with your tools through its plugin system. Each
@nx/* plugin detects its tool's config file and infers targets automatically (Project Crystal). You do not need to manually configure targets for supported tools -- install the plugin, add it to nx.json plugins array, and inferred tasks appear.
Plugin model:
@nx/<tool>/plugin reads the tool's config file (e.g., vite.config.ts, eslint.config.js) and registers targets. Use nx show project <name> to see what a plugin inferred.
Package managers: Nx works with npm, pnpm, Bun, or Yarn workspaces. No lock-in.
Nx Cloud: Remote caching (Nx Replay) and distributed task execution (Nx Agents). Connect with
nx connect.
Replaces / Conflicts with:
- Turborepo: Similar monorepo orchestrator -- choose one, not both
- Lerna: Nx subsumes Lerna's functionality (Nx team maintains Lerna since v6)
<red_flags>
RED FLAGS
High Priority Issues:
- Missing
for build targets — dependencies may not build first, causing import errorsdependsOn: ["^build"] - Missing
on cacheable targets — every run recomputes from scratch, negating Nx's primary valuecache: true - Caching long-running tasks (dev servers, watch mode) —
andserve
must havedevcache: false - Running
in CI instead ofnx run-many -t test
— wastes compute on unchanged projectsnx affected -t test - Missing
on cached targets — Nx cannot determine when cache is stale, leading to incorrect cache hitsinputs
Medium Priority Issues:
- Not using inferred tasks — manually defining every target in
when plugins can auto-detectproject.json - Missing
for production — test file changes invalidate build caches unnecessarilynamedInputs - Not connecting to Nx Cloud — every developer rebuilds everything locally instead of sharing cache
- Overly broad
— caching framework cache directories (outputs
) bloats cache storage.next/cache/
Common Mistakes:
- Using
(same project) whendependsOn: ["build"]
(dependency projects) was intendeddependsOn: ["^build"] - Forgetting to set
on serve tasks — dependent e2e tasks wait forever for serve to "complete"continuous: true - Running
withoutnx migrate
— migrations are generated but not applied--run-migrations - Not setting
in nx.json — affected analysis defaults todefaultBase
which may not be your branchmain
Gotchas & Edge Cases:
runs the target on dependency projects;dependsOn: ["^task"]
runs it on the same project. Mixing these up causes subtle ordering bugs.dependsOn: ["task"]
requires git history — in CI, ensurenx affected
(full history) or at leastfetch-depth: 0
for shallow comparison.fetch-depth: 2- Plugin order in
matters — when multiple plugins create the same target name, the last plugin wins.nx.json
means unlimited, not zero. To disable caching, usemaxCacheSize: "0"
on targets.cache: false- Nx merges
andproject.json
scripts. If both define the same target,package.json
takes precedence for configuration butproject.json
scripts are still registered as targets.package.json
clears the local cache AND shuts down the Nx Daemon. Usenx reset
to preserve the daemon.nx reset --only-cache
</red_flags>
<critical_reminders>
CRITICAL REMINDERS
All code must follow project conventions in CLAUDE.md
(You MUST enable caching with
on cacheable targets — builds, tests, linting — and set "cache": true
or omit for side-effect tasks like "cache": false
)serve
(You MUST define
in targetDefaults for build tasks to ensure topological ordering across the project graph)dependsOn: ["^build"]
(You MUST declare
and inputs
for cached targets so Nx knows what to hash and what to restore)outputs
(You MUST use inferred tasks (Project Crystal) as the default — only add
targets when overriding inferred configuration)project.json
(You MUST use
in CI to only run tasks for changed projects and their dependents)nx affected -t <target>
Failure to follow these rules will cause incorrect builds, stale caches, wasted CI compute, and broken task ordering.
</critical_reminders>