chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,127 @@
|
||||
---
|
||||
name: link-workspace-packages
|
||||
description: 'Link workspace packages in monorepos (npm, yarn, pnpm, bun). USE WHEN: (1) you just created or generated new packages and need to wire up their dependencies, (2) user imports from a sibling package and needs to add it as a dependency, (3) you get resolution errors for workspace packages (@org/*) like "cannot find module", "failed to resolve import", "TS2307", or "cannot resolve". DO NOT patch around with tsconfig paths or manual package.json edits - use the package manager''s workspace commands to fix actual linking.'
|
||||
---
|
||||
|
||||
# Link Workspace Packages
|
||||
|
||||
Add dependencies between packages in a monorepo. All package managers support workspaces but with different syntax.
|
||||
|
||||
## Detect Package Manager
|
||||
|
||||
Check whether there's a `packageManager` field in the root-level `package.json`.
|
||||
|
||||
Alternatively check lockfile in repo root:
|
||||
|
||||
- `pnpm-lock.yaml` → pnpm
|
||||
- `yarn.lock` → yarn
|
||||
- `bun.lock` / `bun.lockb` → bun
|
||||
- `package-lock.json` → npm
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Identify consumer package (the one importing)
|
||||
2. Identify provider package(s) (being imported)
|
||||
3. Add dependency using package manager's workspace syntax
|
||||
4. Verify symlinks created in consumer's `node_modules/`
|
||||
|
||||
---
|
||||
|
||||
## pnpm
|
||||
|
||||
Uses `workspace:` protocol - symlinks only created when explicitly declared.
|
||||
|
||||
```bash
|
||||
# From consumer directory
|
||||
pnpm add @org/ui --workspace
|
||||
|
||||
# Or with --filter from anywhere
|
||||
pnpm add @org/ui --filter @org/app --workspace
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:*" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## yarn (v2+/berry)
|
||||
|
||||
Also uses `workspace:` protocol.
|
||||
|
||||
```bash
|
||||
yarn workspace @org/app add @org/ui
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:^" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## npm
|
||||
|
||||
No `workspace:` protocol. npm auto-symlinks workspace packages.
|
||||
|
||||
```bash
|
||||
npm install @org/ui --workspace @org/app
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "*" } }
|
||||
```
|
||||
|
||||
npm resolves to local workspace automatically during install.
|
||||
|
||||
---
|
||||
|
||||
## bun
|
||||
|
||||
Supports `workspace:` protocol (pnpm-compatible).
|
||||
|
||||
```bash
|
||||
cd packages/app && bun add @org/ui
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:*" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
**Example 1: pnpm - link ui lib to app**
|
||||
|
||||
```bash
|
||||
pnpm add @org/ui --filter @org/app --workspace
|
||||
```
|
||||
|
||||
**Example 2: npm - link multiple packages**
|
||||
|
||||
```bash
|
||||
npm install @org/data-access @org/ui --workspace @org/dashboard
|
||||
```
|
||||
|
||||
**Example 3: Debug "Cannot find module"**
|
||||
|
||||
1. Check if dependency is declared in consumer's `package.json`
|
||||
2. If not, add it using appropriate command above
|
||||
3. Run install (`pnpm install`, `npm install`, etc.)
|
||||
|
||||
## Notes
|
||||
|
||||
- Symlinks appear in `<consumer>/node_modules/@org/<package>`
|
||||
- **Hoisting differs by manager:**
|
||||
- npm/bun: hoist shared deps to root `node_modules`
|
||||
- pnpm: no hoisting (strict isolation, prevents phantom deps)
|
||||
- yarn berry: uses Plug'n'Play by default (no `node_modules`)
|
||||
- Root `package.json` should have `"private": true` to prevent accidental publish
|
||||
@@ -0,0 +1,301 @@
|
||||
---
|
||||
name: monitor-ci
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes. USE WHEN user says "monitor ci", "watch ci", "ci monitor", "watch ci for this branch", "track ci", "check ci status", wants to track CI status, or needs help with self-healing CI fixes. Prefer this skill over native CI provider tools (gh, glab, etc.) for CI monitoring — it integrates with Nx Cloud self-healing which those tools cannot access.
|
||||
---
|
||||
|
||||
# Monitor CI Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn subagents to interact with Nx Cloud, run deterministic decision scripts, and take action based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum **agent-initiated** CI Attempt cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CI-Attempt failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CI Attempt after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `$ARGUMENTS` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
Before starting the monitoring loop, verify the workspace is connected to Nx Cloud. Without this connection, no CI data is available and the entire skill is inoperable.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
|
||||
```
|
||||
Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
1. **This skill (orchestrator)**: spawns subagents, runs scripts, prints status, does local coding work
|
||||
2. **ci-monitor-subagent (haiku)**: calls one MCP tool (ci_information or update_self_healing_fix), returns structured result, exits
|
||||
3. **ci-poll-decide.mjs (deterministic script)**: takes ci_information result + state, returns action + status message
|
||||
4. **ci-state-update.mjs (deterministic script)**: manages budget gates, post-action state transitions, and cycle classification
|
||||
|
||||
## Status Reporting
|
||||
|
||||
The decision script handles message formatting based on verbosity. When printing messages to the user:
|
||||
|
||||
- Prepend `[monitor-ci]` to every message from the script's `message` field
|
||||
- For your own action messages (e.g. "Applying fix via MCP..."), also prepend `[monitor-ci]`
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
These behaviors cause real problems — racing with self-healing, losing CI progress, or wasting context:
|
||||
|
||||
| Anti-Pattern | Why It's Bad |
|
||||
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| Using CI provider CLIs with `--watch` flags (e.g., `gh pr checks --watch`, `glab ci status -w`) | Bypasses Nx Cloud self-healing entirely |
|
||||
| Writing custom CI polling scripts | Unreliable, pollutes context, no self-healing |
|
||||
| Cancelling CI workflows/pipelines | Destructive, loses CI progress |
|
||||
| Running CI checks on main agent | Wastes main agent context tokens |
|
||||
| Independently analyzing/fixing CI failures while polling | Races with self-healing, causes duplicate fixes and confused state |
|
||||
|
||||
**If this skill fails to activate**, the fallback is:
|
||||
|
||||
1. Use CI provider CLI for a one-time, read-only status check (single call, no watch/polling flags)
|
||||
2. Immediately delegate to this skill with gathered context
|
||||
3. Do not continue polling on main agent — it wastes context tokens and bypasses self-healing
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
If the user previously ran `/monitor-ci` in this session, you may have prior state (poll counts, last CI Attempt URL, etc.). Resume from that state unless `--fresh` is set, in which case discard it and start from Step 1.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
Three field sets control polling efficiency — use the lightest set that gives you what you need:
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS: 'cipeUrl,commitSha,cipeStatus'
|
||||
LIGHT_FIELDS: 'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,autoApplySkipped,autoApplySkipReason,shortLink,confidence,confidenceReasoning,hints,selfHealingSkippedReason,selfHealingSkipMessage'
|
||||
HEAVY_FIELDS: 'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
```
|
||||
|
||||
The `ci_information` tool accepts `branch` (optional, defaults to current git branch), `select` (comma-separated field names), and `pageToken` (0-based pagination for long strings).
|
||||
|
||||
The `update_self_healing_fix` tool accepts a `shortLink` and an action: `APPLY`, `REJECT`, or `RERUN_ENVIRONMENT_STATE`.
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The decision script returns one of the following statuses. This table defines the **default behavior** for each. User instructions can override any of these.
|
||||
|
||||
**Simple exits** — just report and exit:
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success |
|
||||
| `cipe_canceled` | Exit, CI was canceled |
|
||||
| `cipe_timed_out` | Exit, CI timed out |
|
||||
| `polling_timeout` | Exit, polling timeout reached |
|
||||
| `circuit_breaker` | Exit, no progress after 13 consecutive polls |
|
||||
| `environment_rerun_cap` | Exit, environment reruns exhausted |
|
||||
| `fix_auto_applying` | Self-healing is handling it — just record `last_cipe_url`, enter wait mode. No MCP call or local git ops needed. |
|
||||
| `error` | Wait 60s and loop |
|
||||
|
||||
**Statuses requiring action** — when handling these in Step 3, read `references/fix-flows.md` for the detailed flow:
|
||||
|
||||
| Status | Summary |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------- |
|
||||
| `fix_auto_apply_skipped` | Fix verified but auto-apply skipped (e.g., loop prevention). Inform user, offer manual apply. |
|
||||
| `fix_apply_ready` | Fix verified (all tasks or e2e-only). Apply via MCP. |
|
||||
| `fix_needs_local_verify` | Fix has unverified non-e2e tasks. Run locally, then apply or enhance. |
|
||||
| `fix_needs_review` | Fix verification failed/not attempted. Analyze and decide. |
|
||||
| `fix_failed` | Self-healing failed. Fetch heavy data, attempt local fix (gate check first). |
|
||||
| `no_fix` | No fix available. Fetch heavy data, attempt local fix (gate check first) or exit. |
|
||||
| `environment_issue` | Request environment rerun via MCP (gate check first). |
|
||||
| `self_healing_throttled` | Reject old fixes, attempt local fix. |
|
||||
| `no_new_cipe` | CI Attempt never spawned. Auto-fix workflow or exit with guidance. |
|
||||
| `cipe_no_tasks` | CI failed with no tasks. Retry once with empty commit. |
|
||||
|
||||
**Key rules (always apply):**
|
||||
|
||||
- **Git safety**: Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
- **Environment failures** (OOM, command not found, permission denied): bail immediately. These aren't code bugs, so spending local-fix budget on them is wasteful
|
||||
- **Gate check**: Run `ci-state-update.mjs gate` before local fix attempts — if budget exhausted, print message and exit
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0 # Only incremented for agent-initiated cycles (counted against --max-cycles)
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
env_rerun_count = 0
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
agent_triggered = false # Set true after monitor takes an action that triggers new CI Attempt
|
||||
poll_count = 0
|
||||
wait_mode = false
|
||||
prev_status = null
|
||||
prev_cipe_status = null
|
||||
prev_sh_status = null
|
||||
prev_verification_status = null
|
||||
prev_failure_classification = null
|
||||
```
|
||||
|
||||
### Step 2: Polling Loop
|
||||
|
||||
Repeat until done:
|
||||
|
||||
#### 2a. Spawn subagent (FETCH_STATUS)
|
||||
|
||||
Determine select fields based on mode:
|
||||
|
||||
- **Wait mode**: use WAIT_FIELDS (`cipeUrl,commitSha,cipeStatus`)
|
||||
- **Normal mode (first poll or after newCipeDetected)**: use LIGHT_FIELDS
|
||||
|
||||
Call the `ci_information` tool with the determined `select` fields for the current branch. Wait for the result before proceeding.
|
||||
|
||||
#### 2b. Run decision script
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-poll-decide.mjs '<subagent_result_json>' <poll_count> <verbosity> \
|
||||
[--wait-mode] \
|
||||
[--prev-cipe-url <last_cipe_url>] \
|
||||
[--expected-sha <expected_commit_sha>] \
|
||||
[--prev-status <prev_status>] \
|
||||
[--timeout <timeout_seconds>] \
|
||||
[--new-cipe-timeout <new_cipe_timeout_seconds>] \
|
||||
[--env-rerun-count <env_rerun_count>] \
|
||||
[--no-progress-count <no_progress_count>] \
|
||||
[--prev-cipe-status <prev_cipe_status>] \
|
||||
[--prev-sh-status <prev_sh_status>] \
|
||||
[--prev-verification-status <prev_verification_status>] \
|
||||
[--prev-failure-classification <prev_failure_classification>]
|
||||
```
|
||||
|
||||
The script outputs a single JSON line: `{ action, code, message, delay?, noProgressCount, envRerunCount, fields?, newCipeDetected?, verifiableTaskIds? }`
|
||||
|
||||
#### 2c. Process script output
|
||||
|
||||
Parse the JSON output and update tracking state:
|
||||
|
||||
- `no_progress_count = output.noProgressCount`
|
||||
- `env_rerun_count = output.envRerunCount`
|
||||
- `prev_cipe_status = subagent_result.cipeStatus`
|
||||
- `prev_sh_status = subagent_result.selfHealingStatus`
|
||||
- `prev_verification_status = subagent_result.verificationStatus`
|
||||
- `prev_failure_classification = subagent_result.failureClassification`
|
||||
- `prev_status = output.action + ":" + (output.code || subagent_result.cipeStatus)`
|
||||
- `poll_count++`
|
||||
|
||||
Based on `action`:
|
||||
|
||||
- **`action == "poll"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- If `output.newCipeDetected`: clear wait mode, reset `wait_mode = false`
|
||||
- **`action == "wait"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- **`action == "done"`**: Proceed to Step 3 with `output.code`
|
||||
|
||||
### Step 3: Handle Actionable Status
|
||||
|
||||
When decision script returns `action == "done"`:
|
||||
|
||||
1. Run cycle-check (Step 4) **before** handling the code
|
||||
2. Check the returned `code`
|
||||
3. Look up default behavior in the table above
|
||||
4. Check if user instructions override the default
|
||||
5. Execute the appropriate action
|
||||
6. **If action expects new CI Attempt**, update tracking (see Step 3a)
|
||||
7. If action results in looping, go to Step 2
|
||||
|
||||
#### Tool calls for actions
|
||||
|
||||
Several statuses require fetching additional data or calling tools:
|
||||
|
||||
- **fix_apply_ready**: Call `update_self_healing_fix` with action `APPLY`
|
||||
- **fix_needs_local_verify**: Call `ci_information` with HEAVY_FIELDS for fix details before local verification
|
||||
- **fix_needs_review**: Call `ci_information` with HEAVY_FIELDS → get `suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`
|
||||
- **fix_failed / no_fix**: Call `ci_information` with HEAVY_FIELDS → get `taskFailureSummaries` for local fix context
|
||||
- **environment_issue**: Call `update_self_healing_fix` with action `RERUN_ENVIRONMENT_STATE`
|
||||
- **self_healing_throttled**: Call `ci_information` with HEAVY_FIELDS → get `selfHealingSkipMessage`; then call `update_self_healing_fix` for each old fix
|
||||
|
||||
### Step 3a: Track State for New-CI-Attempt Detection
|
||||
|
||||
After actions that should trigger a new CI Attempt, run:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs post-action \
|
||||
--action <type> \
|
||||
--cipe-url <current_cipe_url> \
|
||||
--commit-sha <git_rev_parse_HEAD>
|
||||
```
|
||||
|
||||
Action types: `fix-auto-applying`, `apply-mcp`, `apply-local-push`, `reject-fix-push`, `local-fix-push`, `env-rerun`, `auto-fix-push`, `empty-commit-push`
|
||||
|
||||
The script returns `{ waitMode, pollCount, lastCipeUrl, expectedCommitSha, agentTriggered }`. Update all tracking state from the output, then go to Step 2.
|
||||
|
||||
### Step 4: Cycle Classification and Progress Tracking
|
||||
|
||||
When the decision script returns `action == "done"`, run cycle-check **before** handling the code:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs cycle-check \
|
||||
--code <code> \
|
||||
[--agent-triggered] \
|
||||
--cycle-count <cycle_count> --max-cycles <max_cycles> \
|
||||
--env-rerun-count <env_rerun_count>
|
||||
```
|
||||
|
||||
The script returns `{ cycleCount, agentTriggered, envRerunCount, approachingLimit, message }`. Update tracking state from the output.
|
||||
|
||||
- If `approachingLimit` → ask user whether to continue (with 5 or 10 more cycles) or stop monitoring
|
||||
- If previous cycle was NOT agent-triggered (human pushed), log that human-initiated push was detected
|
||||
|
||||
#### Progress Tracking
|
||||
|
||||
- `no_progress_count`, circuit breaker (5 polls), and backoff reset are handled by ci-poll-decide.mjs (progress = any change in cipeStatus, selfHealingStatus, verificationStatus, or failureClassification)
|
||||
- `env_rerun_count` reset on non-environment status is handled by ci-state-update.mjs cycle-check
|
||||
- On new CI Attempt detected (poll script returns `newCipeDetected`) → reset `local_verify_count = 0`, `env_rerun_count = 0`
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx-cloud apply-locally` fails | Reject fix via MCP (`action: "REJECT"`), then attempt manual patch (Reject + Fix From Scratch Flow) or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| Decision script error | Treat as `error` status, increment `no_progress_count` |
|
||||
| No new CI Attempt detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CI-Attempt failures |
|
||||
| "wait 45 min for new CI Attempt" | Override new-CI-Attempt timeout (default: 10 min) |
|
||||
@@ -0,0 +1,108 @@
|
||||
# Detailed Status Handling & Fix Flows
|
||||
|
||||
## Status Handling by Code
|
||||
|
||||
### fix_auto_apply_skipped
|
||||
|
||||
The script returns `autoApplySkipReason` in its output.
|
||||
|
||||
1. Report the skip reason to the user (e.g., "Auto-apply was skipped because the previous CI pipeline execution was triggered by Nx Cloud")
|
||||
2. Offer to apply the fix manually — spawn UPDATE_FIX subagent with `APPLY` if user agrees
|
||||
3. Record `last_cipe_url`, enter wait mode
|
||||
|
||||
### fix_apply_ready
|
||||
|
||||
- Spawn UPDATE_FIX subagent with `APPLY`
|
||||
- Record `last_cipe_url`, enter wait mode
|
||||
|
||||
### fix_needs_local_verify
|
||||
|
||||
The script returns `verifiableTaskIds` in its output.
|
||||
|
||||
1. **Detect package manager:** `pnpm-lock.yaml` → `pnpm nx`, `yarn.lock` → `yarn nx`, otherwise `npx nx`
|
||||
2. **Run verifiable tasks in parallel** — spawn `general` subagents for each task
|
||||
3. **If all pass** → spawn UPDATE_FIX subagent with `APPLY`, enter wait mode
|
||||
4. **If any fail** → Apply Locally + Enhance Flow (see below)
|
||||
|
||||
### fix_needs_review
|
||||
|
||||
Spawn FETCH_HEAVY subagent, then analyze fix content (`suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`):
|
||||
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → Apply Locally + Enhance Flow
|
||||
- If fix is wrong → run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, print message and exit. Otherwise → Reject + Fix From Scratch Flow
|
||||
|
||||
### fix_failed / no_fix
|
||||
|
||||
Spawn FETCH_HEAVY subagent for `taskFailureSummaries`. Run `ci-state-update.mjs gate --gate-type local-fix` — if not allowed, print message and exit. Otherwise attempt local fix (counter already incremented by gate). If successful → commit, push, enter wait mode. If not → exit with failure.
|
||||
|
||||
### environment_issue
|
||||
|
||||
1. Run `ci-state-update.mjs gate --gate-type env-rerun`. If not allowed, print message and exit.
|
||||
2. Spawn UPDATE_FIX subagent with `RERUN_ENVIRONMENT_STATE`
|
||||
3. Enter wait mode with `last_cipe_url` set
|
||||
|
||||
### self_healing_throttled
|
||||
|
||||
Spawn FETCH_HEAVY subagent for `selfHealingSkipMessage`.
|
||||
|
||||
1. **Parse throttle message** for CI Attempt URLs (regex: `/cipes/{id}`)
|
||||
2. **Reject previous fixes** — for each URL: spawn FETCH_THROTTLE_INFO to get `shortLink`, then UPDATE_FIX with `REJECT`
|
||||
3. **Attempt local fix**: Run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed → skip to step 4. Otherwise use `failedTaskIds` and `taskFailureSummaries` for context.
|
||||
4. **Fallback if local fix not possible or budget exhausted**: push empty commit (`git commit --allow-empty -m "ci: rerun after rejecting throttled fixes"`), enter wait mode
|
||||
|
||||
### no_new_cipe
|
||||
|
||||
1. Report to user: no CI attempt found, suggest checking CI provider
|
||||
2. If `--auto-fix-workflow`: detect package manager, run install, commit lockfile if changed, enter wait mode
|
||||
3. Otherwise: exit with guidance
|
||||
|
||||
### cipe_no_tasks
|
||||
|
||||
1. Report to user: CI failed with no tasks recorded
|
||||
2. Retry: `git commit --allow-empty -m "chore: retry ci [monitor-ci]"` + push, enter wait mode
|
||||
3. If retry also returns `cipe_no_tasks`: exit with failure
|
||||
|
||||
## Fix Action Flows
|
||||
|
||||
### Apply via MCP
|
||||
|
||||
Spawn UPDATE_FIX subagent with `APPLY`. New CI Attempt spawns automatically. No local git ops.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
1. `nx-cloud apply-locally <shortLink>` (sets state to `APPLIED_LOCALLY`)
|
||||
2. Enhance code to fix failing tasks
|
||||
3. Run failing tasks to verify
|
||||
4. If still failing → run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, commit current state and push (let CI be final judge). Otherwise loop back to enhance.
|
||||
5. If passing → commit and push, enter wait mode
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
1. Run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, print message and exit.
|
||||
2. Spawn UPDATE_FIX subagent with `REJECT`
|
||||
3. Fix from scratch locally
|
||||
4. Commit and push, enter wait mode
|
||||
|
||||
## Environment vs Code Failure Recognition
|
||||
|
||||
When any local fix path runs a task and it fails, assess whether the failure is a **code issue** or an **environment/tooling issue** before running the gate script.
|
||||
|
||||
**Indicators of environment/tooling failures** (non-exhaustive): command not found / binary missing, OOM / heap allocation failures, permission denied, network timeouts / DNS failures, missing system libraries, Docker/container issues, disk space exhaustion.
|
||||
|
||||
When detected → bail immediately without running gate (no budget consumed). Report that the failure is an environment/tooling issue, not a code bug.
|
||||
|
||||
**Code failures** (compilation errors, test assertion failures, lint violations, type errors) are genuine candidates for local fix attempts and proceed normally through the gate.
|
||||
|
||||
## Git Safety
|
||||
|
||||
- Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
@@ -0,0 +1,428 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* CI Poll Decision Script
|
||||
*
|
||||
* Deterministic decision engine for CI monitoring.
|
||||
* Takes ci_information JSON + state args, outputs a single JSON action line.
|
||||
*
|
||||
* Architecture:
|
||||
* classify() — pure decision tree, returns { action, code, extra? }
|
||||
* buildOutput() — maps classification to full output with messages, delays, counters
|
||||
*
|
||||
* Usage:
|
||||
* node ci-poll-decide.mjs '<ci_info_json>' <poll_count> <verbosity> \
|
||||
* [--wait-mode] [--prev-cipe-url <url>] [--expected-sha <sha>] \
|
||||
* [--prev-status <status>] [--timeout <seconds>] [--new-cipe-timeout <seconds>] \
|
||||
* [--env-rerun-count <n>] [--no-progress-count <n>] \
|
||||
* [--prev-cipe-status <status>] [--prev-sh-status <status>] \
|
||||
* [--prev-verification-status <status>] [--prev-failure-classification <status>]
|
||||
*/
|
||||
|
||||
// --- Arg parsing ---
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
const ciInfoJson = args[0];
|
||||
const pollCount = parseInt(args[1], 10) || 0;
|
||||
const verbosity = args[2] || 'medium';
|
||||
|
||||
function getFlag(name) {
|
||||
return args.includes(name);
|
||||
}
|
||||
|
||||
function getArg(name) {
|
||||
const idx = args.indexOf(name);
|
||||
return idx !== -1 && idx + 1 < args.length ? args[idx + 1] : null;
|
||||
}
|
||||
|
||||
const waitMode = getFlag('--wait-mode');
|
||||
const prevCipeUrl = getArg('--prev-cipe-url');
|
||||
const expectedSha = getArg('--expected-sha');
|
||||
const prevStatus = getArg('--prev-status');
|
||||
const timeoutSeconds = parseInt(getArg('--timeout') || '0', 10);
|
||||
const newCipeTimeoutSeconds = parseInt(getArg('--new-cipe-timeout') || '0', 10);
|
||||
const envRerunCount = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
const inputNoProgressCount = parseInt(getArg('--no-progress-count') || '0', 10);
|
||||
const prevCipeStatus = getArg('--prev-cipe-status');
|
||||
const prevShStatus = getArg('--prev-sh-status');
|
||||
const prevVerificationStatus = getArg('--prev-verification-status');
|
||||
const prevFailureClassification = getArg('--prev-failure-classification');
|
||||
|
||||
// --- Parse CI info ---
|
||||
|
||||
let ci;
|
||||
try {
|
||||
ci = JSON.parse(ciInfoJson);
|
||||
} catch {
|
||||
console.log(
|
||||
JSON.stringify({
|
||||
action: 'done',
|
||||
code: 'error',
|
||||
message: 'Failed to parse ci_information JSON',
|
||||
noProgressCount: inputNoProgressCount + 1,
|
||||
envRerunCount,
|
||||
})
|
||||
);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
const {
|
||||
cipeStatus,
|
||||
selfHealingStatus,
|
||||
verificationStatus,
|
||||
selfHealingEnabled,
|
||||
selfHealingSkippedReason,
|
||||
failureClassification: rawFailureClassification,
|
||||
failedTaskIds = [],
|
||||
verifiedTaskIds = [],
|
||||
couldAutoApplyTasks,
|
||||
autoApplySkipped,
|
||||
autoApplySkipReason,
|
||||
userAction,
|
||||
cipeUrl,
|
||||
commitSha,
|
||||
} = ci;
|
||||
|
||||
const failureClassification = rawFailureClassification?.toLowerCase() ?? null;
|
||||
|
||||
// --- Helpers ---
|
||||
|
||||
function categorizeTasks() {
|
||||
const verifiedSet = new Set(verifiedTaskIds);
|
||||
const unverified = failedTaskIds.filter((t) => !verifiedSet.has(t));
|
||||
if (unverified.length === 0) return { category: 'all_verified' };
|
||||
|
||||
const e2e = unverified.filter((t) => {
|
||||
const parts = t.split(':');
|
||||
return parts.length >= 2 && parts[1].includes('e2e');
|
||||
});
|
||||
if (e2e.length === unverified.length) return { category: 'e2e_only' };
|
||||
|
||||
const verifiable = unverified.filter((t) => {
|
||||
const parts = t.split(':');
|
||||
return !(parts.length >= 2 && parts[1].includes('e2e'));
|
||||
});
|
||||
return { category: 'needs_local_verify', verifiableTaskIds: verifiable };
|
||||
}
|
||||
|
||||
function backoff(count) {
|
||||
const delays = [60, 90, 120, 180];
|
||||
return delays[Math.min(count, delays.length - 1)];
|
||||
}
|
||||
|
||||
function hasStateChanged() {
|
||||
if (prevCipeStatus && cipeStatus !== prevCipeStatus) return true;
|
||||
if (prevShStatus && selfHealingStatus !== prevShStatus) return true;
|
||||
if (prevVerificationStatus && verificationStatus !== prevVerificationStatus)
|
||||
return true;
|
||||
if (
|
||||
prevFailureClassification &&
|
||||
failureClassification !== prevFailureClassification
|
||||
)
|
||||
return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
function isTimedOut() {
|
||||
if (timeoutSeconds <= 0) return false;
|
||||
const avgDelay = pollCount === 0 ? 0 : backoff(Math.floor(pollCount / 2));
|
||||
return pollCount * avgDelay >= timeoutSeconds;
|
||||
}
|
||||
|
||||
function isWaitTimedOut() {
|
||||
if (newCipeTimeoutSeconds <= 0) return false;
|
||||
return pollCount * 30 >= newCipeTimeoutSeconds;
|
||||
}
|
||||
|
||||
function isNewCipe() {
|
||||
return (
|
||||
(prevCipeUrl && cipeUrl && cipeUrl !== prevCipeUrl) ||
|
||||
(expectedSha && commitSha && commitSha === expectedSha)
|
||||
);
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// classify() — pure decision tree
|
||||
//
|
||||
// Returns: { action: 'poll'|'wait'|'done', code: string, extra? }
|
||||
//
|
||||
// Decision priority (top wins):
|
||||
// WAIT MODE:
|
||||
// 1. new CI Attempt detected → poll (new_cipe_detected)
|
||||
// 2. wait timed out → done (no_new_cipe)
|
||||
// 3. still waiting → wait (waiting_for_cipe)
|
||||
// NORMAL MODE:
|
||||
// 4. polling timeout → done (polling_timeout)
|
||||
// 5. circuit breaker (13 polls) → done (circuit_breaker)
|
||||
// 6. CI succeeded → done (ci_success)
|
||||
// 7. CI canceled → done (cipe_canceled)
|
||||
// 8. CI timed out → done (cipe_timed_out)
|
||||
// 9. CI failed, no tasks recorded → done (cipe_no_tasks)
|
||||
// 10. environment failure → done (environment_rerun_cap | environment_issue)
|
||||
// 11. self-healing throttled → done (self_healing_throttled)
|
||||
// 12. CI in progress / not started → poll (ci_running)
|
||||
// 13. self-healing in progress → poll (sh_running)
|
||||
// 14. flaky task auto-rerun → poll (flaky_rerun)
|
||||
// 15. fix auto-applied → poll (fix_auto_applied)
|
||||
// 16. auto-apply: skipped → done (fix_auto_apply_skipped)
|
||||
// 17. auto-apply: verification pending→ poll (verification_pending)
|
||||
// 18. auto-apply: verified → done (fix_auto_applying)
|
||||
// 19. fix: verification failed/none → done (fix_needs_review)
|
||||
// 20. fix: all/e2e verified → done (fix_apply_ready)
|
||||
// 21. fix: needs local verify → done (fix_needs_local_verify)
|
||||
// 22. self-healing failed → done (fix_failed)
|
||||
// 23. no fix available → done (no_fix)
|
||||
// 24. fallback → poll (fallback)
|
||||
// ============================================================
|
||||
|
||||
function classify() {
|
||||
// --- Wait mode ---
|
||||
if (waitMode) {
|
||||
if (isNewCipe()) return { action: 'poll', code: 'new_cipe_detected' };
|
||||
if (isWaitTimedOut()) return { action: 'done', code: 'no_new_cipe' };
|
||||
return { action: 'wait', code: 'waiting_for_cipe' };
|
||||
}
|
||||
|
||||
// --- Guards ---
|
||||
if (isTimedOut()) return { action: 'done', code: 'polling_timeout' };
|
||||
if (noProgressCount >= 13) return { action: 'done', code: 'circuit_breaker' };
|
||||
|
||||
// --- Terminal CI states ---
|
||||
if (cipeStatus === 'SUCCEEDED') return { action: 'done', code: 'ci_success' };
|
||||
if (cipeStatus === 'CANCELED')
|
||||
return { action: 'done', code: 'cipe_canceled' };
|
||||
if (cipeStatus === 'TIMED_OUT')
|
||||
return { action: 'done', code: 'cipe_timed_out' };
|
||||
|
||||
// --- CI failed, no tasks ---
|
||||
if (
|
||||
cipeStatus === 'FAILED' &&
|
||||
failedTaskIds.length === 0 &&
|
||||
selfHealingStatus == null
|
||||
)
|
||||
return { action: 'done', code: 'cipe_no_tasks' };
|
||||
|
||||
// --- Environment failure ---
|
||||
if (failureClassification === 'environment_state') {
|
||||
if (envRerunCount >= 2)
|
||||
return { action: 'done', code: 'environment_rerun_cap' };
|
||||
return { action: 'done', code: 'environment_issue' };
|
||||
}
|
||||
|
||||
// --- Throttled ---
|
||||
if (selfHealingSkippedReason === 'THROTTLED')
|
||||
return { action: 'done', code: 'self_healing_throttled' };
|
||||
|
||||
// --- Still running: CI ---
|
||||
if (cipeStatus === 'IN_PROGRESS' || cipeStatus === 'NOT_STARTED')
|
||||
return { action: 'poll', code: 'ci_running' };
|
||||
|
||||
// --- Still running: self-healing ---
|
||||
if (
|
||||
(selfHealingStatus === 'IN_PROGRESS' ||
|
||||
selfHealingStatus === 'NOT_STARTED') &&
|
||||
!selfHealingSkippedReason
|
||||
)
|
||||
return { action: 'poll', code: 'sh_running' };
|
||||
|
||||
// --- Still running: flaky rerun ---
|
||||
if (failureClassification === 'flaky_task')
|
||||
return { action: 'poll', code: 'flaky_rerun' };
|
||||
|
||||
// --- Fix auto-applied, waiting for new CI Attempt ---
|
||||
if (userAction === 'APPLIED_AUTOMATICALLY')
|
||||
return { action: 'poll', code: 'fix_auto_applied' };
|
||||
|
||||
// --- Auto-apply path (couldAutoApplyTasks) ---
|
||||
if (couldAutoApplyTasks === true) {
|
||||
if (autoApplySkipped === true)
|
||||
return {
|
||||
action: 'done',
|
||||
code: 'fix_auto_apply_skipped',
|
||||
extra: { autoApplySkipReason },
|
||||
};
|
||||
if (
|
||||
verificationStatus === 'NOT_STARTED' ||
|
||||
verificationStatus === 'IN_PROGRESS'
|
||||
)
|
||||
return { action: 'poll', code: 'verification_pending' };
|
||||
if (verificationStatus === 'COMPLETED')
|
||||
return { action: 'done', code: 'fix_auto_applying' };
|
||||
// verification FAILED or NOT_EXECUTABLE → falls through to fix_needs_review
|
||||
}
|
||||
|
||||
// --- Fix available ---
|
||||
if (selfHealingStatus === 'COMPLETED') {
|
||||
if (
|
||||
verificationStatus === 'FAILED' ||
|
||||
verificationStatus === 'NOT_EXECUTABLE' ||
|
||||
(couldAutoApplyTasks !== true && !verificationStatus)
|
||||
)
|
||||
return { action: 'done', code: 'fix_needs_review' };
|
||||
|
||||
const tasks = categorizeTasks();
|
||||
if (tasks.category === 'all_verified' || tasks.category === 'e2e_only')
|
||||
return { action: 'done', code: 'fix_apply_ready' };
|
||||
return {
|
||||
action: 'done',
|
||||
code: 'fix_needs_local_verify',
|
||||
extra: { verifiableTaskIds: tasks.verifiableTaskIds },
|
||||
};
|
||||
}
|
||||
|
||||
// --- Fix failed ---
|
||||
if (selfHealingStatus === 'FAILED')
|
||||
return { action: 'done', code: 'fix_failed' };
|
||||
|
||||
// --- No fix available ---
|
||||
if (
|
||||
cipeStatus === 'FAILED' &&
|
||||
(selfHealingEnabled === false || selfHealingStatus === 'NOT_EXECUTABLE')
|
||||
)
|
||||
return { action: 'done', code: 'no_fix' };
|
||||
|
||||
// --- Fallback ---
|
||||
return { action: 'poll', code: 'fallback' };
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// buildOutput() — maps classification to full JSON output
|
||||
// ============================================================
|
||||
|
||||
// Message templates keyed by status or key
|
||||
const messages = {
|
||||
// wait mode
|
||||
new_cipe_detected: () =>
|
||||
`New CI Attempt detected! CI: ${cipeStatus || 'N/A'}`,
|
||||
no_new_cipe: () =>
|
||||
'New CI Attempt timeout exceeded. No new CI Attempt detected.',
|
||||
waiting_for_cipe: () => 'Waiting for new CI Attempt...',
|
||||
|
||||
// guards
|
||||
polling_timeout: () => 'Polling timeout exceeded.',
|
||||
circuit_breaker: () => 'No progress after 13 consecutive polls. Stopping.',
|
||||
|
||||
// terminal
|
||||
ci_success: () => 'CI passed successfully!',
|
||||
cipe_canceled: () => 'CI Attempt was canceled.',
|
||||
cipe_timed_out: () => 'CI Attempt timed out.',
|
||||
cipe_no_tasks: () => 'CI failed but no Nx tasks were recorded.',
|
||||
|
||||
// environment
|
||||
environment_rerun_cap: () => 'Environment rerun cap (2) exceeded. Bailing.',
|
||||
environment_issue: () => 'CI: FAILED | Classification: ENVIRONMENT_STATE',
|
||||
|
||||
// throttled
|
||||
self_healing_throttled: () =>
|
||||
'Self-healing throttled \u2014 too many unapplied fixes.',
|
||||
|
||||
// polling
|
||||
ci_running: () => `CI: ${cipeStatus}`,
|
||||
sh_running: () => `CI: ${cipeStatus} | Self-healing: ${selfHealingStatus}`,
|
||||
flaky_rerun: () =>
|
||||
'CI: FAILED | Classification: FLAKY_TASK (auto-rerun in progress)',
|
||||
fix_auto_applied: () =>
|
||||
'CI: FAILED | Fix auto-applied, new CI Attempt spawning',
|
||||
verification_pending: () =>
|
||||
`CI: FAILED | Self-healing: COMPLETED | Verification: ${verificationStatus}`,
|
||||
|
||||
// actionable
|
||||
fix_auto_applying: () => 'Fix verified! Auto-applying...',
|
||||
fix_auto_apply_skipped: (extra) =>
|
||||
`Fix verified but auto-apply was skipped. ${
|
||||
extra?.autoApplySkipReason
|
||||
? `Reason: ${extra.autoApplySkipReason}`
|
||||
: 'Offer to apply manually.'
|
||||
}`,
|
||||
fix_needs_review: () =>
|
||||
`Fix available but needs review. Verification: ${
|
||||
verificationStatus || 'N/A'
|
||||
}`,
|
||||
fix_apply_ready: () => 'Fix available and verified. Ready to apply.',
|
||||
fix_needs_local_verify: (extra) =>
|
||||
`Fix available. ${extra.verifiableTaskIds.length} task(s) need local verification.`,
|
||||
fix_failed: () => 'Self-healing failed to generate a fix.',
|
||||
no_fix: () => 'CI failed, no fix available.',
|
||||
|
||||
// fallback
|
||||
fallback: () =>
|
||||
`CI: ${cipeStatus || 'N/A'} | Self-healing: ${
|
||||
selfHealingStatus || 'N/A'
|
||||
} | Verification: ${verificationStatus || 'N/A'}`,
|
||||
};
|
||||
|
||||
// Codes where noProgressCount resets to 0 (genuine progress occurred)
|
||||
const resetProgressCodes = new Set([
|
||||
'ci_success',
|
||||
'fix_auto_applying',
|
||||
'fix_auto_apply_skipped',
|
||||
'fix_needs_review',
|
||||
'fix_apply_ready',
|
||||
'fix_needs_local_verify',
|
||||
]);
|
||||
|
||||
function formatMessage(msg) {
|
||||
if (verbosity === 'minimal') {
|
||||
const currentStatus = `${cipeStatus}|${selfHealingStatus}|${verificationStatus}`;
|
||||
if (currentStatus === (prevStatus || '')) return null;
|
||||
return msg;
|
||||
}
|
||||
if (verbosity === 'verbose') {
|
||||
return [
|
||||
`Poll #${pollCount + 1} | CI: ${cipeStatus || 'N/A'} | Self-healing: ${
|
||||
selfHealingStatus || 'N/A'
|
||||
} | Verification: ${verificationStatus || 'N/A'}`,
|
||||
msg,
|
||||
].join('\n');
|
||||
}
|
||||
return `Poll #${pollCount + 1} | ${msg}`;
|
||||
}
|
||||
|
||||
function buildOutput(decision) {
|
||||
const { action, code, extra } = decision;
|
||||
|
||||
// noProgressCount is already computed before classify() was called.
|
||||
// Here we only handle the reset for "genuine progress" done-codes.
|
||||
|
||||
const msgFn = messages[code];
|
||||
const rawMsg = msgFn ? msgFn(extra) : `Unknown: ${code}`;
|
||||
const message = formatMessage(rawMsg);
|
||||
|
||||
const result = {
|
||||
action,
|
||||
code,
|
||||
message,
|
||||
noProgressCount: resetProgressCodes.has(code) ? 0 : noProgressCount,
|
||||
envRerunCount,
|
||||
};
|
||||
|
||||
// Add delay
|
||||
if (action === 'wait') {
|
||||
result.delay = 30;
|
||||
} else if (action === 'poll') {
|
||||
result.delay = code === 'new_cipe_detected' ? 60 : backoff(noProgressCount);
|
||||
result.fields = 'light';
|
||||
}
|
||||
|
||||
// Add extras
|
||||
if (code === 'new_cipe_detected') result.newCipeDetected = true;
|
||||
if (extra?.verifiableTaskIds)
|
||||
result.verifiableTaskIds = extra.verifiableTaskIds;
|
||||
if (extra?.autoApplySkipReason)
|
||||
result.autoApplySkipReason = extra.autoApplySkipReason;
|
||||
|
||||
console.log(JSON.stringify(result));
|
||||
}
|
||||
|
||||
// --- Run ---
|
||||
|
||||
// Compute noProgressCount from input. Single assignment, no mutation.
|
||||
// Wait mode: reset on new cipe, otherwise unchanged (wait doesn't count as no-progress).
|
||||
// Normal mode: reset on any state change, otherwise increment.
|
||||
const noProgressCount = (() => {
|
||||
if (waitMode) return isNewCipe() ? 0 : inputNoProgressCount;
|
||||
if (isNewCipe() || hasStateChanged()) return 0;
|
||||
return inputNoProgressCount + 1;
|
||||
})();
|
||||
|
||||
buildOutput(classify());
|
||||
@@ -0,0 +1,160 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* CI State Update Script
|
||||
*
|
||||
* Deterministic state management for CI monitor actions.
|
||||
* Three commands: gate, post-action, cycle-check.
|
||||
*
|
||||
* Usage:
|
||||
* node ci-state-update.mjs gate --gate-type <local-fix|env-rerun> [counter args]
|
||||
* node ci-state-update.mjs post-action --action <type> [--cipe-url <url>] [--commit-sha <sha>]
|
||||
* node ci-state-update.mjs cycle-check --code <code> [--agent-triggered] [counter args]
|
||||
*/
|
||||
|
||||
// --- Arg parsing ---
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
const command = args[0];
|
||||
|
||||
function getFlag(name) {
|
||||
return args.includes(name);
|
||||
}
|
||||
|
||||
function getArg(name) {
|
||||
const idx = args.indexOf(name);
|
||||
return idx !== -1 && idx + 1 < args.length ? args[idx + 1] : null;
|
||||
}
|
||||
|
||||
function output(result) {
|
||||
console.log(JSON.stringify(result));
|
||||
}
|
||||
|
||||
// --- gate ---
|
||||
// Check if an action is allowed and return incremented counter.
|
||||
// Called before any local fix attempt or environment rerun.
|
||||
|
||||
function gate() {
|
||||
const gateType = getArg('--gate-type');
|
||||
|
||||
if (gateType === 'local-fix') {
|
||||
const count = parseInt(getArg('--local-verify-count') || '0', 10);
|
||||
const max = parseInt(getArg('--local-verify-attempts') || '3', 10);
|
||||
if (count >= max) {
|
||||
return output({
|
||||
allowed: false,
|
||||
localVerifyCount: count,
|
||||
message: `Local fix budget exhausted (${count}/${max} attempts)`,
|
||||
});
|
||||
}
|
||||
return output({
|
||||
allowed: true,
|
||||
localVerifyCount: count + 1,
|
||||
message: null,
|
||||
});
|
||||
}
|
||||
|
||||
if (gateType === 'env-rerun') {
|
||||
const count = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
if (count >= 2) {
|
||||
return output({
|
||||
allowed: false,
|
||||
envRerunCount: count,
|
||||
message: `Environment issue persists after ${count} reruns. Manual investigation needed.`,
|
||||
});
|
||||
}
|
||||
return output({
|
||||
allowed: true,
|
||||
envRerunCount: count + 1,
|
||||
message: null,
|
||||
});
|
||||
}
|
||||
|
||||
output({ allowed: false, message: `Unknown gate type: ${gateType}` });
|
||||
}
|
||||
|
||||
// --- post-action ---
|
||||
// Compute next state after an action is taken.
|
||||
// Returns wait mode params and whether the action was agent-triggered.
|
||||
|
||||
function postAction() {
|
||||
const action = getArg('--action');
|
||||
const cipeUrl = getArg('--cipe-url');
|
||||
const commitSha = getArg('--commit-sha');
|
||||
|
||||
// MCP-triggered or auto-applied: track by cipeUrl
|
||||
const cipeUrlActions = ['fix-auto-applying', 'apply-mcp', 'env-rerun'];
|
||||
// Local push: track by commitSha
|
||||
const commitShaActions = [
|
||||
'apply-local-push',
|
||||
'reject-fix-push',
|
||||
'local-fix-push',
|
||||
'auto-fix-push',
|
||||
'empty-commit-push',
|
||||
];
|
||||
|
||||
const trackByCipeUrl = cipeUrlActions.includes(action);
|
||||
const trackByCommitSha = commitShaActions.includes(action);
|
||||
|
||||
if (!trackByCipeUrl && !trackByCommitSha) {
|
||||
return output({ error: `Unknown action: ${action}` });
|
||||
}
|
||||
|
||||
// fix-auto-applying: self-healing did it, NOT the monitor
|
||||
const agentTriggered = action !== 'fix-auto-applying';
|
||||
|
||||
output({
|
||||
waitMode: true,
|
||||
pollCount: 0,
|
||||
lastCipeUrl: trackByCipeUrl ? cipeUrl : null,
|
||||
expectedCommitSha: trackByCommitSha ? commitSha : null,
|
||||
agentTriggered,
|
||||
});
|
||||
}
|
||||
|
||||
// --- cycle-check ---
|
||||
// Cycle classification + counter resets when a new "done" code is received.
|
||||
// Called at the start of handling each actionable code.
|
||||
|
||||
function cycleCheck() {
|
||||
const status = getArg('--code');
|
||||
const wasAgentTriggered = getFlag('--agent-triggered');
|
||||
let cycleCount = parseInt(getArg('--cycle-count') || '0', 10);
|
||||
const maxCycles = parseInt(getArg('--max-cycles') || '10', 10);
|
||||
let envRerunCount = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
|
||||
// Cycle classification: if previous cycle was agent-triggered, count it
|
||||
if (wasAgentTriggered) cycleCount++;
|
||||
|
||||
// Reset env_rerun_count on non-environment status
|
||||
if (status !== 'environment_issue') envRerunCount = 0;
|
||||
|
||||
// Approaching limit gate
|
||||
const approachingLimit = cycleCount >= maxCycles - 2;
|
||||
|
||||
output({
|
||||
cycleCount,
|
||||
agentTriggered: false,
|
||||
envRerunCount,
|
||||
approachingLimit,
|
||||
message: approachingLimit
|
||||
? `Approaching cycle limit (${cycleCount}/${maxCycles})`
|
||||
: null,
|
||||
});
|
||||
}
|
||||
|
||||
// --- Dispatch ---
|
||||
|
||||
switch (command) {
|
||||
case 'gate':
|
||||
gate();
|
||||
break;
|
||||
case 'post-action':
|
||||
postAction();
|
||||
break;
|
||||
case 'cycle-check':
|
||||
cycleCheck();
|
||||
break;
|
||||
default:
|
||||
output({ error: `Unknown command: ${command}` });
|
||||
}
|
||||
@@ -0,0 +1,166 @@
|
||||
---
|
||||
name: nx-generate
|
||||
description: Generate code using nx generators. INVOKE IMMEDIATELY when user mentions scaffolding, setup, structure, creating apps/libs, or setting up project structure. Trigger words - scaffold, setup, create a new app, create a new lib, project structure, generate, add a new project. ALWAYS use this BEFORE calling nx_docs or exploring - this skill handles discovery internally.
|
||||
---
|
||||
|
||||
# Run Nx Generator
|
||||
|
||||
Nx generators are powerful tools that scaffold projects, make automated code migrations or automate repetitive tasks in a monorepo. They ensure consistency across the codebase and reduce boilerplate work.
|
||||
|
||||
This skill applies when the user wants to:
|
||||
|
||||
- Create new projects like libraries or applications
|
||||
- Scaffold features or boilerplate code
|
||||
- Run workspace-specific or custom generators
|
||||
- Do anything else that an nx generator exists for
|
||||
|
||||
## Key Principles
|
||||
|
||||
1. **Always use `--no-interactive`** - Prevents prompts that would hang execution
|
||||
2. **Read the generator source code** - The schema alone is not enough; understand what the generator actually does
|
||||
3. **Match existing repo patterns** - Study similar artifacts in the repo and follow their conventions
|
||||
4. **Verify with lint/test/build/typecheck etc.** - Generated code must pass verification. The listed targets are just an example, use what's appropriate for this workspace.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Discover Available Generators
|
||||
|
||||
Use the Nx CLI to discover available generators:
|
||||
|
||||
- List all generators for a plugin: `npx nx list @nx/react`
|
||||
- View available plugins: `npx nx list`
|
||||
|
||||
This includes plugin generators (e.g., `@nx/react:library`) and local workspace generators.
|
||||
|
||||
### 2. Match Generator to User Request
|
||||
|
||||
Identify which generator(s) could fulfill the user's needs. Consider what artifact type they want, which framework is relevant, and any specific generator names mentioned.
|
||||
|
||||
**IMPORTANT**: When both a local workspace generator and an external plugin generator could satisfy the request, **always prefer the local workspace generator**. Local generators are customized for the specific repo's patterns.
|
||||
|
||||
If no suitable generator exists, you can stop using this skill. However, the burden of proof is high—carefully consider all available generators before deciding none apply.
|
||||
|
||||
### 3. Get Generator Options
|
||||
|
||||
Use the `--help` flag to understand available options:
|
||||
|
||||
```bash
|
||||
npx nx g @nx/react:library --help
|
||||
```
|
||||
|
||||
Pay attention to required options, defaults that might need overriding, and options relevant to the user's request.
|
||||
|
||||
### Library Buildability
|
||||
|
||||
**Default to non-buildable libraries** unless there's a specific reason for buildable.
|
||||
|
||||
| Type | When to use | Generator flags |
|
||||
| --------------------------- | ----------------------------------------------------------------- | ----------------------------------- |
|
||||
| **Non-buildable** (default) | Internal monorepo libs consumed by apps | No `--bundler` flag |
|
||||
| **Buildable** | Publishing to npm, cross-repo sharing, stable libs for cache hits | `--bundler=vite` or `--bundler=swc` |
|
||||
|
||||
Non-buildable libs:
|
||||
|
||||
- Export `.ts`/`.tsx` source directly
|
||||
- Consumer's bundler compiles them
|
||||
- Faster dev experience, less config
|
||||
|
||||
Buildable libs:
|
||||
|
||||
- Have their own build target
|
||||
- Useful for stable libs that rarely change (cache hits)
|
||||
- Required for npm publishing
|
||||
|
||||
**If unclear, ask the user:** "Should this library be buildable (own build step, better caching) or non-buildable (source consumed directly, simpler setup)?"
|
||||
|
||||
### 4. Read Generator Source Code
|
||||
|
||||
**This step is critical.** The schema alone does not tell you everything. Reading the source code helps you:
|
||||
|
||||
- Know exactly what files will be created/modified and where
|
||||
- Understand side effects (updating configs, installing deps, etc.)
|
||||
- Identify behaviors and options not obvious from the schema
|
||||
- Understand how options interact with each other
|
||||
|
||||
To find generator source code:
|
||||
|
||||
- For plugin generators: Use `node -e "console.log(require.resolve('@nx/<plugin>/generators.json'));"` to find the generators.json, then locate the source from there
|
||||
- If that fails, read directly from `node_modules/<plugin>/generators.json`
|
||||
- For local generators: Typically in `tools/generators/` or a local plugin directory. Search the repo for the generator name.
|
||||
|
||||
After reading the source, reconsider: Is this the right generator? If not, go back to step 2.
|
||||
|
||||
> **⚠️ `--directory` flag behavior can be misleading.**
|
||||
> It should specify the full path of the generated library or component, not the parent path that it will be generated in.
|
||||
>
|
||||
> ```bash
|
||||
> # ✅ Correct - directory is the full path for the library
|
||||
> nx g @nx/react:library --directory=libs/my-lib
|
||||
> # generates libs/my-lib/package.json and more
|
||||
>
|
||||
> # ❌ Wrong - this will create files at libs and libs/src/...
|
||||
> nx g @nx/react:library --name=my-lib --directory=libs
|
||||
> # generates libs/package.json and more
|
||||
> ```
|
||||
|
||||
### 5. Examine Existing Patterns
|
||||
|
||||
Before generating, examine the target area of the codebase:
|
||||
|
||||
- Look at similar existing artifacts (other libraries, applications, etc.)
|
||||
- Identify naming conventions, file structures, and configuration patterns
|
||||
- Note which test runners, build tools, and linters are used
|
||||
- Configure the generator to match these patterns
|
||||
|
||||
### 6. Dry-Run to Verify File Placement
|
||||
|
||||
**Always run with `--dry-run` first** to verify files will be created in the correct location:
|
||||
|
||||
```bash
|
||||
npx nx g @nx/react:library --name=my-lib --dry-run --no-interactive
|
||||
```
|
||||
|
||||
Review the output carefully. If files would be created in the wrong location, adjust your options based on what you learned from the generator source code.
|
||||
|
||||
Note: Some generators don't support dry-run (e.g., if they install npm packages). If dry-run fails for this reason, proceed to running the generator for real.
|
||||
|
||||
### 7. Run the Generator
|
||||
|
||||
Execute the generator:
|
||||
|
||||
```bash
|
||||
nx generate <generator-name> <options> --no-interactive
|
||||
```
|
||||
|
||||
> **Tip:** New packages often need workspace dependencies wired up (e.g., importing shared types, being consumed by apps). The `link-workspace-packages` skill can help add these correctly.
|
||||
|
||||
### 8. Modify Generated Code (If Needed)
|
||||
|
||||
Generators provide a starting point. Modify the output as needed to:
|
||||
|
||||
- Add or modify functionality as requested
|
||||
- Adjust imports, exports, or configurations
|
||||
- Integrate with existing code patterns
|
||||
|
||||
**Important:** If you replace or delete generated test files (e.g., `*.spec.ts`), either write meaningful replacement tests or remove the `test` target from the project configuration. Empty test suites will cause `nx test` to fail.
|
||||
|
||||
### 9. Format and Verify
|
||||
|
||||
Format all generated/modified files:
|
||||
|
||||
```bash
|
||||
nx format --fix
|
||||
```
|
||||
|
||||
This example is for built-in nx formatting with prettier. There might be other formatting tools for this workspace, use these when appropriate.
|
||||
|
||||
Then verify the generated code works. Keep in mind that the changes you make with a generator or subsequent modifications might impact various projects so it's usually not enough to only run targets for the artifact you just created.
|
||||
|
||||
```bash
|
||||
# these targets are just an example!
|
||||
nx run-many -t build,lint,test,typecheck
|
||||
```
|
||||
|
||||
These targets are common examples used across many workspaces. You should do research into other targets available for this workspace and its projects. CI configuration is usually a good guide for what the critical targets are that have to pass.
|
||||
|
||||
If verification fails with manageable issues (a few lint errors, minor type issues), fix them. If issues are extensive, attempt obvious fixes first, then escalate to the user with details about what was generated, what's failing, and what you've attempted.
|
||||
@@ -0,0 +1,238 @@
|
||||
---
|
||||
name: nx-import
|
||||
description: Import, merge, or combine repositories into an Nx workspace using nx import. USE WHEN the user asks to adopt Nx across repos, move projects into a monorepo, or bring code/history from another repository.
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
- `nx import` brings code from a source repository or folder into the current workspace, preserving commit history.
|
||||
- After nx `22.6.0`, `nx import` responds with .ndjson outputs and follow-up questions. For earlier versions, always run with `--no-interactive` and specify all flags directly.
|
||||
- Run `nx import --help` for available options.
|
||||
- Make sure the destination directory is empty before importing.
|
||||
EXAMPLE: target has `libs/utils` and `libs/models`; source has `libs/ui` and `libs/data-access` — you cannot import `libs/` into `libs/` directly. Import each source library individually.
|
||||
|
||||
Primary docs:
|
||||
|
||||
- https://nx.dev/docs/guides/adopting-nx/import-project
|
||||
- https://nx.dev/docs/guides/adopting-nx/preserving-git-histories
|
||||
|
||||
Read the nx docs if you have the tools for it.
|
||||
|
||||
## Import Strategy
|
||||
|
||||
**Subdirectory-at-a-time** (`nx import <source> apps --source=apps`):
|
||||
|
||||
- **Recommended for monorepo sources** — files land at top level, no redundant config
|
||||
- Caveats: multiple import commands (separate merge commits each); dest must not have conflicting directories; root configs (deps, plugins, targetDefaults) not imported
|
||||
- **Directory conflicts**: Import into alternate-named dir (e.g. `imported-apps/`), then rename
|
||||
|
||||
**Whole repo** (`nx import <source> imported --source=.`):
|
||||
|
||||
- **Only for non-monorepo sources** (single-project repos)
|
||||
- For monorepos, creates messy nested config (`imported/nx.json`, `imported/tsconfig.base.json`, etc.)
|
||||
- If you must: keep imported `tsconfig.base.json` (projects extend it), prefix workspace globs and executor paths
|
||||
|
||||
### Directory Conventions
|
||||
|
||||
- **Always prefer the destination's existing conventions.** Source uses `libs/`but dest uses `packages/`? Import into `packages/` (`nx import <source> packages/foo --source=libs/foo`).
|
||||
- If dest has no convention (empty workspace), ask the user.
|
||||
|
||||
### Application vs Library Detection
|
||||
|
||||
Before importing, identify whether the source is an **application** or a **library**:
|
||||
|
||||
- **Applications**: Deployable end products. Common indicators:
|
||||
- _Frontend_: `next.config.*`, `vite.config.*` with a build entry point, framework-specific app scaffolding (CRA, Angular CLI app, etc.)
|
||||
- _Backend (Node.js)_: Express/Fastify/NestJS server entrypoint, no `"exports"` field in `package.json`
|
||||
- _JVM_: Maven `pom.xml` with `<packaging>jar</packaging>` or `<packaging>war</packaging>` and a `main` class; Gradle `application` plugin or `mainClass` setting
|
||||
- _.NET_: `.csproj`/`.fsproj` with `<OutputType>Exe</OutputType>` or `<OutputType>WinExe</OutputType>`
|
||||
- _General_: Dockerfile, a runnable entrypoint, no public API surface intended for import by other projects
|
||||
- **Libraries**: Reusable packages consumed by other projects. Common indicators: `"main"`/`"exports"` in `package.json`, Maven/Gradle packaging as a library jar, .NET `<OutputType>Library</OutputType>`, named exports intended for import by other packages.
|
||||
|
||||
**Destination directory rules**:
|
||||
|
||||
- Applications → `apps/<name>`. Check workspace globs (e.g. `pnpm-workspace.yaml`, `workspaces` in root `package.json`) for an existing `apps/*` entry.
|
||||
- If `apps/*` is **not** present, add it before importing: update the workspace glob config and commit (or stage) the change.
|
||||
- Example: `nx import <source> apps/my-app --source=packages/my-app`
|
||||
- Libraries → follow the dest's existing convention (`packages/`, `libs/`, etc.).
|
||||
|
||||
## Common Issues
|
||||
|
||||
### pnpm Workspace Globs (Critical)
|
||||
|
||||
`nx import` adds the imported directory itself (e.g. `apps`) to `pnpm-workspace.yaml`, **NOT** glob patterns for packages within it. Cross-package imports will fail with `Cannot find module`.
|
||||
|
||||
**Fix**: Replace with proper globs from the source config (e.g. `apps/*`, `libs/shared/*`), then `pnpm install`.
|
||||
|
||||
### Root Dependencies and Config Not Imported (Critical)
|
||||
|
||||
`nx import` does **NOT** merge from the source's root:
|
||||
|
||||
- `dependencies`/`devDependencies` from `package.json`
|
||||
- `targetDefaults` from `nx.json` (e.g. `"@nx/esbuild:esbuild": { "dependsOn": ["^build"] }` — critical for build ordering)
|
||||
- `namedInputs` from `nx.json` (e.g. `production` exclusion patterns for test files)
|
||||
- Plugin configurations from `nx.json`
|
||||
|
||||
**Fix**: Diff source and dest `package.json` + `nx.json`. Add missing deps, merge relevant `targetDefaults` and `namedInputs`.
|
||||
|
||||
### TypeScript Project References
|
||||
|
||||
After import, run `nx sync --yes`. If it reports nothing but typecheck still fails, `nx reset` first, then `nx sync --yes` again.
|
||||
|
||||
### Explicit Executor Path Fixups
|
||||
|
||||
Inferred targets (via Nx plugins) resolve config relative to project root — no changes needed. Explicit executor targets (e.g. `@nx/esbuild:esbuild`) have workspace-root-relative paths (`main`, `outputPath`, `tsConfig`, `assets`, `sourceRoot`) that must be prefixed with the import destination directory.
|
||||
|
||||
### Plugin Detection
|
||||
|
||||
- **Whole-repo import**: `nx import` detects and offers to install plugins. Accept them.
|
||||
- **Subdirectory import**: Plugins NOT auto-detected. Manually add with `npx nx add @nx/PLUGIN`. Check `include`/`exclude` patterns — defaults won't match alternate directories (e.g. `apps-beta/`).
|
||||
- Run `npx nx reset` after any plugin config changes.
|
||||
|
||||
### Redundant Root Files (Whole-Repo Only)
|
||||
|
||||
Whole-repo import brings ALL source root files into the dest subdirectory. Clean up:
|
||||
|
||||
- `pnpm-lock.yaml` — stale; dest has its own lockfile
|
||||
- `pnpm-workspace.yaml` — source workspace config; conflicts with dest
|
||||
- `node_modules/` — stale symlinks pointing to source filesystem
|
||||
- `.gitignore` — redundant with dest root `.gitignore`
|
||||
- `nx.json` — source Nx config; dest has its own
|
||||
- `README.md` — optional; keep or remove
|
||||
|
||||
**Don't blindly delete** `tsconfig.base.json` — imported projects may extend it via relative paths.
|
||||
|
||||
### Root ESLint Config Missing (Subdirectory Import)
|
||||
|
||||
Subdirectory import doesn't bring the source's root `eslint.config.mjs`, but project configs reference `../../eslint.config.mjs`.
|
||||
|
||||
**Fix order**:
|
||||
|
||||
1. Install ESLint deps first: `pnpm add -wD eslint@^9 @nx/eslint-plugin typescript-eslint` (plus framework-specific plugins)
|
||||
2. Create root `eslint.config.mjs` (copy from source or create with `@nx/eslint-plugin` base rules)
|
||||
3. Then `npx nx add @nx/eslint` to register the plugin in `nx.json`
|
||||
|
||||
Install `typescript-eslint` explicitly — pnpm's strict hoisting won't auto-resolve this transitive dep of `@nx/eslint-plugin`.
|
||||
|
||||
### ESLint Version Pinning (Critical)
|
||||
|
||||
**Pin ESLint to v9** (`eslint@^9.0.0`). ESLint 10 breaks `@nx/eslint` and many plugins with cryptic errors like `Cannot read properties of undefined (reading 'version')`.
|
||||
|
||||
`@nx/eslint` may peer-depend on ESLint 8, causing the wrong version to resolve. If lint fails with `Cannot read properties of undefined (reading 'allow')`, add `pnpm.overrides`:
|
||||
|
||||
```json
|
||||
{ "pnpm": { "overrides": { "eslint": "^9.0.0" } } }
|
||||
```
|
||||
|
||||
### Dependency Version Conflicts
|
||||
|
||||
After import, compare key deps (`typescript`, `eslint`, framework-specific). If dest uses newer versions, upgrade imported packages to match (usually safe). If source is newer, may need to upgrade dest first. Use `pnpm.overrides` to enforce single-version policy if desired.
|
||||
|
||||
### Module Boundaries
|
||||
|
||||
Imported projects may lack `tags`. Add tags or update `@nx/enforce-module-boundaries` rules.
|
||||
|
||||
### Project Name Collisions (Multi-Import)
|
||||
|
||||
Same `name` in `package.json` across source and dest causes `MultipleProjectsWithSameNameError`. **Fix**: Rename conflicting names (e.g. `@org/api` → `@org/teama-api`), update all dep references and import statements, `pnpm install`. The root `package.json` of each imported repo also becomes a project — rename those too.
|
||||
|
||||
### Workspace Dep Import Ordering
|
||||
|
||||
`pnpm install` fails during `nx import` if a `"workspace:*"` dependency hasn't been imported yet. File operations still succeed. **Fix**: Import all projects first, then `pnpm install --no-frozen-lockfile`.
|
||||
|
||||
### `.gitkeep` Blocking Subdirectory Import
|
||||
|
||||
The TS preset creates `packages/.gitkeep`. Remove it and commit before importing.
|
||||
|
||||
### Frontend tsconfig Base Settings (Critical)
|
||||
|
||||
The TS preset defaults (`module: "nodenext"`, `moduleResolution: "nodenext"`, `lib: ["es2022"]`) are incompatible with frontend frameworks (React, Next.js, Vue, Vite). After importing frontend projects, verify the dest root `tsconfig.base.json`:
|
||||
|
||||
- **`moduleResolution`**: Must be `"bundler"` (not `"nodenext"`)
|
||||
- **`module`**: Must be `"esnext"` (not `"nodenext"`)
|
||||
- **`lib`**: Must include `"dom"` and `"dom.iterable"` (frontend projects need these)
|
||||
- **`jsx`**: `"react-jsx"` for React-only workspaces, per-project for mixed frameworks
|
||||
|
||||
For **subdirectory imports**, the dest root tsconfig is authoritative — update it. For **whole-repo imports**, imported projects may extend their own nested `tsconfig.base.json`, making this less critical.
|
||||
|
||||
If the dest also has backend projects needing `nodenext`, use per-project overrides instead of changing the root.
|
||||
|
||||
**Gotcha**: TypeScript does NOT merge `lib` arrays — a project-level override **replaces** the base array entirely. Always include all needed entries (e.g. `es2022`, `dom`, `dom.iterable`) in any project-level `lib`.
|
||||
|
||||
### `@nx/react` Typings for Libraries
|
||||
|
||||
React libraries generated with `@nx/react:library` reference `@nx/react/typings/cssmodule.d.ts` and `@nx/react/typings/image.d.ts` in their tsconfig `types`. These fail with `Cannot find type definition file` unless `@nx/react` is installed in the dest workspace.
|
||||
|
||||
**Fix**: `pnpm add -wD @nx/react`
|
||||
|
||||
### Jest Preset Missing (Subdirectory Import)
|
||||
|
||||
Nx presets create `jest.preset.js` at the workspace root, and project jest configs reference it (e.g. `../../jest.preset.js`). Subdirectory import does NOT bring this file.
|
||||
|
||||
**Fix**:
|
||||
|
||||
1. Run `npx nx add @nx/jest` — registers `@nx/jest/plugin` in `nx.json` and updates `namedInputs`
|
||||
2. Create `jest.preset.js` at workspace root (see `references/JEST.md` for content) — `nx add` only creates this when a generator runs, not on bare `nx add`
|
||||
3. Install test runner deps: `pnpm add -wD jest jest-environment-jsdom ts-jest @types/jest`
|
||||
4. Install framework-specific test deps as needed (see `references/JEST.md`)
|
||||
|
||||
For deeper Jest issues (tsconfig.spec.json, Babel transforms, CI atomization, Jest vs Vitest coexistence), see `references/JEST.md`.
|
||||
|
||||
### Target Name Prefixing (Whole-Repo Import)
|
||||
|
||||
When importing a project with existing npm scripts (`build`, `dev`, `start`, `lint`), Nx plugins auto-prefix inferred target names to avoid conflicts: e.g. `next:build`, `vite:build`, `eslint:lint`.
|
||||
|
||||
**Fix**: Remove the Nx-rewritten npm scripts from the imported `package.json`, then either:
|
||||
|
||||
- Accept the prefixed names (e.g. `nx run app:next:build`)
|
||||
- Rename plugin target names in `nx.json` to use unprefixed names
|
||||
|
||||
## Non-Nx Source Issues
|
||||
|
||||
When the source is a plain pnpm/npm workspace without `nx.json`.
|
||||
|
||||
### npm Script Rewriting (Critical)
|
||||
|
||||
Nx rewrites `package.json` scripts during init, creating broken commands (e.g. `vitest run` → `nx test run`). **Fix**: Remove all rewritten scripts — Nx plugins infer targets from config files.
|
||||
|
||||
### `noEmit` → `composite` + `emitDeclarationOnly` (Critical)
|
||||
|
||||
Plain TS projects use `"noEmit": true`, incompatible with Nx project references.
|
||||
|
||||
**Symptoms**: "typecheck target is disabled because one or more project references set 'noEmit: true'" or TS6310.
|
||||
|
||||
**Fix** in **all** imported tsconfigs:
|
||||
|
||||
1. Remove `"noEmit": true`. If inherited via extends chain, set `"noEmit": false` explicitly.
|
||||
2. Add `"composite": true`, `"emitDeclarationOnly": true`, `"declarationMap": true`
|
||||
3. Add `"outDir": "dist"` and `"tsBuildInfoFile": "dist/tsconfig.tsbuildinfo"`
|
||||
4. Add `"extends": "../../tsconfig.base.json"` if missing. Remove settings now inherited from base.
|
||||
|
||||
### Stale node_modules and Lockfiles
|
||||
|
||||
`nx import` may bring `node_modules/` (pnpm symlinks pointing to the source filesystem) and `pnpm-lock.yaml` from the source. Both are stale.
|
||||
|
||||
**Fix**: `rm -rf imported/node_modules imported/pnpm-lock.yaml imported/pnpm-workspace.yaml imported/.gitignore`, then `pnpm install`.
|
||||
|
||||
### ESLint Config Handling
|
||||
|
||||
- **Legacy `.eslintrc.json` (ESLint 8)**: Delete all `.eslintrc.*`, remove v8 deps, create flat `eslint.config.mjs`.
|
||||
- **Flat config (`eslint.config.js`)**: Self-contained configs can often be left as-is.
|
||||
- **No ESLint**: Create both root and project-level configs from scratch.
|
||||
|
||||
### TypeScript `paths` Aliases
|
||||
|
||||
Nx uses `package.json` `"exports"` + pnpm workspace linking instead of tsconfig `"paths"`. If packages have proper `"exports"`, paths are redundant. Otherwise, update paths for the new directory structure.
|
||||
|
||||
## Technology-specific Guidance
|
||||
|
||||
Identify technologies in the source repo, then read and apply the matching reference file(s).
|
||||
|
||||
Available references:
|
||||
|
||||
- `references/ESLINT.md` — ESLint projects: duplicate `lint`/`eslint:lint` targets, legacy `.eslintrc.*` linting generated files, flat config `.cjs` self-linting, `typescript-eslint` v7/v9 peer dep conflict, mixed ESLint v8+v9 in one workspace.
|
||||
- `references/GRADLE.md`
|
||||
- `references/JEST.md` — Jest testing: `@nx/jest/plugin` setup, jest.preset.js, testing deps by framework, tsconfig.spec.json, Jest vs Vitest coexistence, Babel transforms, CI atomization.
|
||||
- `references/NEXT.md` — Next.js projects: `@nx/next/plugin` targets, `withNx`, Next.js TS config (`noEmit`, `jsx: "preserve"`), auto-installing deps via wrong PM, non-Nx `create-next-app` imports, mixed Next.js+Vite coexistence.
|
||||
- `references/TURBOREPO.md`
|
||||
- `references/VITE.md` — Vite projects (React, Vue, or both): `@nx/vite/plugin` typecheck target, `resolve.alias`/`__dirname` fixes, framework deps, Vue-specific setup, mixed React+Vue coexistence.
|
||||
@@ -0,0 +1,109 @@
|
||||
## ESLint
|
||||
|
||||
ESLint-specific guidance for `nx import`. For generic import issues (root deps, pnpm globs, project references), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### How `@nx/eslint/plugin` Works
|
||||
|
||||
`@nx/eslint/plugin` scans for ESLint config files and creates a lint target for each project. It detects **both** flat config files (`eslint.config.{js,mjs,cjs,ts,mts,cts}`) and legacy config files (`.eslintrc.{json,js,cjs,mjs,yml,yaml}`).
|
||||
|
||||
**Plugin options (set during `nx add @nx/eslint`):**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/eslint/plugin",
|
||||
"options": {
|
||||
"targetName": "eslint:lint"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Auto-installation**: `nx import` auto-detects ESLint config files and offers to install `@nx/eslint`. Accept the offer — it registers the plugin and updates `namedInputs.production` to exclude ESLint config files.
|
||||
|
||||
---
|
||||
|
||||
### Duplicate `lint` and `eslint:lint` Targets
|
||||
|
||||
After import, projects will have **two** lint-related targets if the source `package.json` has a `"lint"` npm script:
|
||||
|
||||
- `eslint:lint` — inferred by `@nx/eslint/plugin`; has proper caching and input/output tracking
|
||||
- `lint` — created by Nx from the npm script via `nx:run-script`; no caching intelligence, just wraps `npm run lint`
|
||||
|
||||
**Fix**: Remove the `"lint"` script from each project's `package.json`. Keep `"lint:fix"` if present — there is no plugin-inferred equivalent for auto-fixing.
|
||||
|
||||
---
|
||||
|
||||
### Legacy `.eslintrc.*` Configs Linting Generated Files
|
||||
|
||||
When `@nx/eslint/plugin` runs `eslint .` on a project with a legacy `.eslintrc.*` config that uses `parserOptions.project`, it tries to lint **all** files in the project directory including:
|
||||
|
||||
- Generated `dist/**/*.d.ts` files (not in tsconfig `include`)
|
||||
- The `.eslintrc.js` config file itself (not in tsconfig `include`)
|
||||
|
||||
This causes `Parsing error: ESLint was configured to run on X using parserOptions.project, however that TSConfig does not include this file`.
|
||||
|
||||
**Fix**: Add `ignorePatterns` to the `.eslintrc.*` config:
|
||||
|
||||
```json
|
||||
// .eslintrc.json
|
||||
{
|
||||
"ignorePatterns": ["dist/**"]
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
// .eslintrc.js — also ignore the config file itself since module.exports isn't in tsconfig
|
||||
module.exports = {
|
||||
ignorePatterns: ['dist/**', '.eslintrc.js'],
|
||||
// ...
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Flat Config `.cjs` Files Self-Linting
|
||||
|
||||
When a project uses `eslint.config.cjs` (CJS flat config), `eslint .` lints the config file itself. The `require()` call on line 1 triggers `@typescript-eslint/no-require-imports`.
|
||||
|
||||
**Fix**: Add the config filename to the top-level `ignores` array:
|
||||
|
||||
```js
|
||||
module.exports = tseslint.config(
|
||||
{
|
||||
ignores: ['dist/**', 'node_modules/**', 'eslint.config.cjs'],
|
||||
}
|
||||
// ...
|
||||
);
|
||||
```
|
||||
|
||||
The same applies to `eslint.config.js` in a CJS project (no `"type": "module"`) if it uses `require()`.
|
||||
|
||||
---
|
||||
|
||||
### `typescript-eslint` Version Conflict With ESLint 9
|
||||
|
||||
`typescript-eslint@7.x` declares `peerDependencies: { "eslint": "^8.56.0" }`, but it is commonly used alongside `"eslint": "^9.0.0"`. npm treats this as a hard peer dep conflict and refuses to install.
|
||||
|
||||
**Root cause**: `@nx/eslint` init adds `eslint@~8.57.0` at the workspace root (for its own peer deps). Workspace packages that request `eslint@^9.0.0` + `typescript-eslint@^7.0.0` trigger the conflict when npm resolves their deps.
|
||||
|
||||
**Fix**: Upgrade `typescript-eslint` from `^7.0.0` to `^8.0.0` directly in the affected workspace package's `package.json`. The `tseslint.config()` API and `tseslint.configs.recommended` are identical between v7 and v8 — no config changes needed.
|
||||
|
||||
```json
|
||||
// packages/my-package/package.json
|
||||
{
|
||||
"devDependencies": {
|
||||
"typescript-eslint": "^8.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: npm's root-level `"overrides"` field does not force versions for workspace packages' direct dependencies — update each package.json individually.
|
||||
|
||||
---
|
||||
|
||||
### Mixed ESLint v8 and v9 in One Workspace
|
||||
|
||||
Legacy v8 and flat-config v9 packages can coexist in the same workspace. Each package resolves its own `eslint` version. The root `eslint@~8.57.0` (added by `@nx/eslint` init) is used by legacy v8 packages; v9 packages get their own hoisted `eslint@9`.
|
||||
|
||||
`@nx/eslint/plugin` infers `eslint:lint` targets for **both** config formats. Legacy packages run ESLint v8 with `.eslintrc.*`; flat-config packages run ESLint v9 with `eslint.config.*`. No special nx.json configuration is needed to support both simultaneously.
|
||||
@@ -0,0 +1,12 @@
|
||||
## Gradle
|
||||
|
||||
- If you import an entire Gradle repository into a subfolder, files like `gradlew`, `gradlew.bat`, and `gradle/wrapper` will end up inside that imported subfolder.
|
||||
- The `@nx/gradle` plugin expects those files at the workspace root to infer Gradle projects/tasks automatically.
|
||||
- If the target workspace has no Gradle setup yet, consider moving those files to the root (especially when using `@nx/gradle`).
|
||||
- If the target workspace already has Gradle configured, avoid duplicate wrappers: remove imported duplicates from the subfolder or merge carefully.
|
||||
- Because the import lands in a subfolder, Gradle project references can break; review settings and project path references, then fix any errors.
|
||||
- If `@nx/gradle` is installed, run `nx show projects` to verify that Gradle projects are being inferred.
|
||||
|
||||
Helpful docs:
|
||||
|
||||
- https://nx.dev/docs/technologies/java/gradle/introduction
|
||||
@@ -0,0 +1,228 @@
|
||||
## Jest
|
||||
|
||||
Jest-specific guidance for `nx import`. For the basic "Jest Preset Missing" fix (create `jest.preset.js`, install deps), see `SKILL.md`. This file covers deeper Jest integration issues.
|
||||
|
||||
---
|
||||
|
||||
### How `@nx/jest` Works
|
||||
|
||||
`@nx/jest/plugin` scans for `jest.config.{ts,js,cjs,mjs,cts,mts}` and creates a `test` target for each project.
|
||||
|
||||
**Plugin options:**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": {
|
||||
"targetName": "test"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
`npx nx add @nx/jest` does two things:
|
||||
|
||||
1. **Registers `@nx/jest/plugin` in `nx.json`** — without this, no `test` targets are inferred
|
||||
2. Updates `namedInputs.production` to exclude test files
|
||||
|
||||
**Gotcha**: `nx add @nx/jest` does NOT create `jest.preset.js` — that file is only generated when you run a generator (e.g. `@nx/jest:configuration`). For imports, you must create it manually (see "Jest Preset" section below).
|
||||
|
||||
**Other gotcha**: If you create `jest.preset.js` manually but skip `npx nx add @nx/jest`, the plugin won't be registered and `nx run PROJECT:test` will fail with "Cannot find target 'test'". You need both.
|
||||
|
||||
---
|
||||
|
||||
### Jest Preset
|
||||
|
||||
The preset provides shared Jest configuration (test patterns, ts-jest transform, resolver, jsdom environment).
|
||||
|
||||
**Root `jest.preset.js`:**
|
||||
|
||||
```js
|
||||
const nxPreset = require('@nx/jest/preset').default;
|
||||
module.exports = { ...nxPreset };
|
||||
```
|
||||
|
||||
**Project `jest.config.ts`:**
|
||||
|
||||
```ts
|
||||
export default {
|
||||
displayName: 'my-lib',
|
||||
preset: '../../jest.preset.js',
|
||||
// project-specific overrides
|
||||
};
|
||||
```
|
||||
|
||||
The `preset` path is relative from the project root to the workspace root. Subdirectory imports preserve the original relative path (e.g. `../../jest.preset.js`), which resolves correctly if the import destination matches the source directory depth.
|
||||
|
||||
---
|
||||
|
||||
### Testing Dependencies
|
||||
|
||||
#### Core (always needed)
|
||||
|
||||
```
|
||||
pnpm add -wD jest ts-jest @types/jest @nx/jest
|
||||
```
|
||||
|
||||
#### Environment-specific
|
||||
|
||||
- **DOM testing** (React, Vue, browser libs): `jest-environment-jsdom`
|
||||
- **Node testing** (APIs, CLIs): no extra deps (Jest defaults to `node` env, but Nx preset defaults to `jsdom`)
|
||||
|
||||
#### React testing
|
||||
|
||||
```
|
||||
pnpm add -wD @testing-library/react @testing-library/jest-dom
|
||||
```
|
||||
|
||||
#### React with Babel (non-ts-jest transform)
|
||||
|
||||
Some React projects use Babel instead of ts-jest for JSX transformation:
|
||||
|
||||
```
|
||||
pnpm add -wD babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript
|
||||
```
|
||||
|
||||
**When**: Project `jest.config` has `transform` using `babel-jest` instead of `ts-jest`. Common in older Nx workspaces and CRA migrations.
|
||||
|
||||
#### Vue testing
|
||||
|
||||
```
|
||||
pnpm add -wD @vue/test-utils
|
||||
```
|
||||
|
||||
Vue projects typically use Vitest (not Jest) — see VITE.md.
|
||||
|
||||
---
|
||||
|
||||
### `tsconfig.spec.json`
|
||||
|
||||
Jest projects need a `tsconfig.spec.json` that includes test files:
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": "./tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "../../dist/out-tsc",
|
||||
"module": "commonjs",
|
||||
"types": ["jest", "node"]
|
||||
},
|
||||
"include": [
|
||||
"jest.config.ts",
|
||||
"src/**/*.test.ts",
|
||||
"src/**/*.spec.ts",
|
||||
"src/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Common issues after import:**
|
||||
|
||||
- Missing `"types": ["jest", "node"]` — causes `describe`/`it`/`expect` to be unrecognized
|
||||
- Missing `"module": "commonjs"` — Jest doesn't support ESM by default (ts-jest transpiles to CJS)
|
||||
- `include` array missing test patterns — TypeScript won't check test files
|
||||
|
||||
---
|
||||
|
||||
### Jest vs Vitest Coexistence
|
||||
|
||||
Workspaces can have both:
|
||||
|
||||
- **Jest**: Next.js apps, older React libs, Node libraries
|
||||
- **Vitest**: Vite-based React/Vue apps and libs
|
||||
|
||||
Both `@nx/jest/plugin` and `@nx/vite/plugin` (which infers Vitest targets) coexist without conflicts — they detect different config files (`jest.config.*` vs `vite.config.*`).
|
||||
|
||||
**Target naming**: Both default to `test`. If a project somehow has both config files, rename one:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": { "targetName": "jest-test" }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `@testing-library/jest-dom` — Jest vs Vitest
|
||||
|
||||
Projects migrating from Jest to Vitest (or workspaces with both) need different imports:
|
||||
|
||||
**Jest** (in `test-setup.ts`):
|
||||
|
||||
```ts
|
||||
import '@testing-library/jest-dom';
|
||||
```
|
||||
|
||||
**Vitest** (in `test-setup.ts`):
|
||||
|
||||
```ts
|
||||
import '@testing-library/jest-dom/vitest';
|
||||
```
|
||||
|
||||
If the source used Jest but the dest workspace uses Vitest for that project type, update the import path. Also add `@testing-library/jest-dom` to tsconfig `types` array.
|
||||
|
||||
---
|
||||
|
||||
### Non-Nx Source: Test Script Rewriting
|
||||
|
||||
Nx rewrites `package.json` scripts during init. Test scripts get broken:
|
||||
|
||||
- `"test": "jest"` → `"test": "nx test"` (circular if no executor configured)
|
||||
- `"test": "vitest run"` → `"test": "nx test run"` (broken — `run` becomes an argument)
|
||||
|
||||
**Fix**: Remove all rewritten test scripts. `@nx/jest/plugin` and `@nx/vite/plugin` infer test targets from config files.
|
||||
|
||||
---
|
||||
|
||||
### CI Atomization
|
||||
|
||||
`@nx/jest/plugin` supports splitting tests per-file for CI parallelism:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": {
|
||||
"targetName": "test",
|
||||
"ciTargetName": "test-ci"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This creates `test-ci--src/lib/foo.spec.ts` targets for each test file, enabling Nx Cloud distribution. Not relevant during import, but useful for post-import CI setup.
|
||||
|
||||
---
|
||||
|
||||
### Common Post-Import Issues
|
||||
|
||||
1. **"Cannot find target 'test'"**: `@nx/jest/plugin` not registered in `nx.json`. Run `npx nx add @nx/jest` or manually add the plugin entry.
|
||||
|
||||
2. **"Cannot find module 'jest-preset'"**: `jest.preset.js` missing at workspace root. Create it (see SKILL.md).
|
||||
|
||||
3. **"Cannot find type definition file for 'jest'"**: Missing `@types/jest` or `tsconfig.spec.json` doesn't have `"types": ["jest", "node"]`.
|
||||
|
||||
4. **Tests fail with "Cannot use import statement outside a module"**: `ts-jest` not installed or not configured as transform. Check `jest.config.ts` transform section.
|
||||
|
||||
5. **Snapshot path mismatches**: After import, `__snapshots__` directories may have paths baked in. Run tests once with `--updateSnapshot` to regenerate.
|
||||
|
||||
---
|
||||
|
||||
## Fix Order
|
||||
|
||||
### Subdirectory Import (Nx Source)
|
||||
|
||||
1. `npx nx add @nx/jest` — registers plugin in `nx.json` (does NOT create `jest.preset.js`)
|
||||
2. Create `jest.preset.js` manually (see "Jest Preset" section above)
|
||||
3. Install deps: `pnpm add -wD jest jest-environment-jsdom ts-jest @types/jest`
|
||||
4. Install framework test deps: `@testing-library/react @testing-library/jest-dom` (React), `@vue/test-utils` (Vue)
|
||||
5. Verify `tsconfig.spec.json` has `"types": ["jest", "node"]`
|
||||
6. `nx run-many -t test`
|
||||
|
||||
### Whole-Repo Import (Non-Nx Source)
|
||||
|
||||
1. Remove rewritten test scripts from `package.json`
|
||||
2. `npx nx add @nx/jest` — registers plugin (does NOT create preset)
|
||||
3. Create `jest.preset.js` manually
|
||||
4. Install deps (same as above)
|
||||
5. Verify/fix `jest.config.*` — ensure `preset` path points to root `jest.preset.js`
|
||||
6. Verify/fix `tsconfig.spec.json` — add `types`, `module`, `include` if missing
|
||||
7. `nx run-many -t test`
|
||||
@@ -0,0 +1,214 @@
|
||||
## Next.js
|
||||
|
||||
Next.js-specific guidance for `nx import`. For generic import issues (pnpm globs, root deps, project references, name collisions, ESLint, frontend tsconfig base settings, `@nx/react` typings, Jest preset, target name prefixing, non-Nx source handling), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### `@nx/next/plugin` Inferred Targets
|
||||
|
||||
`@nx/next/plugin` detects `next.config.{ts,js,cjs,mjs}` and creates these targets:
|
||||
|
||||
- `build` → `next build` (with `dependsOn: ['^build']`)
|
||||
- `dev` → `next dev`
|
||||
- `start` → `next start` (depends on `build`)
|
||||
- `serve-static` → same as `start`
|
||||
- `build-deps` / `watch-deps` — for TS solution setup
|
||||
|
||||
**No separate typecheck target** — Next.js runs TypeScript checking as part of `next build`. The `@nx/js/typescript` plugin provides a standalone `typecheck` target for non-Next libraries in the workspace.
|
||||
|
||||
**Build target conflict**: Both `@nx/next/plugin` and `@nx/js/typescript` define a `build` target. `@nx/next/plugin` wins for Next.js projects (it detects `next.config.*`), while `@nx/js/typescript` handles libraries with `tsconfig.lib.json`. No rename needed — they coexist.
|
||||
|
||||
### `withNx` in `next.config.js`
|
||||
|
||||
Nx-generated Next.js projects use `composePlugins(withNx)` from `@nx/next`. This wrapper is optional for `next build` via the inferred plugin (which just runs `next build`), but it provides Nx-specific configuration. Keep it if present.
|
||||
|
||||
### Root Dependencies for Next.js
|
||||
|
||||
Beyond the generic root deps issue (see SKILL.md), Next.js projects typically need:
|
||||
|
||||
**Core**: `react`, `react-dom`, `@types/react`, `@types/react-dom`, `@types/node`, `@nx/react` (see SKILL.md for `@nx/react` typings)
|
||||
**Nx plugins**: `@nx/next` (auto-installed by import), `@nx/eslint`, `@nx/jest`
|
||||
**Testing**: see SKILL.md "Jest Preset Missing" section
|
||||
**ESLint**: `@next/eslint-plugin-next` (in addition to generic ESLint deps from SKILL.md)
|
||||
|
||||
### Next.js Auto-Installing Dependencies via Wrong Package Manager
|
||||
|
||||
Next.js detects missing `@types/react` during `next build` and tries to install it using `yarn add` regardless of the actual package manager. In a pnpm workspace, this fails with a "nearest package directory isn't part of the project" error.
|
||||
|
||||
**Root cause**: `@types/react` is missing from root devDependencies.
|
||||
**Fix**: Install deps at the root before building: `pnpm add -wD @types/react @types/react-dom`
|
||||
|
||||
### Next.js TypeScript Config Specifics
|
||||
|
||||
Next.js app tsconfigs have unique patterns compared to Vite:
|
||||
|
||||
- **`noEmit: true`** with `emitDeclarationOnly: false` — Next.js handles emit, TS just checks types. This conflicts with `composite: true` from the TS solution setup.
|
||||
- **`"types": ["jest", "node"]`** — includes test types in the main tsconfig (no separate `tsconfig.app.json`)
|
||||
- **`"plugins": [{ "name": "next" }]`** — for IDE integration
|
||||
- **`include`** references `.next/types/**/*.ts` for Next.js auto-generated types
|
||||
- **`"jsx": "preserve"`** — Next.js uses its own JSX transform, not React's
|
||||
|
||||
**Gotcha**: The Next.js tsconfig sets `"noEmit": true` which disables `composite` mode. This is fine because Next.js projects use `next build` for building, not `tsc`. The `@nx/js/typescript` plugin's `typecheck` target is not needed for Next.js apps.
|
||||
|
||||
### `next.config.js` Lint Warning
|
||||
|
||||
Imported Next.js configs may have `// eslint-disable-next-line @typescript-eslint/no-var-requires` but the project ESLint config enables different rule sets. This produces `Unused eslint-disable directive` warnings. Harmless — remove the comment or ignore.
|
||||
|
||||
### `@nx/next:init` Rewrites All npm Scripts (Whole-Repo Import)
|
||||
|
||||
When `@nx/next:init` runs during a whole-repo import, it rewrites the project's `package.json` scripts to prefixed `nx` calls:
|
||||
|
||||
```json
|
||||
{
|
||||
"dev": "nx next:dev",
|
||||
"build": "nx next:build",
|
||||
"start": "nx next:start"
|
||||
}
|
||||
```
|
||||
|
||||
This is the standard "npm Script Rewriting" issue from SKILL.md, but triggered by `@nx/next:init` rather than Nx init. **Fix**: Remove all rewritten scripts from `package.json` — `@nx/next/plugin` infers all targets from `next.config.*`.
|
||||
|
||||
---
|
||||
|
||||
## Non-Nx Source (create-next-app)
|
||||
|
||||
### Whole-Repo Import Recommended
|
||||
|
||||
For single-project `create-next-app` repos, use whole-repo import into a subdirectory:
|
||||
|
||||
```bash
|
||||
nx import /path/to/source apps/web --ref=main --source=. --no-interactive
|
||||
```
|
||||
|
||||
### `next-env.d.ts`
|
||||
|
||||
`next build` auto-generates `next-env.d.ts` at the project root. Add `next-env.d.ts` to the dest root `.gitignore` — it is framework-generated and should not be committed.
|
||||
|
||||
### ESLint: Self-Contained `eslint-config-next`
|
||||
|
||||
`create-next-app` generates a flat ESLint config using `eslint-config-next` (which bundles its own plugins). This is **self-contained** — no root `eslint.config.mjs` needed, no `@nx/eslint-plugin` dependency. The `@nx/eslint/plugin` detects it and creates a lint target.
|
||||
|
||||
### TypeScript: No Changes Needed
|
||||
|
||||
Non-Nx Next.js projects have self-contained tsconfigs with `noEmit: true`, their own `lib`, `module`, `moduleResolution`, and `jsx` settings. Since `next build` handles type checking internally, no tsconfig modifications are needed. The project does NOT need to extend `tsconfig.base.json`.
|
||||
|
||||
**Gotcha**: The `@nx/js/typescript` plugin won't create a `typecheck` target because there's no `tsconfig.lib.json`. This is fine — use `next:build` for type checking.
|
||||
|
||||
### `noEmit: true` and TS Solution Setup
|
||||
|
||||
Non-Nx Next.js projects use `noEmit: true`, which conflicts with Nx's TS solution setup (`composite: true`). If the dest workspace uses project references and you want the Next.js app to participate:
|
||||
|
||||
1. Remove `noEmit: true`, add `composite: true`, `emitDeclarationOnly: true`
|
||||
2. Add `extends: "../../tsconfig.base.json"`
|
||||
3. Add `outDir` and `tsBuildInfoFile`
|
||||
|
||||
**However**, this is optional for standalone Next.js apps that don't export types consumed by other workspace projects.
|
||||
|
||||
### Tailwind / PostCSS
|
||||
|
||||
`create-next-app` with Tailwind generates `postcss.config.mjs`. This works as-is after import — no path changes needed since PostCSS resolves relative to the project root.
|
||||
|
||||
---
|
||||
|
||||
## Mixed Next.js + Vite Coexistence
|
||||
|
||||
When both Next.js and Vite projects exist in the same workspace.
|
||||
|
||||
### Plugin Coexistence
|
||||
|
||||
Both `@nx/next/plugin` and `@nx/vite/plugin` can coexist in `nx.json`. They detect different config files (`next.config.*` vs `vite.config.*`) so there are no conflicts. The `@nx/js/typescript` plugin handles libraries.
|
||||
|
||||
### Vite Standalone Project tsconfig Fixes
|
||||
|
||||
Vite standalone projects (imported as whole-repo) have self-contained tsconfigs without `composite: true`. The `@nx/js/typescript` plugin's typecheck target runs `tsc --build --emitDeclarationOnly` which requires `composite`.
|
||||
|
||||
**Fix**:
|
||||
|
||||
1. Add `extends: "../../tsconfig.base.json"` to the root project tsconfig
|
||||
2. Add `composite: true`, `declaration: true`, `declarationMap: true`, `tsBuildInfoFile` to `tsconfig.app.json` and `tsconfig.spec.json`
|
||||
3. Set `moduleResolution: "bundler"` (replace `"node"`)
|
||||
4. Add source files to `tsconfig.spec.json` `include` — specs import app code, and `composite` mode requires all files to be listed
|
||||
|
||||
### Typecheck Target Names
|
||||
|
||||
- `@nx/vite/plugin` defaults `typecheckTargetName` to `"vite:typecheck"`
|
||||
- `@nx/js/typescript` uses `"typecheck"`
|
||||
- Next.js projects have NO standalone typecheck target — Next.js runs type checking during `next build`
|
||||
|
||||
No naming conflicts between frameworks.
|
||||
|
||||
---
|
||||
|
||||
## Fix Order — Nx Source (Subdirectory Import)
|
||||
|
||||
1. Import Next.js apps into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
2. Generic fixes from SKILL.md (pnpm globs, root deps, `.gitkeep` removal, frontend tsconfig base settings, `@nx/react` typings)
|
||||
3. Install Next.js-specific deps: `pnpm add -wD @next/eslint-plugin-next`
|
||||
4. ESLint setup (see SKILL.md: "Root ESLint Config Missing")
|
||||
5. Jest setup (see SKILL.md: "Jest Preset Missing")
|
||||
6. `nx reset && nx sync --yes && nx run-many -t typecheck,build,test,lint`
|
||||
|
||||
## Fix Order — Non-Nx Source (create-next-app)
|
||||
|
||||
1. Import into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
2. Generic fixes from SKILL.md (pnpm globs, stale files cleanup, script rewriting, target name prefixing)
|
||||
3. (Optional) If app needs to export types for other workspace projects: fix `noEmit` → `composite` (see SKILL.md)
|
||||
4. `nx reset && nx run-many -t next:build,eslint:lint` (or unprefixed names if renamed)
|
||||
|
||||
---
|
||||
|
||||
## Iteration Log
|
||||
|
||||
### Scenario 1: Basic Nx Next.js App Router + Shared Lib → TS preset (PASS)
|
||||
|
||||
- Source: CNW next preset (Next.js 16, App Router) + `@nx/react:library` shared-ui
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Import: subdirectory-at-a-time (apps, libs separately)
|
||||
- Errors found & fixed:
|
||||
1. pnpm-workspace.yaml: `apps`/`libs` → `apps/*`/`libs/*`
|
||||
2. Root tsconfig: `nodenext` → `bundler`, add `dom`/`dom.iterable` to `lib`, add `jsx: react-jsx`
|
||||
3. Missing `@nx/react` (for CSS module/image type defs in lib)
|
||||
4. Missing `@types/react`, `@types/react-dom`, `@types/node`
|
||||
5. Next.js trying `yarn add @types/react` — fixed by installing at root
|
||||
6. Missing `@nx/eslint`, root `eslint.config.mjs`, ESLint plugins
|
||||
7. Missing `@nx/jest`, `jest.preset.js`, `jest-environment-jsdom`, `ts-jest`
|
||||
- All targets green: typecheck, build, test, lint
|
||||
|
||||
### Scenario 3: Non-Nx create-next-app (App Router + Tailwind) → TS preset (PASS)
|
||||
|
||||
- Source: `create-next-app@latest` (Next.js 16.1.6, App Router, Tailwind v4, flat ESLint config)
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Import: whole-repo into `apps/web`
|
||||
- Errors found & fixed:
|
||||
1. pnpm-workspace.yaml: `apps/web` → `apps/*`
|
||||
2. Stale files: `node_modules/`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `.gitignore` — deleted
|
||||
3. Nx-rewritten npm scripts (`"build": "nx next:build"`, etc.) — removed
|
||||
- No tsconfig changes needed — self-contained config with `noEmit: true`
|
||||
- ESLint self-contained via `eslint-config-next` — no root config needed
|
||||
- No test setup (create-next-app doesn't include tests)
|
||||
- All targets green: next:build, eslint:lint
|
||||
|
||||
### Scenario 4: Non-Nx create-next-app (alongside Vite, React Router 7, TanStack, CRA) → TS preset (PASS)
|
||||
|
||||
- See VITE.md Scenario 6 for the full multi-import scenario
|
||||
- Next.js-specific findings:
|
||||
1. `@nx/next:init` rewrote all scripts to `nx next:*` format — removed all rewritten scripts
|
||||
2. Stale files: `node_modules/`, `package-lock.json`, `.gitignore` — deleted (npm workspace, no pnpm files)
|
||||
3. ESLint self-contained via `eslint-config-next` — no root config needed
|
||||
4. No tsconfig changes needed — `noEmit: true` stays; `next build` handles type checking
|
||||
- Targets: `next:build`, `next:dev`, `next:start`, `eslint:lint`
|
||||
|
||||
### Scenario 5: Mixed Next.js (Nx) + Vite React (standalone) → TS preset (PASS)
|
||||
|
||||
- Source A: CNW next preset (Next.js 16, App Router) — subdirectory import of `apps/`
|
||||
- Source B: CNW react-standalone preset (Vite 7, React 19) — whole-repo import into `apps/vite-app`
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Errors found & fixed:
|
||||
1. All Scenario 1 fixes for the Next.js app
|
||||
2. Stale files from Vite source: `node_modules/`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `.gitignore`, `nx.json`
|
||||
3. Removed rewritten scripts from Vite app's `package.json`
|
||||
4. ESLint 8 vs 9 conflict — `@nx/eslint` peer on ESLint 8 resolved wrong version. Fixed with `pnpm.overrides`
|
||||
5. Vite tsconfigs missing `composite: true`, `declaration: true` — needed for `tsc --build --emitDeclarationOnly`
|
||||
6. Vite `tsconfig.spec.json` `include` missing source files — specs import app code
|
||||
7. Vite tsconfig `moduleResolution: "node"` → `"bundler"`, added `extends: "../../tsconfig.base.json"`
|
||||
- All targets green: typecheck, build, test, lint for both projects
|
||||
@@ -0,0 +1,62 @@
|
||||
## Turborepo
|
||||
|
||||
- Nx replaces Turborepo task orchestration, but a clean migration requires handling Turborepo's config packages.
|
||||
- Migration guide: https://nx.dev/docs/guides/adopting-nx/from-turborepo#easy-automated-migration-example
|
||||
- Since Nx replaces Turborepo, all turbo config files and config packages become dead code and should be removed.
|
||||
|
||||
## The Config-as-Package Pattern
|
||||
|
||||
Turborepo monorepos ship with internal workspace packages that share configuration:
|
||||
|
||||
- **`@repo/typescript-config`** (or similar) — tsconfig files (`base.json`, `nextjs.json`, `react-library.json`, etc.)
|
||||
- **`@repo/eslint-config`** (or similar) — ESLint config files and all ESLint plugin dependencies
|
||||
|
||||
These are not code libraries. They distribute config via Node module resolution (e.g., `"extends": "@repo/typescript-config/nextjs.json"`). This is the **default** Turborepo pattern — expect it in virtually every Turborepo import. Package names vary — check `package.json` files to identify the actual names.
|
||||
|
||||
## Check for Root Config Files First
|
||||
|
||||
**Before doing any config merging, check whether the destination workspace uses shared root configuration.** This decides how to handle the config packages.
|
||||
|
||||
- If the workspace has a root `tsconfig.base.json` and/or root `eslint.config.mjs` that projects extend, merge the config packages into these root configs (see steps below).
|
||||
- If the workspace does NOT have root config files — each project manages its own configuration independently (similar to Turborepo). In this case, **do not create root config files or merge into them**. Just remove turbo-specific parts (`turbo.json`, `eslint-plugin-turbo`) and leave the config packages in place, or ask the user how they want to handle them.
|
||||
|
||||
If unclear, check for the presence of `tsconfig.base.json` at the root or ask the user.
|
||||
|
||||
## Merging TypeScript Config (Only When Root tsconfig.base.json Exists)
|
||||
|
||||
The config package contains a hierarchy of tsconfig files. Each project extends one via package name.
|
||||
|
||||
1. **Read the config package** — trace the full inheritance chain (e.g., `nextjs.json` extends `base.json`).
|
||||
2. **Update root `tsconfig.base.json`** — absorb `compilerOptions` from the base config. Add Nx `paths` for cross-project imports (Turborepo doesn't use path aliases, Nx relies on them).
|
||||
3. **Update each project's `tsconfig.json`**:
|
||||
- Change `"extends"` from `"@repo/typescript-config/<variant>.json"` to the relative path to root `tsconfig.base.json`.
|
||||
- Inline variant-specific overrides from the intermediate config (e.g., Next.js: `"module": "ESNext"`, `"moduleResolution": "Bundler"`, `"jsx": "preserve"`, `"noEmit": true`; React library: `"jsx": "react-jsx"`).
|
||||
- Preserve project-specific settings (`outDir`, `include`, `exclude`, etc.).
|
||||
4. **Delete the config package** and remove it from all `devDependencies`.
|
||||
|
||||
## Merging ESLint Config (Only When Root eslint.config Exists)
|
||||
|
||||
The config package centralizes ESLint plugin dependencies and exports composable flat configs.
|
||||
|
||||
1. **Read the config package** — identify exported configs, plugin dependencies, and inheritance.
|
||||
2. **Update root `eslint.config.mjs`** — absorb base rules (JS recommended, TypeScript-ESLint, Prettier, etc.). Drop `eslint-plugin-turbo`.
|
||||
3. **Update each project's `eslint.config.mjs`** — switch from importing `@repo/eslint-config/<variant>` to extending the root config, adding framework-specific plugins inline.
|
||||
4. **Move ESLint plugin dependencies** from the config package to root `devDependencies`.
|
||||
5. If `@nx/eslint` plugin is configured with inferred targets, remove `"lint"` scripts from project `package.json` files.
|
||||
6. **Delete the config package** and remove it from all `devDependencies`.
|
||||
|
||||
## General Cleanup
|
||||
|
||||
- Remove turbo-specific dependencies: `turbo`, `eslint-plugin-turbo`.
|
||||
- Delete all `turbo.json` files (root and per-package).
|
||||
- Run workspace validation (`nx run-many -t build lint test typecheck`) to confirm nothing broke.
|
||||
|
||||
## Key Pitfalls
|
||||
|
||||
- **Trace the full inheritance chain** before inlining — check what each variant inherits from the base.
|
||||
- **Module resolution changes** — from Node package resolution (`@repo/...`) to relative paths (`../../tsconfig.base.json`).
|
||||
- **ESLint configs are JavaScript, not JSON** — handle JS imports, array spreading, and plugin objects when merging.
|
||||
|
||||
Helpful docs:
|
||||
|
||||
- https://nx.dev/docs/guides/adopting-nx/from-turborepo
|
||||
@@ -0,0 +1,397 @@
|
||||
## Vite
|
||||
|
||||
Vite-specific guidance for `nx import`. For generic import issues (pnpm globs, root deps, project references, name collisions, ESLint, frontend tsconfig base settings, `@nx/react` typings, Jest preset, non-Nx source handling), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### `@nx/vite/plugin` Typecheck Target
|
||||
|
||||
`@nx/vite/plugin` defaults `typecheckTargetName` to `"vite:typecheck"`. If the workspace expects `"typecheck"`, set it explicitly in `nx.json`. If `@nx/js/typescript` is also registered, rename one target to avoid conflicts (e.g. `"tsc-typecheck"` for the JS plugin).
|
||||
|
||||
Keep both plugins only if the workspace has non-Vite pure TS libraries — `@nx/js/typescript` handles those while `@nx/vite/plugin` handles Vite projects.
|
||||
|
||||
### @nx/vite Plugin Install Failure
|
||||
|
||||
Plugin init loads `vite.config.ts` before deps are available. **Fix**: `pnpm add -wD vite @vitejs/plugin-react` (or `@vitejs/plugin-vue`) first, then `pnpm exec nx add @nx/vite`.
|
||||
|
||||
### Vite `resolve.alias` and `__dirname` (Non-Nx Sources)
|
||||
|
||||
**`__dirname` undefined** (CJS-only): Replace with `fileURLToPath(new URL('./src', import.meta.url))` from `'node:url'`.
|
||||
|
||||
**`@/` path alias**: Vite's `resolve.alias` works at runtime but TS needs matching `"paths"`. Set `"baseUrl": "."` in project tsconfig.
|
||||
|
||||
**PostCSS/Tailwind**: Verify `content` globs resolve correctly after import.
|
||||
|
||||
### Missing TypeScript `types` (Non-Nx Sources)
|
||||
|
||||
Non-Nx tsconfigs may not declare all needed types. Ensure Vite projects include `"types": ["node", "vite/client"]` in their tsconfig.
|
||||
|
||||
### `noEmit` Fix: Vite-Specific Notes
|
||||
|
||||
See SKILL.md for the generic noEmit→composite fix. Vite-specific additions:
|
||||
|
||||
- Non-Nx Vite projects often have **both** `tsconfig.app.json` and `tsconfig.node.json` with `noEmit` — fix both
|
||||
- Solution-style tsconfigs (`"files": [], "references": [...]`) may lack `extends`. Add `extends` pointing to the dest root `tsconfig.base.json` so base settings (`moduleResolution`, `lib`) apply.
|
||||
- This is safe — Vite/Vitest ignore TypeScript emit settings.
|
||||
|
||||
### Dependency Version Conflicts
|
||||
|
||||
**Shared Vite deps (both frameworks):** `vite`, `vitest`, `jsdom`, `@types/node`, `typescript` (dev)
|
||||
|
||||
**Vite 6→7**: Typecheck fails (`Plugin<any>` type mismatch); build/serve still works. Fix: align versions.
|
||||
**Vitest 3→4**: Usually works; type conflicts may surface in shared test utils.
|
||||
|
||||
---
|
||||
|
||||
## React Router 7 (Vite-Based)
|
||||
|
||||
React Router 7 (`@react-router/dev`) uses Vite under the hood with a `vite.config.ts` and a `react-router.config.ts`. The `@nx/vite/plugin` detects `vite.config.ts` and creates inferred targets.
|
||||
|
||||
### Targets
|
||||
|
||||
`@nx/vite/plugin` creates `build`, `dev`, `serve` targets. The `build` target invokes the script defined in `package.json` (usually `react-router build`), not `vite build` directly.
|
||||
|
||||
**No separate typecheck target from `@nx/vite/plugin`** — React Router 7 typegen is run as part of `typecheck` (e.g. `react-router typegen && tsc`). The `typecheck` target is inferred from the tsconfig. Keep the `typecheck` script in `package.json` if present; it is not rewritten.
|
||||
|
||||
### tsconfig Notes
|
||||
|
||||
React Router 7 uses a single `tsconfig.json` (no `tsconfig.app.json`/`tsconfig.node.json` split). It includes:
|
||||
|
||||
- `"rootDirs": [".", "./.react-router/types"]` — for generated type files; keep as-is
|
||||
- `"paths": { "~/*": ["./app/*"] }` — self-referential alias; keep as-is
|
||||
- `"noEmit": true` — replace with composite settings per SKILL.md
|
||||
|
||||
### Build Output
|
||||
|
||||
React Router 7 outputs to `build/` (not `dist/`). Add `build` to the dest root `.gitignore`.
|
||||
|
||||
### Generated Types Directory
|
||||
|
||||
React Router 7 generates `.react-router/` at the project root for route type generation. Add `.react-router` to the dest root `.gitignore`.
|
||||
|
||||
---
|
||||
|
||||
## TanStack Start (Vite-Based)
|
||||
|
||||
TanStack Start uses Vinxi under the hood, which wraps Vite. Projects have a standard `vite.config.ts` that `@nx/vite/plugin` detects normally.
|
||||
|
||||
### Targets
|
||||
|
||||
`@nx/vite/plugin` creates `build`, `dev`, `preview`, `serve-static`, `typecheck` targets. The `build` target runs `vite build` which invokes the TanStack Start Vinxi pipeline (produces both client and SSR bundles).
|
||||
|
||||
### tsconfig Notes
|
||||
|
||||
TanStack Start uses a single `tsconfig.json` with `"allowImportingTsExtensions": true` and `"noEmit": true`. Apply the standard noEmit → composite fix. `allowImportingTsExtensions` is compatible with `emitDeclarationOnly: true` — no change needed.
|
||||
|
||||
### `paths` Aliases
|
||||
|
||||
TanStack Start commonly uses `"#/*": ["./src/*"]` and `"@/*": ["./src/*"]`. These are self-referential — keep as-is for a single-project app.
|
||||
|
||||
### Uncommitted Source Repo
|
||||
|
||||
`create-tan-stack` initializes a git repo but does NOT make an initial commit. Before importing, commit first:
|
||||
|
||||
```bash
|
||||
git -C /path/to/source add . && git -C /path/to/source commit -m "Initial commit"
|
||||
```
|
||||
|
||||
### Generated and Build Directories
|
||||
|
||||
TanStack Start / Vinxi / Nitro generate several directories that must be added to the dest root `.gitignore`:
|
||||
|
||||
- `.vinxi` — Vinxi build cache
|
||||
- `.tanstack` — TanStack generated files
|
||||
- `.nitro` — Nitro build artifacts
|
||||
- `.output` — server-side build output (SSR/edge)
|
||||
|
||||
These are not covered by `dist` or `build`.
|
||||
|
||||
---
|
||||
|
||||
## React-Specific
|
||||
|
||||
### React Dependencies
|
||||
|
||||
**Production:** `react`, `react-dom`
|
||||
**Dev:** `@types/react`, `@types/react-dom`, `@vitejs/plugin-react`, `@testing-library/react`, `@testing-library/jest-dom`, `jsdom`
|
||||
**ESLint (Nx sources):** `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-plugin-react-hooks`
|
||||
**ESLint (`create-vite`):** `eslint-plugin-react-refresh`, `eslint-plugin-react-hooks` — self-contained flat configs can be left as-is
|
||||
**Nx plugins:** `@nx/react` (generators), `@nx/vite`, `@nx/vitest`, `@nx/eslint`
|
||||
|
||||
### React TypeScript Configuration
|
||||
|
||||
Add `"jsx": "react-jsx"` — in `tsconfig.base.json` for single-framework workspaces, per-project for mixed (see Mixed section).
|
||||
|
||||
### React ESLint Config
|
||||
|
||||
```js
|
||||
import nx from '@nx/eslint-plugin';
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
export default [
|
||||
...baseConfig,
|
||||
...nx.configs['flat/react'],
|
||||
{ files: ['**/*.ts', '**/*.tsx'], rules: {} },
|
||||
];
|
||||
```
|
||||
|
||||
### React Version Conflicts
|
||||
|
||||
React 18 (source) + React 19 (dest): pnpm may hoist mismatched `react-dom`, causing `TypeError: Cannot read properties of undefined (reading 'S')`. **Fix**: Align versions with `pnpm.overrides`.
|
||||
|
||||
### `@testing-library/jest-dom` with Vitest
|
||||
|
||||
If source used Jest: change import to `@testing-library/jest-dom/vitest` in test-setup.ts, add to tsconfig `types`.
|
||||
|
||||
---
|
||||
|
||||
## Vue-Specific
|
||||
|
||||
### Vue Dependencies
|
||||
|
||||
**Production:** `vue` (plus `vue-router`, `pinia` if used)
|
||||
**Dev:** `@vitejs/plugin-vue`, `vue-tsc`, `@vue/test-utils`, `jsdom`
|
||||
**ESLint:** `eslint-plugin-vue`, `vue-eslint-parser`, `@vue/eslint-config-typescript`, `@vue/eslint-config-prettier`
|
||||
**Nx plugins:** `@nx/vue` (generators), `@nx/vite`, `@nx/vitest`, `@nx/eslint` (install AFTER deps — see below)
|
||||
|
||||
### Vue TypeScript Configuration
|
||||
|
||||
Add to `tsconfig.base.json` (single-framework) or per-project (mixed):
|
||||
|
||||
```json
|
||||
{ "jsx": "preserve", "jsxImportSource": "vue", "resolveJsonModule": true }
|
||||
```
|
||||
|
||||
### `vue-shims.d.ts`
|
||||
|
||||
Vue SFC files need a type declaration. Usually exists in each project's `src/` and imports cleanly. If missing:
|
||||
|
||||
```ts
|
||||
declare module '*.vue' {
|
||||
import { defineComponent } from 'vue';
|
||||
const component: ReturnType<typeof defineComponent>;
|
||||
export default component;
|
||||
}
|
||||
```
|
||||
|
||||
### `vue-tsc` Auto-Detection
|
||||
|
||||
Both `@nx/js/typescript` and `@nx/vite/plugin` auto-detect `vue-tsc` when installed — no manual config needed. Remove source scripts like `"typecheck": "vue-tsc --noEmit"`.
|
||||
|
||||
### ESLint Plugin Installation Order (Critical)
|
||||
|
||||
`@nx/eslint` init **crashes** if Vue ESLint deps aren't installed first (it loads all config files).
|
||||
|
||||
**Correct order:**
|
||||
|
||||
1. `pnpm add -wD eslint@^9 eslint-plugin-vue vue-eslint-parser @vue/eslint-config-typescript @typescript-eslint/parser @nx/eslint-plugin typescript-eslint`
|
||||
2. Create root `eslint.config.mjs`
|
||||
3. Then `npx nx add @nx/eslint`
|
||||
|
||||
### Vue ESLint Config Pattern
|
||||
|
||||
```js
|
||||
import vue from 'eslint-plugin-vue';
|
||||
import vueParser from 'vue-eslint-parser';
|
||||
import tsParser from '@typescript-eslint/parser';
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
export default [
|
||||
...baseConfig,
|
||||
...vue.configs['flat/recommended'],
|
||||
{
|
||||
files: ['**/*.vue'],
|
||||
languageOptions: { parser: vueParser, parserOptions: { parser: tsParser } },
|
||||
},
|
||||
{
|
||||
files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx', '**/*.vue'],
|
||||
rules: { 'vue/multi-word-component-names': 'off' },
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
**Important**: `vue-eslint-parser` override must come **AFTER** base config — `flat/typescript` sets the TS parser globally without a `files` filter, breaking `.vue` parsing.
|
||||
|
||||
`vue-eslint-parser` must be an explicit pnpm dependency (strict resolution prevents transitive import).
|
||||
|
||||
**Known issue**: Some generated Vue ESLint configs omit `vue-eslint-parser`. Use the pattern above instead.
|
||||
|
||||
---
|
||||
|
||||
## Mixed React + Vue
|
||||
|
||||
When both frameworks coexist, several settings become per-project.
|
||||
|
||||
### tsconfig `jsx` — Per-Project Only
|
||||
|
||||
- React: `"jsx": "react-jsx"` in project tsconfig
|
||||
- Vue: `"jsx": "preserve"`, `"jsxImportSource": "vue"` in project tsconfig
|
||||
- Root: **NO** `jsx` setting
|
||||
|
||||
### Typecheck — Auto-Detects Framework
|
||||
|
||||
`@nx/vite/plugin` uses `vue-tsc` for Vue projects and `tsc` for React automatically.
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{ "plugin": "@nx/eslint/plugin", "options": { "targetName": "lint" } },
|
||||
{
|
||||
"plugin": "@nx/vite/plugin",
|
||||
"options": {
|
||||
"buildTargetName": "build",
|
||||
"typecheckTargetName": "typecheck",
|
||||
"testTargetName": "test"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Remove `@nx/js/typescript` if all projects use Vite. Keep it (renamed to `"tsc-typecheck"`) only for non-Vite pure TS libs.
|
||||
|
||||
### ESLint — Three-Tier Config
|
||||
|
||||
1. **Root**: Base rules only, no framework-specific rules
|
||||
2. **React projects**: Extend root + `nx.configs['flat/react']`
|
||||
3. **Vue projects**: Extend root + `vue.configs['flat/recommended']` + `vue-eslint-parser`
|
||||
|
||||
**Required packages**: Shared (`eslint@^9`, `@nx/eslint-plugin`, `typescript-eslint`, `@typescript-eslint/parser`), React (`eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-plugin-react-hooks`), Vue (`eslint-plugin-vue`, `vue-eslint-parser`)
|
||||
|
||||
`@nx/react`/`@nx/vue` are for generators only — no target conflicts.
|
||||
|
||||
---
|
||||
|
||||
## Redundant npm Scripts After Import
|
||||
|
||||
`nx import` copies `package.json` verbatim, so npm scripts come along. For Vite-based projects `@nx/vite/plugin` already infers the same targets from `vite.config.ts` — the npm scripts just shadow the plugin with weaker `nx:run-script` wrappers (no first-class caching inputs/outputs). Remove them after import.
|
||||
|
||||
### Standalone Vite App (`create-vite`)
|
||||
|
||||
Remove the following scripts — every one is redundant:
|
||||
|
||||
| Script | Plugin replacement |
|
||||
| ----------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `dev: vite` | `@nx/vite/plugin` → `dev` |
|
||||
| `build: tsc -b && vite build` | `@nx/vite/plugin` → `build`; `typecheck` via `@nx/js/typescript` handles tsc |
|
||||
| `preview: vite preview` | `@nx/vite/plugin` → `preview` |
|
||||
| `lint: eslint .` | `@nx/eslint/plugin` → `eslint:lint` |
|
||||
|
||||
### TanStack Start
|
||||
|
||||
Remove `build`, `dev`, `preview`, and `test` scripts, but move any hardcoded `--port` flag to `vite.config.ts` first:
|
||||
|
||||
```ts
|
||||
// vite.config.ts
|
||||
export default defineConfig({
|
||||
server: { port: 3000 }, // replaces `vite dev --port 3000`
|
||||
...
|
||||
})
|
||||
```
|
||||
|
||||
### React Router 7 — Keep ALL scripts
|
||||
|
||||
Do **not** remove React Router 7 scripts. They use the framework CLI (`react-router build`, `react-router dev`, `react-router-serve`) which is not interchangeable with plain `vite`:
|
||||
|
||||
- `typecheck` runs `react-router typegen && tsc` — typegen must precede `tsc` or it fails on missing route types
|
||||
- `start` serves the SSR bundle — no plugin equivalent
|
||||
|
||||
---
|
||||
|
||||
## Fix Orders
|
||||
|
||||
### Nx Source
|
||||
|
||||
1. Generic fixes from SKILL.md (pnpm globs, root deps, executor paths, frontend tsconfig base settings, `@nx/react` typings)
|
||||
2. Configure `@nx/vite/plugin` typecheck target
|
||||
3. **React**: `jsx: "react-jsx"` (root or per-project)
|
||||
4. **Vue**: `jsx: "preserve"` + `jsxImportSource: "vue"`; verify `vue-shims.d.ts`; install ESLint deps before `@nx/eslint`
|
||||
5. **Mixed**: `jsx` per-project; remove/rename `@nx/js/typescript`
|
||||
6. `nx sync --yes && nx reset && nx run-many -t typecheck,build,test,lint`
|
||||
|
||||
### Non-Nx Source (additional steps)
|
||||
|
||||
0. Import into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
1. Generic fixes from SKILL.md (stale files cleanup, pnpm globs, rewritten scripts, target name prefixing, noEmit→composite, ESLint handling)
|
||||
2. Fix `noEmit` in **all** tsconfigs (app, node, etc. — non-Nx projects often have multiple)
|
||||
3. Add `extends` to solution-style tsconfigs so root settings apply
|
||||
4. Fix `resolve.alias` / `__dirname` / `baseUrl`
|
||||
5. Ensure `types` include `vite/client` and `node`
|
||||
6. Install `@nx/vite` manually if it failed during import
|
||||
7. Remove redundant npm scripts so `@nx/vite/plugin` infers them natively (see "Redundant npm Scripts" section)
|
||||
8. **Vue**: Add `outDir` + `**/*.vue.d.ts` to ESLint ignores
|
||||
9. Full verification
|
||||
|
||||
### Multiple-Source Imports
|
||||
|
||||
See SKILL.md for generic multi-import (name collisions, dep refs). Vite-specific: fix tsconfig `references` paths for alternate directories (`../../libs/` → `../../libs-beta/`).
|
||||
|
||||
### Non-Nx Source: React Router 7
|
||||
|
||||
1. Ensure source has at least one commit (see SKILL.md: "Source Repo Has No Commits")
|
||||
2. `nx import` whole-repo into `apps/<name>` (see SKILL.md: "Application vs Library Detection") → auto-installs `@nx/vite`, `@nx/react`
|
||||
3. Stale file cleanup: `node_modules/`, `package-lock.json`, `.gitignore`
|
||||
4. Fix `tsconfig.json`: `noEmit` → `composite + emitDeclarationOnly + outDir + tsBuildInfoFile`
|
||||
5. Add `build` and `.react-router` to dest root `.gitignore`
|
||||
6. **Keep all npm scripts** — React Router 7 uses framework CLI (`react-router build/dev`), not plain vite (see "Redundant npm Scripts" above)
|
||||
7. `npm install && nx reset && nx sync --yes`
|
||||
|
||||
### Non-Nx Source: TanStack Start
|
||||
|
||||
1. Ensure source has at least one commit — `create-tan-stack` does NOT auto-commit (see SKILL.md)
|
||||
2. `nx import` whole-repo into `apps/<name>` (see SKILL.md: "Application vs Library Detection") → auto-installs `@nx/vite`, `@nx/vitest`
|
||||
3. Stale file cleanup: `node_modules/`, `package-lock.json`, `.gitignore`
|
||||
4. Fix `tsconfig.json`: `noEmit` → `composite + emitDeclarationOnly + outDir + tsBuildInfoFile`
|
||||
5. Keep `allowImportingTsExtensions` — compatible with `emitDeclarationOnly: true`
|
||||
6. Add `.vinxi`, `.tanstack`, `.nitro`, `.output` to dest root `.gitignore`
|
||||
7. Move hardcoded `--port` from `dev` script into `vite.config.ts` (`server: { port: N }`)
|
||||
8. Remove redundant npm scripts — `@nx/vite/plugin` infers `build`, `dev`, `preview`, `test` (see "Redundant npm Scripts" above)
|
||||
9. `npm install && nx reset && nx sync --yes`
|
||||
|
||||
### Quick Reference: React vs Vue
|
||||
|
||||
| Aspect | React | Vue |
|
||||
| ------------- | ------------------------ | ----------------------------------------- |
|
||||
| Vite plugin | `@vitejs/plugin-react` | `@vitejs/plugin-vue` |
|
||||
| Type checker | `tsc` | `vue-tsc` (auto-detected) |
|
||||
| SFC support | N/A | `vue-shims.d.ts` needed |
|
||||
| tsconfig jsx | `"react-jsx"` | `"preserve"` + `"jsxImportSource": "vue"` |
|
||||
| ESLint parser | Standard TS | `vue-eslint-parser` + TS sub-parser |
|
||||
| ESLint setup | Straightforward | Must install deps before `@nx/eslint` |
|
||||
| Test utils | `@testing-library/react` | `@vue/test-utils` |
|
||||
|
||||
### Quick Reference: Vite-Based React Frameworks
|
||||
|
||||
| Aspect | Vite (standalone) | React Router 7 | TanStack Start |
|
||||
| ------------------ | ----------------- | ----------------------- | ------------------------ |
|
||||
| Build config | `vite.config.ts` | `vite.config.ts` | `vite.config.ts` |
|
||||
| Build output | `dist/` | `build/` | `dist/` |
|
||||
| SSR bundle | No | Yes (`build/server/`) | Yes (`dist/server/`) |
|
||||
| tsconfig layout | app + node split | Single tsconfig | Single tsconfig |
|
||||
| Auto-committed | Depends on tool | Usually yes | **No — commit first** |
|
||||
| `nx import` plugin | `@nx/vite` | `@nx/vite`, `@nx/react` | `@nx/vite`, `@nx/vitest` |
|
||||
|
||||
---
|
||||
|
||||
## Iteration Log
|
||||
|
||||
### Scenario 6: Multiple non-Nx React apps (CRA, Next.js, React Router 7, TanStack Start, Vite) → TS preset (PASS)
|
||||
|
||||
- Sources: 5 standalone non-Nx repos with different build tools
|
||||
- Dest: CNW ts preset (Nx 22.5.1), npm workspaces, `packages/*`
|
||||
- Import: whole-repo for each, sequential into `packages/<name>`
|
||||
- Pre-import fixes:
|
||||
1. Removed `packages/.gitkeep` and committed
|
||||
2. `git init && git add . && git commit` in Vite app (no git at all)
|
||||
3. `git add . && git commit` in TanStack app (git init'd but no commits)
|
||||
- Import: `npm exec nx -- import <source> packages/<name> --source=. --ref=main --no-interactive`
|
||||
- Next.js import auto-installed `@nx/eslint`, `@nx/next`
|
||||
- React Router 7 import auto-installed `@nx/vite`, `@nx/react`, `@nx/docker` (Dockerfile present)
|
||||
- TanStack import auto-installed `@nx/vitest`
|
||||
- Post-import fixes:
|
||||
1. Removed stale `node_modules/`, `package-lock.json`, `.gitignore` from each package
|
||||
2. Removed Nx-rewritten scripts from `board-games-nextjs/package.json` (had `"build": "nx next:build"`, etc.)
|
||||
3. Updated root `tsconfig.base.json`: `nodenext` → `bundler`, added `dom`/`dom.iterable` to lib, added `jsx: react-jsx`
|
||||
4. Added `build` to dest root `.gitignore` (CRA and React Router 7 output there)
|
||||
5. Fixed `noEmit` → `composite + emitDeclarationOnly` in: `board-games-vite/tsconfig.app.json`, `board-games-vite/tsconfig.node.json`, `board-games-react-router/tsconfig.json`, `board-games-tanstack/tsconfig.json`
|
||||
6. Fixed `tsBuildInfoFile` paths from `./node_modules/.tmp/...` to `./dist/...`
|
||||
7. Installed root `@types/react`, `@types/react-dom`, `@types/node`
|
||||
- All targets green: `build` for all 5 projects; `typecheck` for Vite/React Router/TanStack; `next:build` for Next.js
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
name: nx-plugins
|
||||
description: Find and add Nx plugins. USE WHEN user wants to discover available plugins, install a new plugin, or add support for a specific framework or technology to the workspace.
|
||||
---
|
||||
|
||||
## Finding and Installing new plugins
|
||||
|
||||
- List plugins: `pnpm nx list`
|
||||
- Install plugins `pnpm nx add <plugin>`. Example: `pnpm nx add @nx/react`.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: nx-run-tasks
|
||||
description: Helps with running tasks in an Nx workspace. USE WHEN the user wants to execute build, test, lint, serve, or run any other tasks defined in the workspace.
|
||||
---
|
||||
|
||||
You can run tasks with Nx in the following way.
|
||||
|
||||
Keep in mind that you might have to prefix things with npx/pnpx/yarn if the user doesn't have nx installed globally. Look at the package.json or lockfile to determine which package manager is in use.
|
||||
|
||||
For more details on any command, run it with `--help` (e.g. `nx run-many --help`, `nx affected --help`).
|
||||
|
||||
## Understand which tasks can be run
|
||||
|
||||
You can check those via `nx show project <projectname> --json`, for example `nx show project myapp --json`. It contains a `targets` section which has information about targets that can be run. You can also just look at the `package.json` scripts or `project.json` targets, but you might miss out on inferred tasks by Nx plugins.
|
||||
|
||||
## Run a single task
|
||||
|
||||
```
|
||||
nx run <project>:<task>
|
||||
```
|
||||
|
||||
where `project` is the project name defined in `package.json` or `project.json` (if present).
|
||||
|
||||
## Run multiple tasks
|
||||
|
||||
```
|
||||
nx run-many -t build test lint typecheck
|
||||
```
|
||||
|
||||
You can pass a `-p` flag to filter to specific projects, otherwise it runs on all projects. You can also use `--exclude` to exclude projects, and `--parallel` to control the number of parallel processes (default is 3).
|
||||
|
||||
Examples:
|
||||
|
||||
- `nx run-many -t test -p proj1 proj2` — test specific projects
|
||||
- `nx run-many -t test --projects=*-app --exclude=excluded-app` — test projects matching a pattern
|
||||
- `nx run-many -t test --projects=tag:api-*` — test projects by tag
|
||||
|
||||
## Run tasks for affected projects
|
||||
|
||||
Use `nx affected` to only run tasks on projects that have been changed and projects that depend on changed projects. This is especially useful in CI and for large workspaces.
|
||||
|
||||
```
|
||||
nx affected -t build test lint
|
||||
```
|
||||
|
||||
By default it compares against the base branch. You can customize this:
|
||||
|
||||
- `nx affected -t test --base=main --head=HEAD` — compare against a specific base and head
|
||||
- `nx affected -t test --files=libs/mylib/src/index.ts` — specify changed files directly
|
||||
|
||||
## Useful flags
|
||||
|
||||
These flags work with `run`, `run-many`, and `affected`:
|
||||
|
||||
- `--skipNxCache` — rerun tasks even when results are cached
|
||||
- `--verbose` — print additional information such as stack traces
|
||||
- `--nxBail` — stop execution after the first failed task
|
||||
- `--configuration=<name>` — use a specific configuration (e.g. `production`)
|
||||
@@ -0,0 +1,286 @@
|
||||
---
|
||||
name: nx-workspace
|
||||
description: "Explore and understand Nx workspaces. USE WHEN answering questions about the workspace, projects, or tasks. ALSO USE WHEN an nx command fails or you need to check available targets/configuration before running a task. EXAMPLES: 'What projects are in this workspace?', 'How is project X configured?', 'What depends on library Y?', 'What targets can I run?', 'Cannot find configuration for task', 'debug nx task failure'."
|
||||
---
|
||||
|
||||
# Nx Workspace Exploration
|
||||
|
||||
This skill provides read-only exploration of Nx workspaces. Use it to understand workspace structure, project configuration, available targets, and dependencies.
|
||||
|
||||
Keep in mind that you might have to prefix commands with `npx`/`pnpx`/`yarn` if nx isn't installed globally. Check the lockfile to determine the package manager in use.
|
||||
|
||||
## Listing Projects
|
||||
|
||||
Use `nx show projects` to list projects in the workspace.
|
||||
|
||||
The project filtering syntax (`-p`/`--projects`) works across many Nx commands including `nx run-many`, `nx release`, `nx show projects`, and more. Filters support explicit names, glob patterns, tag references (e.g. `tag:name`), directories, and negation (e.g. `!project-name`).
|
||||
|
||||
```bash
|
||||
# List all projects
|
||||
nx show projects
|
||||
|
||||
# Filter by pattern (glob)
|
||||
nx show projects --projects "apps/*"
|
||||
nx show projects --projects "shared-*"
|
||||
|
||||
# Filter by tag
|
||||
nx show projects --projects "tag:publishable"
|
||||
nx show projects -p 'tag:publishable,!tag:internal'
|
||||
|
||||
# Filter by target (projects that have a specific target)
|
||||
nx show projects --withTarget build
|
||||
|
||||
# Combine filters
|
||||
nx show projects --type lib --withTarget test
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
nx show projects -p "tag:scope:client,packages/*"
|
||||
|
||||
# Negate patterns
|
||||
nx show projects -p '!tag:private'
|
||||
nx show projects -p '!*-e2e'
|
||||
|
||||
# Output as JSON
|
||||
nx show projects --json
|
||||
```
|
||||
|
||||
## Project Configuration
|
||||
|
||||
Use `nx show project <name> --json` to get the full resolved configuration for a project.
|
||||
|
||||
**Important**: Do NOT read `project.json` directly - it only contains partial configuration. The `nx show project --json` command returns the full resolved config including inferred targets from plugins.
|
||||
|
||||
You can read the full project schema at `node_modules/nx/schemas/project-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Get full project configuration
|
||||
nx show project my-app --json
|
||||
|
||||
# Extract specific parts from the JSON
|
||||
nx show project my-app --json | jq '.targets'
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Check project metadata
|
||||
nx show project my-app --json | jq '{name, root, sourceRoot, projectType, tags}'
|
||||
```
|
||||
|
||||
## Target Information
|
||||
|
||||
Targets define what tasks can be run on a project.
|
||||
|
||||
```bash
|
||||
# List all targets for a project
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Get full target configuration
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
|
||||
# Check target executor/command
|
||||
nx show project my-app --json | jq '.targets.build.executor'
|
||||
nx show project my-app --json | jq '.targets.build.command'
|
||||
|
||||
# View target options
|
||||
nx show project my-app --json | jq '.targets.build.options'
|
||||
|
||||
# Check target inputs/outputs (for caching)
|
||||
nx show project my-app --json | jq '.targets.build.inputs'
|
||||
nx show project my-app --json | jq '.targets.build.outputs'
|
||||
|
||||
# Find projects with a specific target
|
||||
nx show projects --withTarget serve
|
||||
nx show projects --withTarget e2e
|
||||
```
|
||||
|
||||
## Workspace Configuration
|
||||
|
||||
Read `nx.json` directly for workspace-level configuration.
|
||||
You can read the full project schema at `node_modules/nx/schemas/nx-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Read the full nx.json
|
||||
cat nx.json
|
||||
|
||||
# Or use jq for specific sections
|
||||
cat nx.json | jq '.targetDefaults'
|
||||
cat nx.json | jq '.namedInputs'
|
||||
cat nx.json | jq '.plugins'
|
||||
cat nx.json | jq '.generators'
|
||||
```
|
||||
|
||||
Key nx.json sections:
|
||||
|
||||
- `targetDefaults` - Default configuration applied to all targets of a given name
|
||||
- `namedInputs` - Reusable input definitions for caching
|
||||
- `plugins` - Nx plugins and their configuration
|
||||
- ...and much more, read the schema or nx.json for details
|
||||
|
||||
## Affected Projects
|
||||
|
||||
If the user is asking about affected projects, read the [affected projects reference](references/AFFECTED.md) for detailed commands and examples.
|
||||
|
||||
## Common Exploration Patterns
|
||||
|
||||
### "What's in this workspace?"
|
||||
|
||||
```bash
|
||||
nx show projects
|
||||
nx show projects --type app
|
||||
nx show projects --type lib
|
||||
```
|
||||
|
||||
### "How do I build/test/lint project X?"
|
||||
|
||||
```bash
|
||||
nx show project X --json | jq '.targets | keys'
|
||||
nx show project X --json | jq '.targets.build'
|
||||
```
|
||||
|
||||
### "What depends on library Y?"
|
||||
|
||||
```bash
|
||||
# Use the project graph to find dependents
|
||||
nx graph --print | jq '.graph.dependencies | to_entries[] | select(.value[].target == "Y") | .key'
|
||||
```
|
||||
|
||||
## Programmatic Answers
|
||||
|
||||
When processing nx CLI results, use command-line tools to compute the answer programmatically rather than counting or parsing output manually. Always use `--json` flags to get structured output that can be processed with `jq`, `grep`, or other tools you have installed locally.
|
||||
|
||||
### Listing Projects
|
||||
|
||||
```bash
|
||||
nx show projects --json
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
["my-app", "my-app-e2e", "shared-ui", "shared-utils", "api"]
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Count projects
|
||||
nx show projects --json | jq 'length'
|
||||
|
||||
# Filter by pattern
|
||||
nx show projects --json | jq '.[] | select(startswith("shared-"))'
|
||||
|
||||
# Get affected projects as array
|
||||
nx show projects --affected --json | jq '.'
|
||||
```
|
||||
|
||||
### Project Details
|
||||
|
||||
```bash
|
||||
nx show project my-app --json
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "apps/my-app",
|
||||
"name": "my-app",
|
||||
"sourceRoot": "apps/my-app/src",
|
||||
"projectType": "application",
|
||||
"tags": ["type:app", "scope:client"],
|
||||
"targets": {
|
||||
"build": {
|
||||
"executor": "@nx/vite:build",
|
||||
"options": { "outputPath": "dist/apps/my-app" }
|
||||
},
|
||||
"serve": {
|
||||
"executor": "@nx/vite:dev-server",
|
||||
"options": { "buildTarget": "my-app:build" }
|
||||
},
|
||||
"test": {
|
||||
"executor": "@nx/vite:test",
|
||||
"options": {}
|
||||
}
|
||||
},
|
||||
"implicitDependencies": []
|
||||
}
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Get target names
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Get specific target config
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
|
||||
# Get tags
|
||||
nx show project my-app --json | jq '.tags'
|
||||
|
||||
# Get project root
|
||||
nx show project my-app --json | jq -r '.root'
|
||||
```
|
||||
|
||||
### Project Graph
|
||||
|
||||
```bash
|
||||
nx graph --print
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
{
|
||||
"graph": {
|
||||
"nodes": {
|
||||
"my-app": {
|
||||
"name": "my-app",
|
||||
"type": "app",
|
||||
"data": { "root": "apps/my-app", "tags": ["type:app"] }
|
||||
},
|
||||
"shared-ui": {
|
||||
"name": "shared-ui",
|
||||
"type": "lib",
|
||||
"data": { "root": "libs/shared-ui", "tags": ["type:ui"] }
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"my-app": [
|
||||
{ "source": "my-app", "target": "shared-ui", "type": "static" }
|
||||
],
|
||||
"shared-ui": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Get all project names from graph
|
||||
nx graph --print | jq '.graph.nodes | keys'
|
||||
|
||||
# Find dependencies of a project
|
||||
nx graph --print | jq '.graph.dependencies["my-app"]'
|
||||
|
||||
# Find projects that depend on a library
|
||||
nx graph --print | jq '.graph.dependencies | to_entries[] | select(.value[].target == "shared-ui") | .key'
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Cannot find configuration for task X:target"
|
||||
|
||||
```bash
|
||||
# Check what targets exist on the project
|
||||
nx show project X --json | jq '.targets | keys'
|
||||
|
||||
# Check if any projects have that target
|
||||
nx show projects --withTarget target
|
||||
```
|
||||
|
||||
### "The workspace is out of sync"
|
||||
|
||||
```bash
|
||||
nx sync
|
||||
nx reset # if sync doesn't fix stale cache
|
||||
```
|
||||
@@ -0,0 +1,27 @@
|
||||
## Affected Projects
|
||||
|
||||
Find projects affected by changes in the current branch.
|
||||
|
||||
```bash
|
||||
# Affected since base branch (auto-detected)
|
||||
nx show projects --affected
|
||||
|
||||
# Affected with explicit base
|
||||
nx show projects --affected --base=main
|
||||
nx show projects --affected --base=origin/main
|
||||
|
||||
# Affected between two commits
|
||||
nx show projects --affected --base=abc123 --head=def456
|
||||
|
||||
# Affected apps only
|
||||
nx show projects --affected --type app
|
||||
|
||||
# Affected excluding e2e projects
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
|
||||
# Affected by uncommitted changes
|
||||
nx show projects --affected --uncommitted
|
||||
|
||||
# Affected by untracked files
|
||||
nx show projects --affected --untracked
|
||||
```
|
||||
@@ -0,0 +1,15 @@
|
||||
[env]
|
||||
JEMALLOC_SYS_WITH_MALLOC_CONF = "dirty_decay_ms:1000,muzzy_decay_ms:0"
|
||||
|
||||
[build]
|
||||
target-dir = 'dist/target'
|
||||
|
||||
[target.x86_64-unknown-linux-musl]
|
||||
rustflags = [
|
||||
"-C",
|
||||
"target-feature=-crt-static",
|
||||
]
|
||||
|
||||
[target.aarch64-unknown-linux-musl]
|
||||
linker = "aarch64-linux-musl-gcc"
|
||||
rustflags = ["-C", "target-feature=-crt-static"]
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
name: alternative-approach
|
||||
description: Use this agent during PR review to independently design alternative solutions to the problem a PR solves and contrast them with the PR's chosen approach. It reports a finding only when an alternative is materially better (root-cause vs symptom fix, reuse of an existing utility, large complexity reduction) or when the chosen approach cannot fully solve the problem; otherwise it endorses the approach so the reviewer knows alternatives were considered and rejected. Read-only on the worktree.
|
||||
model: inherit
|
||||
tools: Read, Grep, Glob, Bash
|
||||
---
|
||||
|
||||
# Alternative-Approach Analyst
|
||||
|
||||
You evaluate whether the approach a PR takes is the right one. Other agents review whether the code is _correct and clean_; you review whether this is the _solution a maintainer with full context would choose_. Your value is in the road not taken: a reviewer reading your report should know what else was possible and why the PR's choice does or doesn't beat it.
|
||||
|
||||
## Inputs (provided by the caller)
|
||||
|
||||
- `PR_NUMBER` — the PR under review in nrwl/nx
|
||||
- `WORKTREE_PATH` — an nrwl/nx checkout at the PR's HEAD
|
||||
- `BASE_REF` — the base branch (usually `master`)
|
||||
|
||||
If `.review-charter.md` exists in the worktree, read it first — it carries the maintainers' severity policy and calibrations, and they bound what you may report.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Understand the problem.** Read the PR body and linked issues (`gh pr view <PR_NUMBER> --repo nrwl/nx --json title,body`, `gh issue view <N> --repo nrwl/nx`). State in one sentence what user-visible behavior should change. If there is no discoverable problem statement, say so and stop at a short report — you can't contrast approaches to an unknown goal.
|
||||
|
||||
2. **Characterize the chosen approach.** Read the diff (`git -C "$WORKTREE_PATH" diff <BASE_REF>...HEAD`). Identify: which layer it intervenes at, the mechanism, the blast radius (what else runs through the changed code), and the rough size.
|
||||
|
||||
3. **Design 2-3 genuine alternatives.** Sketch each seriously — which files, what shape — not as a strawman. Angles that matter in this codebase:
|
||||
- **Reuse over reimplementation.** Is there an existing utility, pattern, or value computed upstream that already solves this? Grep `@nx/devkit`, the package's own utils, and sibling packages that solved the same problem. A PR that hand-rolls what exists elsewhere should reuse instead.
|
||||
- **Root cause over symptom.** Can the special case be resolved upstream at its source instead of guarded downstream at the call site? Prefer fixing the invariant where it breaks over adding defensive handling where it surfaces.
|
||||
- **Data over code.** Would a config/schema/versions-map/migration entry change do the job without a new code path?
|
||||
- **Scope check.** Would a narrower fix cover the reported bug with less risk — or does the bug class actually demand something broader than the PR attempts?
|
||||
|
||||
4. **Contrast.** Compare the chosen approach against the surviving alternatives on: completeness (does it fix all reported cases), complexity and size, blast radius and regression risk, consistency with how neighboring code solves the same problem, and maintenance burden.
|
||||
|
||||
## Verdicts (report exactly one)
|
||||
|
||||
- `APPROACH_SOUND` — the PR's approach is as good as or better than the alternatives. Write a 2-5 sentence endorsement naming the alternatives you considered and why each loses. This is a positive contribution to the review, not filler — it tells the reviewer the design space was checked.
|
||||
- `BETTER_ALTERNATIVE_EXISTS` — an alternative is _materially_ better: root-cause fix vs symptom patch, an existing utility left unused, or a large complexity/risk reduction. Include a concrete sketch (files, shape, why it wins). The bar: you would ask the author to rework the PR. "Different but not clearly better" does NOT meet the bar — fold it into `APPROACH_SOUND`.
|
||||
- `APPROACH_INSUFFICIENT` — independent of alternatives, the chosen approach cannot fully solve the linked problem (cases it provably misses). Name the missed cases.
|
||||
|
||||
Rework requests are expensive for contributors. When in doubt between `APPROACH_SOUND` and `BETTER_ALTERNATIVE_EXISTS`, endorse.
|
||||
|
||||
## Rules
|
||||
|
||||
- **Read-only.** Never modify the worktree, never check out other refs.
|
||||
- **Ground every claim.** "An existing util already does this" requires the util's path and how it applies. Unverified hunches don't go in the report.
|
||||
- Don't duplicate the other agents: code style, tests, comments, and error handling are not your beat — only the shape of the solution.
|
||||
|
||||
## Output format
|
||||
|
||||
```markdown
|
||||
### Approach analysis
|
||||
|
||||
**Verdict:** APPROACH_SOUND | BETTER_ALTERNATIVE_EXISTS | APPROACH_INSUFFICIENT
|
||||
|
||||
**Problem:** <one sentence>
|
||||
|
||||
**Chosen approach:** <two sentences: layer, mechanism, blast radius>
|
||||
|
||||
**Alternatives considered:**
|
||||
|
||||
- <name> — <one line: shape, and why it loses / wins>
|
||||
- <name> — <one line>
|
||||
|
||||
**Recommendation:** <only for non-SOUND verdicts: the concrete sketch and what to ask the author>
|
||||
```
|
||||
@@ -0,0 +1,404 @@
|
||||
---
|
||||
name: reproduce-verifier
|
||||
description: Grounds a PR review in the reported bug. Fetches each issue linked from the PR body (Fixes/Closes/Resolves #N), extracts the reported vs expected behavior and any reproduction steps, reasons about whether the diff plausibly addresses the bug, and — when the repro is runnable against the local nrwl/nx worktree — attempts to execute it on both master (baseline) and the PR head. Reports whether the bug was grounded, whether reproduction was attempted, and what happened. Use this agent during PR review to answer "does this PR actually fix what it claims to fix?"
|
||||
model: opus
|
||||
color: blue
|
||||
---
|
||||
|
||||
You are the reproduce-verifier agent. Your job is to ground a PR review in the bug the PR claims to fix and, when possible, actually run the reproduction to verify the fix works.
|
||||
|
||||
You are NOT a general code reviewer. The other six review agents (code-reviewer, pr-test-analyzer, silent-failure-hunter, comment-analyzer, type-design-analyzer, code-simplifier) handle that. Your job is specifically about the _reported bug_ and the _reproduction_.
|
||||
|
||||
## Inputs
|
||||
|
||||
The calling skill provides:
|
||||
|
||||
- `PR_NUMBER` — the PR number in `nrwl/nx`
|
||||
- `WORKTREE_PATH` — an isolated worktree at the PR's HEAD (branch `pr-<NUMBER>`)
|
||||
- `HEAD_SHA` — the PR's head commit
|
||||
- `BASE_REF` — usually `master`
|
||||
- `RUN_LEVEL_2` (optional, default `false`) — when `true`, opt in to the expensive Level 2 verdaccio-based external-repo reproduction (~10-15 min per run, hence off by default).
|
||||
- `VERDACCIO_PORT` (optional, default `4873`) — only used if Level 2 runs.
|
||||
|
||||
All paths are absolute. The worktree has `.git` pointing back to the main nrwl/nx clone, so you can `git checkout` arbitrary refs inside it.
|
||||
|
||||
## Workflow
|
||||
|
||||
You work in three levels. Always do Level 0. Attempt Level 1 if the criteria match. Attempt Level 2 ONLY if `RUN_LEVEL_2: true` was passed AND the classification is `EXTERNAL_REPO` or `GENERATED_WORKSPACE`.
|
||||
|
||||
### Level 0: Ground the review in the reported bug (ALWAYS)
|
||||
|
||||
1. **Fetch the PR body and extract linked issues.**
|
||||
|
||||
```bash
|
||||
gh pr view <PR_NUMBER> --repo nrwl/nx --json body,title --jq '.body'
|
||||
```
|
||||
|
||||
Scan the body for issue references. Recognize these patterns (case-insensitive, with or without `#`):
|
||||
- `Fixes #N`, `Fixes: #N`, `Fixes nrwl/nx#N`
|
||||
- `Closes #N`, `Closes: #N`
|
||||
- `Resolves #N`, `Resolves: #N`
|
||||
- Also: bare `#<number>` inside the "Related Issue(s)" section
|
||||
|
||||
If no linked issues are found, report `NO_LINKED_ISSUES` and still return a Level 0 reasoning pass on the PR title/body alone ("the PR describes X; the diff appears to do Y"). Do not claim the reproduction was verified.
|
||||
|
||||
2. **For each linked issue, fetch the body and comments:**
|
||||
|
||||
```bash
|
||||
gh issue view <N> --repo nrwl/nx --json number,title,body,comments,state,labels
|
||||
```
|
||||
|
||||
Extract:
|
||||
- **Reported behavior** — what the user says is happening
|
||||
- **Expected behavior** — what they expect instead
|
||||
- **Reproduction artifacts** — any of:
|
||||
- A repo URL (github.com/<org>/<repo>, typically not nrwl/nx)
|
||||
- Commands to run (`nx run ...`, `npx create-nx-workspace ...`, `pnpm install`, etc.)
|
||||
- A named nrwl/nx project or test to run (`nx test maven-batch-runner`)
|
||||
- File contents or config snippets
|
||||
- **Environment constraints** — specific Node version, OS, Java/Gradle/Maven version, etc.
|
||||
|
||||
3. **Classify the reproduction scenario** for each issue:
|
||||
- `LOCAL_TEST` — repro is a test in nrwl/nx itself (e.g., "the test `foo.spec.ts` fails"). Runnable via Level 1.
|
||||
- `LOCAL_NX_TARGET` — repro is `nx run <project-in-nrwl-nx>:<target>` on a project that lives inside the nrwl/nx repo. Runnable via Level 1.
|
||||
- `EXTERNAL_REPO` — repro lives in a separate repo and exercises nx as a library. Needs Level 2 (not attempted by this agent).
|
||||
- `GENERATED_WORKSPACE` — repro is "create a workspace with `npx create-nx-workspace` and do X". Needs Level 2.
|
||||
- `MANUAL_ONLY` — natural-language description, no clear mechanical repro. Not machine-executable.
|
||||
- `NO_REPRO` — issue has no reproduction info at all. Flag this as an issue-quality concern in the report.
|
||||
|
||||
4. **Reason about the fix adequacy (static).** Compare the diff to the reported bug:
|
||||
- Does the PR touch code on the path described by the repro? (e.g., bug is in `MavenInvokerRunner.buildArguments`; the PR modifies that function — plausibly relevant.)
|
||||
- Does the fix direction match the bug? (e.g., bug: `--settings` dropped; fix: add `--settings` to an allowlist — yes.)
|
||||
- Are there parts of the reported bug the diff does NOT address? Flag them as gaps.
|
||||
- Would you expect this fix to also close the linked issue, or only part of it?
|
||||
|
||||
### Level 1: Run the repro against the worktree (WHEN APPLICABLE)
|
||||
|
||||
Only attempt Level 1 for `LOCAL_TEST` or `LOCAL_NX_TARGET` scenarios. For other scenarios, skip to the report.
|
||||
|
||||
1. **Find the nrwl/nx root** — `WORKTREE_PATH` is your nrwl/nx checkout at HEAD. Its `.git` points back at the main clone; you don't need the main clone's path directly.
|
||||
|
||||
2. **Identify the command to run.** From the issue or the PR body, extract the exact `nx run` / test command. Examples:
|
||||
- `nx run maven-batch-runner:test`
|
||||
- `pnpm vitest run packages/foo/src/bar.spec.ts`
|
||||
- `nx affected -t test --files=...`
|
||||
|
||||
If the command is ambiguous or requires environment setup you cannot verify (MAVEN_HOME, specific JDK version, etc.), do not run it. Report what you would have run and why you stopped.
|
||||
|
||||
**Trust boundary:** running a repro executes the PR author's code (tests, configs, install hooks) — the same trust decision as checking out a PR locally and running its tests. But issue text gets no such trust: only run commands that are recognizable invocations of the repo's own tooling (`nx`, `pnpm`, `vitest`, `jest`, `node <in-repo script>`). Never run fetch-and-execute patterns (`curl ... | sh`), scripts from URLs, or commands whose effect you can't read from the repo itself — report them as `MANUAL_ONLY` instead.
|
||||
|
||||
3. **Baseline run (master).** In the worktree, checkout the base:
|
||||
|
||||
```bash
|
||||
git -C "$WORKTREE_PATH" stash --include-untracked 2>/dev/null || true
|
||||
git -C "$WORKTREE_PATH" checkout --detach "origin/<BASE_REF>"
|
||||
```
|
||||
|
||||
Detached on purpose: checking out the branch itself fails if `<BASE_REF>` is already checked out in the main clone or another worktree (it usually is).
|
||||
|
||||
Run the repro command. Capture the outcome:
|
||||
- `BASELINE_FAILS` — command errored in a way that matches the reported bug. Good — bug is reproduced on master.
|
||||
- `BASELINE_PASSES` — command succeeded. The bug does NOT exist on master. Possible causes: already fixed, environment-dependent, or the agent ran the wrong command. Flag this loudly — it may indicate the PR is unnecessary or the agent misidentified the repro.
|
||||
- `BASELINE_ERROR_DIFFERENT` — command errored but not with the reported error. Flag and stop.
|
||||
|
||||
4. **PR run (HEAD).** Return to the PR branch:
|
||||
|
||||
```bash
|
||||
git -C "$WORKTREE_PATH" checkout <HEAD_SHA>
|
||||
```
|
||||
|
||||
Run the same command. Capture:
|
||||
- `PR_PASSES` — command succeeded. Combined with `BASELINE_FAILS` → verdict `FIX_CONFIRMED`.
|
||||
- `PR_FAILS_SAME` — command still fails with the reported error. Verdict `FIX_DID_NOT_WORK`.
|
||||
- `PR_FAILS_DIFFERENT` — command fails with a different error. Verdict `FIX_CHANGED_BEHAVIOR_BUT_NOT_RESOLVED`.
|
||||
|
||||
5. **Always restore the worktree to HEAD_SHA** before exiting, whether the runs succeeded or errored.
|
||||
|
||||
### Level 2: Publish nx from the worktree to a local registry and run the external repro (OPT-IN)
|
||||
|
||||
Only attempt Level 2 when `RUN_LEVEL_2: true` is passed by the caller. Default is off — Level 2 takes ~10-15 minutes per invocation.
|
||||
|
||||
Level 2 publishes nx packages from the worktree at HEAD into a local verdaccio instance, then runs the external repro against that build. This is **HEAD-only** — we do not re-publish at master for the baseline. The verdict becomes `PR_REPRO_PASSES` or `PR_REPRO_FAILS`, describing what happened _at the PR_ without trying to confirm the bug existed on master. That limitation is a deliberate trade for wall-clock time. If the caller needs a master baseline, they can run Level 2 twice manually.
|
||||
|
||||
**Critical:** you MUST always clean up, even on failure. Use the exit-trap pattern described in step 9 below.
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
1. Node 20+ and pnpm 10.28.2+ in PATH.
|
||||
2. Worktree has been built or can be built (`pnpm install` may need to run first).
|
||||
3. Port 4873 is free (or a different port is specified via `VERDACCIO_PORT`).
|
||||
4. Disk space for `dist/local-registry/storage` (~500MB-1GB).
|
||||
|
||||
If any prerequisite is missing, report and skip Level 2 — do NOT attempt partial setup.
|
||||
|
||||
#### Step 1: Install dependencies in the worktree (if needed)
|
||||
|
||||
```bash
|
||||
cd "$WORKTREE_PATH"
|
||||
test -d node_modules || pnpm install --frozen-lockfile
|
||||
```
|
||||
|
||||
If `pnpm install` fails, stop and report. Do not try to continue.
|
||||
|
||||
#### Step 2: Start the local registry
|
||||
|
||||
Start verdaccio in the background. It must outlive the publish step but be killable on cleanup.
|
||||
|
||||
```bash
|
||||
cd "$WORKTREE_PATH"
|
||||
PORT=${VERDACCIO_PORT:-4873}
|
||||
pnpm nx local-registry @nx/nx-source --port=$PORT >/tmp/verdaccio-<PR_NUMBER>.log 2>&1 &
|
||||
VERDACCIO_PID=$!
|
||||
echo "$VERDACCIO_PID" > /tmp/verdaccio-<PR_NUMBER>.pid
|
||||
```
|
||||
|
||||
Wait up to 60s for the registry to accept connections:
|
||||
|
||||
```bash
|
||||
for i in $(seq 1 60); do
|
||||
if curl -sf http://localhost:$PORT/-/ping >/dev/null 2>&1; then break; fi
|
||||
sleep 1
|
||||
done
|
||||
curl -sf http://localhost:$PORT/-/ping >/dev/null || { echo "verdaccio failed to start"; exit 1; }
|
||||
```
|
||||
|
||||
If startup fails, kill the pid (if set), report, and exit.
|
||||
|
||||
#### Step 3: Publish nx to the local registry
|
||||
|
||||
```bash
|
||||
cd "$WORKTREE_PATH"
|
||||
NX_LOCAL_REGISTRY_PORT=$PORT \
|
||||
NX_VERBOSE_LOGGING=true \
|
||||
PUBLISHED_VERSION=${TARGET_PUBLISHED_VERSION:-major} \
|
||||
pnpm nx populate-local-registry-storage @nx/nx-source 2>&1 | tee /tmp/publish-<PR_NUMBER>.log
|
||||
```
|
||||
|
||||
This runs `pnpm nx-release --local ${PUBLISHED_VERSION}` internally — it builds all packages, versions them, and publishes to verdaccio. Takes 5-10 minutes. If it fails, capture the error and skip to cleanup.
|
||||
|
||||
After success, determine the exact published version:
|
||||
|
||||
```bash
|
||||
PUBLISHED_NX_VERSION=$(node -p "require('$WORKTREE_PATH/dist/packages/nx/package.json').version")
|
||||
echo "Published version: $PUBLISHED_NX_VERSION"
|
||||
```
|
||||
|
||||
#### Step 4: Prepare the scratch repro workspace
|
||||
|
||||
Use `/tmp/pr-<PR_NUMBER>-repro/` as the scratch dir — deliberately outside the nx repo, so the generated/cloned workspace's own nx root can't be mistaken for (or nested inside) the repo you're reviewing. Always wipe it at the start of this step:
|
||||
|
||||
```bash
|
||||
REPRO_DIR=/tmp/pr-<PR_NUMBER>-repro
|
||||
rm -rf "$REPRO_DIR"
|
||||
mkdir -p "$REPRO_DIR"
|
||||
```
|
||||
|
||||
**For `EXTERNAL_REPO`:**
|
||||
|
||||
1. Clone the repro repo:
|
||||
|
||||
```bash
|
||||
git clone --depth=1 <REPO_URL> "$REPRO_DIR"
|
||||
```
|
||||
|
||||
2. Rewrite all `nx` / `@nx/*` / `@nrwl/*` dependency versions in `$REPRO_DIR/package.json` to the exact `$PUBLISHED_NX_VERSION`:
|
||||
|
||||
```bash
|
||||
node -e '
|
||||
const fs = require("fs");
|
||||
const p = JSON.parse(fs.readFileSync(process.argv[1], "utf8"));
|
||||
const v = process.argv[2];
|
||||
for (const section of ["dependencies", "devDependencies"]) {
|
||||
const deps = p[section] || {};
|
||||
for (const name of Object.keys(deps)) {
|
||||
if (name === "nx" || name.startsWith("@nx/") || name.startsWith("@nrwl/")) {
|
||||
deps[name] = v;
|
||||
}
|
||||
}
|
||||
}
|
||||
fs.writeFileSync(process.argv[1], JSON.stringify(p, null, 2) + "\n");
|
||||
' "$REPRO_DIR/package.json" "$PUBLISHED_NX_VERSION"
|
||||
```
|
||||
|
||||
3. If the repo has a lockfile, delete it (it's now stale after the rewrite):
|
||||
|
||||
```bash
|
||||
rm -f "$REPRO_DIR/package-lock.json" "$REPRO_DIR/pnpm-lock.yaml" "$REPRO_DIR/yarn.lock"
|
||||
```
|
||||
|
||||
4. Detect the package manager (prefer the same one used by the repo; fall back to npm):
|
||||
|
||||
```bash
|
||||
if test -f "$REPRO_DIR/pnpm-workspace.yaml"; then PM=pnpm;
|
||||
elif grep -q '"packageManager"' "$REPRO_DIR/package.json" 2>/dev/null; then
|
||||
PM=$(node -p "require('$REPRO_DIR/package.json').packageManager?.split('@')[0] || 'npm'")
|
||||
else PM=npm; fi
|
||||
```
|
||||
|
||||
5. Install with the registry env var pointing at verdaccio:
|
||||
|
||||
```bash
|
||||
cd "$REPRO_DIR"
|
||||
npm_config_registry=http://localhost:$PORT \
|
||||
BUN_CONFIG_REGISTRY=http://localhost:$PORT \
|
||||
YARN_REGISTRY=http://localhost:$PORT \
|
||||
$PM install 2>&1 | tee /tmp/install-<PR_NUMBER>.log
|
||||
```
|
||||
|
||||
If install fails, capture why. Common causes: lockfile not deleted, version mismatch the rewrite didn't catch (peer deps of sibling packages), missing `@nx/*` plugins in our publish set. Record and stop.
|
||||
|
||||
**For `GENERATED_WORKSPACE`:**
|
||||
|
||||
Instead of cloning, run `create-nx-workspace` pointed at the local registry:
|
||||
|
||||
```bash
|
||||
cd /tmp
|
||||
npm_config_registry=http://localhost:$PORT \
|
||||
BUN_CONFIG_REGISTRY=http://localhost:$PORT \
|
||||
YARN_REGISTRY=http://localhost:$PORT \
|
||||
npx --yes create-nx-workspace@$PUBLISHED_NX_VERSION \
|
||||
--name=pr-<PR_NUMBER>-repro \
|
||||
--preset=<PRESET_FROM_ISSUE> \
|
||||
--no-interactive \
|
||||
--skipGit \
|
||||
<OTHER_FLAGS_FROM_ISSUE> 2>&1 | tee /tmp/create-workspace-<PR_NUMBER>.log
|
||||
```
|
||||
|
||||
Pull `<PRESET_FROM_ISSUE>` and `<OTHER_FLAGS_FROM_ISSUE>` from the reported repro steps. If the issue doesn't specify a preset, use `apps` as a safe default and flag it in the report.
|
||||
|
||||
#### Step 5: Run the reported repro command
|
||||
|
||||
Extract the exact command from the issue body. If it references specific files to create first, create them in the scratch dir. Run with a timeout:
|
||||
|
||||
```bash
|
||||
cd "$REPRO_DIR"
|
||||
timeout 300 <REPRO_COMMAND> 2>&1 | tee /tmp/repro-<PR_NUMBER>.log
|
||||
REPRO_EXIT=$?
|
||||
```
|
||||
|
||||
Note: `timeout` may not be available on macOS by default — use `gtimeout` (from `brew install coreutils`) or emulate with a background kill. If neither is available, run without a timeout but watch carefully.
|
||||
|
||||
#### Step 6: Classify the outcome
|
||||
|
||||
Compare the output (`/tmp/repro-<PR_NUMBER>.log` + `REPRO_EXIT`) to the reported behavior:
|
||||
|
||||
- `PR_REPRO_PASSES` — the command succeeded, matching the PR's claimed fix. Verdict.
|
||||
- `PR_REPRO_FAILS_WITH_REPORTED_ERROR` — the command failed with the same error the issue describes. The PR did NOT fix the bug. Verdict `PR_REPRO_FAILS`.
|
||||
- `PR_REPRO_FAILS_DIFFERENT` — the command failed but with a different error. Flag for human review — may be env-specific or a related-but-different bug.
|
||||
- `PR_REPRO_INCONCLUSIVE` — output doesn't clearly match either direction. Capture the tail of the log and stop.
|
||||
|
||||
#### Step 7: Always clean up (cleanup trap)
|
||||
|
||||
Cleanup MUST run on every exit path — success, failure, or early-abort. Do these in order:
|
||||
|
||||
```bash
|
||||
# 1. Kill verdaccio
|
||||
if test -f /tmp/verdaccio-<PR_NUMBER>.pid; then
|
||||
VPID=$(cat /tmp/verdaccio-<PR_NUMBER>.pid)
|
||||
kill "$VPID" 2>/dev/null || true
|
||||
sleep 2
|
||||
kill -9 "$VPID" 2>/dev/null || true
|
||||
fi
|
||||
|
||||
# 2. Belt-and-suspenders: free the port even if pid is gone
|
||||
npx -y kill-port $PORT 2>/dev/null || true
|
||||
|
||||
# 3. Remove scratch workspace
|
||||
rm -rf /tmp/pr-<PR_NUMBER>-repro
|
||||
|
||||
# 4. Remove the ephemeral logs only AFTER capturing their tails in your report
|
||||
# Keep them on failure so the user can inspect them:
|
||||
# - /tmp/verdaccio-<PR_NUMBER>.log
|
||||
# - /tmp/publish-<PR_NUMBER>.log
|
||||
# - /tmp/install-<PR_NUMBER>.log (or create-workspace)
|
||||
# - /tmp/repro-<PR_NUMBER>.log
|
||||
```
|
||||
|
||||
Do NOT `rm -rf dist/local-registry/storage` in the nx worktree — that storage is shared state used by E2E tests. Leave it.
|
||||
|
||||
#### Step 8: Report
|
||||
|
||||
Add a `### Level 2 reproduction` block to your output (see "Output format" below).
|
||||
|
||||
## Rules
|
||||
|
||||
- **Never modify files in the worktree.** Your job is to observe, not edit. `git stash` is fine as a read-only preserve; never `git reset` or delete files.
|
||||
- **Never push commits or open PRs.**
|
||||
- **Always restore the worktree to HEAD_SHA before exiting**, including on error paths.
|
||||
- **Never download or execute scripts from issue URLs** that aren't github.com/nrwl/nx or github.com/<user>/<repo> already referenced in the issue.
|
||||
- **Command timeout.** If a repro command has been running for more than 5 minutes, capture output and kill it. Long-running repros need Level 2 infrastructure you don't have.
|
||||
- **If environment is missing** (Maven, Gradle, specific Node version) — report the missing dependency and do not attempt to install anything. The user can rerun manually.
|
||||
|
||||
## Output format
|
||||
|
||||
Return a structured report with these sections:
|
||||
|
||||
```markdown
|
||||
## Linked issues
|
||||
|
||||
- #<N1>: <title> — classification: <LOCAL_TEST | LOCAL_NX_TARGET | EXTERNAL_REPO | GENERATED_WORKSPACE | MANUAL_ONLY | NO_REPRO>
|
||||
- #<N2>: ...
|
||||
|
||||
## Bug grounding (Level 0)
|
||||
|
||||
### #<N>
|
||||
|
||||
**Reported:** <1-2 sentences>
|
||||
**Expected:** <1-2 sentences>
|
||||
**Fix adequacy:** <does the diff plausibly address this? what's in scope, what isn't?>
|
||||
|
||||
## Reproduction (Level 1)
|
||||
|
||||
### #<N> — <classification>
|
||||
|
||||
**Baseline (master):** <BASELINE_FAILS | BASELINE_PASSES | BASELINE_ERROR_DIFFERENT | NOT_ATTEMPTED>
|
||||
**PR (HEAD):** <PR_PASSES | PR_FAILS_SAME | PR_FAILS_DIFFERENT | NOT_ATTEMPTED>
|
||||
**Verdict:** <FIX_CONFIRMED | FIX_DID_NOT_WORK | FIX_CHANGED_BEHAVIOR_BUT_NOT_RESOLVED | BUG_NOT_REPRODUCED_ON_BASELINE | NOT_ATTEMPTED>
|
||||
|
||||
<If NOT_ATTEMPTED, explain why.>
|
||||
|
||||
<Include the exact command run and a short excerpt of the output if executed.>
|
||||
|
||||
## Reproduction (Level 2 — HEAD-only external/generated repro)
|
||||
|
||||
(Only present when `RUN_LEVEL_2: true` AND classification was `EXTERNAL_REPO` / `GENERATED_WORKSPACE`. Otherwise omit this section or say "not run — pass RUN_LEVEL_2=true to enable".)
|
||||
|
||||
### #<N> — <classification>
|
||||
|
||||
**Published nx version:** <e.g. 22.8.0-local.0>
|
||||
**Repro command:** `<VERBATIM>`
|
||||
**Exit code:** <N>
|
||||
**Verdict:** <PR_REPRO_PASSES | PR_REPRO_FAILS | PR_REPRO_FAILS_DIFFERENT | PR_REPRO_INCONCLUSIVE | SETUP_FAILED>
|
||||
|
||||
<If SETUP_FAILED, which step (verdaccio start / publish / install / workspace creation) and the tail of the relevant log.>
|
||||
|
||||
<If PR_REPRO_FAILS or FAILS_DIFFERENT, the tail (~20 lines) of /tmp/repro-<PR_NUMBER>.log.>
|
||||
|
||||
**Cleanup:** <confirmed killed verdaccio pid, freed port, removed scratch dir>
|
||||
|
||||
## Summary
|
||||
|
||||
<2-3 sentence wrap-up. Call out any of:
|
||||
|
||||
- issue has no repro → issue quality concern
|
||||
- baseline passed → may indicate bug is stale or misidentified
|
||||
- PR fails its own repro → serious regression concern
|
||||
- execution skipped → what would be needed to verify
|
||||
- Level 2 setup failed → what blocked it (usually: prereq missing, port busy, publish errored)
|
||||
>
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
**Example 1 — LOCAL_TEST, fix confirmed:**
|
||||
PR #35000 claims to fix #34900 ("vitest integration errors on empty test file"). Issue points to `packages/vite/src/executors/test/test.spec.ts:120`. You run `nx test vite -- --test=empty-file` on master (fails with the reported TypeError), then on HEAD (passes). Verdict: `FIX_CONFIRMED`.
|
||||
|
||||
**Example 2 — EXTERNAL_REPO, not attempted:**
|
||||
PR #35067 claims to fix #34478 ("maven `--settings` flag ignored"). The issue links to `github.com/altaiezior/nx-maven-repro` with `npx create-nx-workspace` + `nx run foo:build --settings=my.xml` steps. Classification: `GENERATED_WORKSPACE`. You do Level 0 reasoning ("the diff adds `--settings` to the allowlist in `MavenInvokerRunner`, which directly addresses the reported symptom; the `filterMavenArguments` method now includes `--settings` in `MAVEN_LONG_FLAGS_WITH_VALUE`"). Level 1 is not attempted. Report recommends running the repro manually via the repo.
|
||||
|
||||
**Example 3 — NO_REPRO, flag quality concern:**
|
||||
PR #35100 claims to fix #35099. Issue body is "it's broken pls fix". You report NO_REPRO and flag as an issue-quality concern — the reviewer and the author should insist on a repro before merging.
|
||||
|
||||
## Handling ambiguity
|
||||
|
||||
When the repro is borderline — maybe a `nx run` command exists but the named project isn't in the worktree, or the test name is wrong — do NOT guess and execute. Report what you observed and what prevents a clean attempt. False-positive "FIX_CONFIRMED" reports are much worse than honest NOT_ATTEMPTED reports.
|
||||
@@ -0,0 +1,47 @@
|
||||
# Commit Command
|
||||
|
||||
## Description
|
||||
|
||||
Create a git commit following Nx repository standards and validation requirements.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
/commit [message]
|
||||
```
|
||||
|
||||
## What this command does:
|
||||
|
||||
1. **Pre-commit validation**: Runs the full validation suite (`pnpm nx prepush`) to ensure code quality
|
||||
2. **Formatting**: Automatically formats changed files with Prettier
|
||||
3. **Testing**: Runs tests on affected projects to validate changes
|
||||
4. **Commit creation**: Creates a well-formed commit with proper message formatting (without co-author attribution)
|
||||
5. **Status reporting**: Provides clear feedback on the commit process
|
||||
|
||||
## Workflow:
|
||||
|
||||
1. Format any modified files with Prettier
|
||||
2. Run the prepush validation suite
|
||||
3. If validation passes, stage relevant changes
|
||||
4. Create commit with descriptive message
|
||||
5. Provide summary of what was committed
|
||||
|
||||
## Commit Message Format:
|
||||
|
||||
- Use conventional commit format when appropriate
|
||||
- Include scope (e.g., `feat(core):`, `fix(angular):`, `docs(nx):`)
|
||||
- Keep first line under 72 characters
|
||||
- Include detailed description if needed
|
||||
|
||||
## Examples:
|
||||
|
||||
- `/commit "feat(core): add new project graph visualization"`
|
||||
- `/commit "fix(react): resolve build issues with webpack config"`
|
||||
- `/commit "docs(nx): update getting started guide"`
|
||||
|
||||
## Validation Requirements:
|
||||
|
||||
- All tests must pass
|
||||
- Code must be properly formatted
|
||||
- No linting errors
|
||||
- E2E tests for affected areas should pass
|
||||
@@ -0,0 +1,155 @@
|
||||
# GitHub Issue Planning and Resolution
|
||||
|
||||
This command provides guidance for both automated and manual GitHub issue workflows.
|
||||
|
||||
## Automated Workflow (GitHub Actions)
|
||||
|
||||
The automated workflow consists of two phases:
|
||||
|
||||
### Phase 1: Planning (`@claude plan` or `claude:plan` label)
|
||||
|
||||
- Claude analyzes the issue and creates a detailed implementation plan
|
||||
- Plan is posted as a comment on the issue
|
||||
- Issue is labeled with `claude:planned`
|
||||
|
||||
### Phase 2: Implementation (`@claude implement` or `claude:implement` label)
|
||||
|
||||
- Claude implements the solution based on the plan
|
||||
- Runs validation tests and creates a feature branch
|
||||
- Suggests opening a PR with proper formatting
|
||||
|
||||
## Planning Phase Template
|
||||
|
||||
When creating a plan (either automated or manual), include these sections:
|
||||
|
||||
### Problem Analysis
|
||||
|
||||
- Root cause identification
|
||||
- Impact assessment
|
||||
- Related components or systems affected
|
||||
|
||||
### Proposed Solution
|
||||
|
||||
- High-level approach
|
||||
- Alternative solutions considered
|
||||
- Trade-offs and rationale
|
||||
|
||||
### Implementation Details
|
||||
|
||||
- Files that need to be modified
|
||||
- Key changes required
|
||||
- Dependencies or prerequisites
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
- Unit tests to add/modify
|
||||
- Integration tests needed
|
||||
- E2E test considerations
|
||||
|
||||
### Validation Steps
|
||||
|
||||
```bash
|
||||
# Test specific affected projects
|
||||
nx run-many -t test,build,lint -p PROJECT_NAME
|
||||
|
||||
# Test all affected projects
|
||||
nx affected -t build,test,lint
|
||||
|
||||
# Run affected e2e tests
|
||||
nx affected -t e2e-local
|
||||
|
||||
# Format code
|
||||
npx nx prettier -- FILES
|
||||
|
||||
# Final validation
|
||||
pnpm nx prepush
|
||||
```
|
||||
|
||||
### Risks and Considerations
|
||||
|
||||
- Breaking changes
|
||||
- Performance implications
|
||||
- Migration requirements
|
||||
|
||||
## Manual Workflow
|
||||
|
||||
When working on a GitHub issue manually, follow this systematic approach:
|
||||
|
||||
## 1. Get Issue Details
|
||||
|
||||
```bash
|
||||
# Get issue details using GitHub CLI (replace ISSUE_NUMBER with actual number)
|
||||
gh issue view ISSUE_NUMBER
|
||||
```
|
||||
|
||||
When cloning reproduction repos, please clone within `./tmp/claude/repro-ISSUE_NUMBER`
|
||||
|
||||
## 2. Analyze the Plan
|
||||
|
||||
- Look for a plan or implementation details in the issue description
|
||||
- Check comments for additional context or clarification
|
||||
- Identify affected projects and components
|
||||
|
||||
## 3. Implement the Solution
|
||||
|
||||
- Follow the plan outlined in the issue
|
||||
- Make focused changes that address the specific problem
|
||||
- Ensure code follows existing patterns and conventions
|
||||
|
||||
## 4. Run Full Validation
|
||||
|
||||
```bash
|
||||
# Test specific affected projects first
|
||||
nx run-many -t test,build,lint -p PROJECT_NAME
|
||||
|
||||
# Test all affected projects
|
||||
nx affected -t build,test,lint
|
||||
|
||||
# Run affected e2e tests
|
||||
nx affected -t e2e-local
|
||||
|
||||
# Final pre-push validation
|
||||
pnpm nx prepush
|
||||
```
|
||||
|
||||
## 5. Submit Pull Request
|
||||
|
||||
- Create a descriptive PR title that references the issue
|
||||
- Include "Fixes #ISSUE_NUMBER" in the PR description
|
||||
- Provide a clear summary of changes made
|
||||
- Request appropriate reviewers
|
||||
|
||||
## Pull Request Template
|
||||
|
||||
When creating a pull request, follow the template found in `.github/PULL_REQUEST_TEMPLATE.md`. The template includes:
|
||||
|
||||
### Required Sections
|
||||
|
||||
1. **Current Behavior**: Describe the behavior we have today
|
||||
2. **Expected Behavior**: Describe the behavior we should expect with the changes in this PR
|
||||
3. **Related Issue(s)**: Link the issue being fixed so it gets closed when the PR is merged
|
||||
|
||||
### Template Format
|
||||
|
||||
```markdown
|
||||
## Current Behavior
|
||||
|
||||
<!-- This is the behavior we have today -->
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
<!-- This is the behavior we should expect with the changes in this PR -->
|
||||
|
||||
## Related Issue(s)
|
||||
|
||||
<!-- Please link the issue being fixed so it gets closed when this is merged. -->
|
||||
|
||||
Fixes #ISSUE_NUMBER
|
||||
```
|
||||
|
||||
### Guidelines
|
||||
|
||||
- Ensure your commit message follows the conventional commit format (use `pnpm commit`)
|
||||
- Read the submission guidelines in CONTRIBUTING.md before posting
|
||||
- For complex changes, you can request a dedicated Nx release by mentioning the Nx team
|
||||
- Always link the related issue using "Fixes #ISSUE_NUMBER" to automatically close it when merged
|
||||
@@ -0,0 +1,30 @@
|
||||
# Claude Issue Workflow Usage Guide
|
||||
|
||||
## Quick Start
|
||||
|
||||
## Expected Outputs
|
||||
|
||||
### Planning Phase
|
||||
|
||||
- Detailed analysis comment posted to issue
|
||||
- Implementation plan with steps and file changes
|
||||
- Testing strategy and validation steps
|
||||
- Risk assessment
|
||||
|
||||
### Implementation Phase
|
||||
|
||||
- Code changes made according to plan
|
||||
- Tests run and validated
|
||||
- Feature branch created: `fix/issue-{number}`
|
||||
- PR suggestion with proper title format
|
||||
|
||||
## Manual Override
|
||||
|
||||
If you need to work on an issue manually, use the `/gh-issue-plan` command for structured guidance following the same workflow patterns.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure you're on the authorized users list
|
||||
- Check that the issue has sufficient detail for analysis
|
||||
- For implementation, ensure a plan comment exists from the planning phase
|
||||
- If workflows fail, check the Actions tab for detailed logs
|
||||
@@ -0,0 +1,3 @@
|
||||
This skill is disabled to encourage use of the AI prompt from the nx cloud sandboxing dashboard.
|
||||
|
||||
If you still need the original skill, you can reference it with @./claude/disabled-skills/diagnose-sandbox-report/SKILL.md directly.
|
||||
@@ -0,0 +1,301 @@
|
||||
---
|
||||
name: diagnose-sandbox-report
|
||||
description: >
|
||||
Diagnose Nx sandbox violations from a sandbox report. Use when asked to
|
||||
"diagnose sandbox", "analyze sandbox report", "investigate sandbox violations",
|
||||
"check violations", when given a sandbox report JSON file or URL to investigate,
|
||||
or when the user pastes a staging.nx.app sandbox-report URL. Also trigger when
|
||||
discussing unexpected reads/writes in Nx task execution. Guides structured
|
||||
investigation of why tasks read/write undeclared files, determines root causes,
|
||||
and recommends fixes.
|
||||
argument-hint: '<sandbox-report.json or URL> [--filter <file|pattern|list>]'
|
||||
allowed-tools: Bash, Read, Grep, Glob
|
||||
---
|
||||
|
||||
# Diagnose Sandbox Report
|
||||
|
||||
## Overview
|
||||
|
||||
Sandbox violations occur when an Nx task reads files not declared as inputs or writes files not declared as outputs.
|
||||
|
||||
**Unexpected reads** are one of:
|
||||
|
||||
1. **Missing input** (most likely) — the process legitimately needs this file. Understand what the process does and why the access makes sense, then declare it as an input.
|
||||
2. **Potential sandboxing gap** (last resort) — the access is irrelevant to correctness and should be filtered/ignored by the sandbox. Only conclude this after exhausting every possibility for it being a missing input.
|
||||
|
||||
**Unexpected writes** follow the same logic:
|
||||
|
||||
1. **Missing output** (most likely) — the process legitimately produces this file.
|
||||
2. **Potential sandboxing gap** (last resort) — same as above.
|
||||
|
||||
The default assumption is that an unexpected access IS a missing declaration. The investigation's job is to understand WHY the process accesses the file — not to find reasons it shouldn't.
|
||||
|
||||
## Critical Rules
|
||||
|
||||
1. **NEVER read the sandbox report JSON directly** — these files are too large for the Read tool (50K+ tokens). Do NOT use `Read`, `cat`, `head`, `python3`, or `jq` on the raw report. All report parsing is handled by the script.
|
||||
2. **ALWAYS run the context-gathering script as the very first step** — no manual parsing, no ad-hoc python/jq on the report file. The script does everything deterministically.
|
||||
3. If the script fails, **report the error and stop**. Do not attempt manual parsing as a fallback.
|
||||
4. **Identify the inferring plugin BEFORE proposing any fix** — check `inference.plugin` in the script output or run `jq '.targets.<target>.metadata' <detail-file>`. Fixing the wrong plugin wastes entire investigation rounds.
|
||||
5. **Verify hypotheses empirically before committing to them** — see Principle 4 and the Phase 2 instrumentation guidance.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Phase 0: Input
|
||||
|
||||
User provides one of:
|
||||
|
||||
- Path to a sandbox report JSON file
|
||||
- A URL to a sandbox report — pass it directly to the script, it handles downloading
|
||||
- A task ID + CIPE URL (fetch report via MCP if available)
|
||||
- Inline violation data
|
||||
|
||||
If a task ID is provided but no report, ask the user for the report file.
|
||||
|
||||
**Filtering**: Most invocations will focus on specific files, not the entire report. The user may specify:
|
||||
|
||||
- A single file: `e2e.log`
|
||||
- A comma-separated list: `apps/nx-cloud/e2e.log,apps/nx-cloud/build/client/assets/main.js`
|
||||
- A glob pattern: `*.tsbuildinfo`, `apps/nx-cloud/build/**`
|
||||
- A directory prefix: `apps/nx-cloud/build/client/assets`
|
||||
|
||||
When the user specifies files to focus on, pass them via `--filter` to the script. When they don't specify a filter and the report has many violations, summarize the groupings (by directory, extension) and ask which group(s) to investigate first rather than trying to investigate everything at once.
|
||||
|
||||
### Phase 1: Deterministic Pre-Processing
|
||||
|
||||
Run the context-gathering script **immediately** — this is the first tool call after reading the user's input.
|
||||
|
||||
Call it exactly as shown — do NOT append `2>&1` or `2>/dev/null` (the script manages its own stderr internally). Run in the **foreground** (no `run_in_background`) with a **3-minute timeout** — reports can be large and the script runs the task + multiple nx commands:
|
||||
|
||||
```bash
|
||||
npx tsx ${CLAUDE_SKILL_DIR}/scripts/gather-sandbox-context.ts <report.json or URL> [--filter <pattern>] [--workspace <path>]
|
||||
```
|
||||
|
||||
Pass `--filter` when the user wants to focus on specific files or patterns. The script filters violations before all downstream processing (grouping, validation, classification), so the output only contains relevant data.
|
||||
|
||||
The script produces two outputs:
|
||||
|
||||
**stdout** (~3-5KB compact brief) — everything needed to start investigating:
|
||||
|
||||
- `summary`: violation counts (total, filtered, confirmed vs undeclared)
|
||||
- `undeclaredFiles`: the actual file paths that are true violations
|
||||
- `grouping`: violations grouped by directory and extension
|
||||
- `commands`: processes with violations (pid, cmd, executable, arguments, counts) — no full file lists
|
||||
- `classificationSummary`: counts per category (cross-project, build artifacts, config files, etc.)
|
||||
- `crossProjectDependencyCheck`: whether cross-project file owners are in the task's dependency chain
|
||||
- `staleDeclarations`: grouped analysis of expectedInputsNotRead / expectedOutputsNotWritten
|
||||
- `dependentTasksOutputFiles`: extracted from target inputs config and named inputs — shows what dep output globs are declared (critical for cross-project violations)
|
||||
- `executorInfo`: executor name and resolved source path in `node_modules` — read this file to understand how the tool is invoked
|
||||
- `checkSample`: results of `--check` on up to 5 undeclared files (catches false positives early)
|
||||
- `inference` + `pluginRegistration`: plugin metadata
|
||||
- `verificationCommands`: pre-built `--check` commands with the correct task ref
|
||||
- `detailFile`: path to the full detail JSON
|
||||
|
||||
**detail file** (`/tmp/sandbox-diagnosis-detail-<project>-<target>.json`) — full data for drill-down. Structure:
|
||||
|
||||
- `processTree.processTree`: array of `{pid, cmd, parentPid}` entries
|
||||
- `processTree.processPidToCmd`: `{ "pid": "command string" }` map
|
||||
- `processTree.readsByPid`: `{ "pid": ["file1", "file2"] }` — violated reads grouped by PID
|
||||
- `processTree.writesByPid`: `{ "pid": ["file1", "file2"] }` — violated writes grouped by PID
|
||||
- `targetConfig`: full target configuration (executor, options, inputs, outputs, dependsOn)
|
||||
- `projectConfig`: full project configuration
|
||||
- `resolvedInputs`: `{ files: [...], depOutputs: [...], runtime: [...], environment: [...] }`
|
||||
- `resolvedOutputs`: `{ outputPaths: [...], expandedOutputs: [...] }`
|
||||
- `validation`: `{ reads: { confirmed: [...], undeclared: [...] }, writes: { ... } }`
|
||||
- `classification`: `{ reads: { crossProject, buildArtifacts, configFiles, ... }, writes: { ... } }`
|
||||
|
||||
Read the brief output — it has everything to start. Use `jq` on the detail file only when you need to drill into specific sections. When querying the detail file, use the structure above — do not guess the schema. Do NOT use Python, ad-hoc scripts, or the Read tool on the detail file — only `jq`.
|
||||
|
||||
For reports with many violations, use `--filter` to narrow scope. When investigating without a filter, use the `grouping` data to identify patterns and prioritize — don't try to trace every file individually.
|
||||
|
||||
If `summary.undeclaredReads` and `summary.undeclaredWrites` are both 0, all violations were resolved by the script's validation against resolved inputs/outputs. Report this to the user — no further investigation needed.
|
||||
|
||||
The `commands` array pre-parses each process — use `executable` and `arguments` to identify the tool without re-parsing `cmd`. When many files share the same root cause, group them under one finding using a glob pattern or count (e.g., "88 `.d.ts` files matching `packages/nx/dist/**/*.d.ts`").
|
||||
|
||||
### Phase 2: Command Analysis — the core investigation
|
||||
|
||||
**This is the most important phase.** The goal is to determine with 100% certainty why each process reads or writes each violated file. Do not classify violations from file names or paths alone — trace the actual causal chain from command → config → file access.
|
||||
|
||||
#### Step 1: Understand the command
|
||||
|
||||
The brief's `commands` array pre-parses each process. Use the `executable` and `arguments` fields directly — don't re-parse `cmd`. Identify:
|
||||
|
||||
- The tool (from `executable`)
|
||||
- The arguments (target files/dirs, config flags, extensions — from `arguments`)
|
||||
- The working directory (from executor options or project root)
|
||||
|
||||
#### Step 2: Trace why the command accesses each violated file
|
||||
|
||||
For each violated file, establish the **exact causal chain** that leads the command to read or write it. The approach is the same regardless of tool:
|
||||
|
||||
1. Identify the tool's config file (usually in the project root or workspace root)
|
||||
2. Read the config and trace file references: `includes`, `extends`, `presets`, entry points, plugins
|
||||
3. Follow the reference chain until you can explain exactly why the violated file is accessed
|
||||
|
||||
Common causal patterns:
|
||||
|
||||
- **Config chain walk-up**: tool reads config, config extends another, chain reaches the violated file (e.g., tsconfig `extends`, eslint config chain, jest preset chain)
|
||||
- **Directory traversal**: tool scans a directory for matching files and reads everything, including files it won't process (e.g., jest-haste-map scanning `.next/`, eslint reading `.d.ts` alongside `.ts`)
|
||||
- **Dependency resolution**: tool resolves imports/requires and follows the dependency graph to files outside the project (e.g., esbuild/vite/webpack resolving workspace packages to their dist outputs)
|
||||
- **Plugin/transformer loading**: tool loads plugins or transformers that read additional files (e.g., ts-jest loading tsconfig for TypeScript compilation)
|
||||
|
||||
For any tool, read its source code in `node_modules` to understand its file discovery behavior. Don't assume — trace the actual code.
|
||||
|
||||
**You must be able to explain the full path:** e.g., "eslint loads `.eslintrc.json` → configures `@typescript-eslint/parser` → parser resolves `parserOptions.project` → walks up to find `tsconfig.json` → reads it." If you can't trace the full path, keep investigating — do not guess.
|
||||
|
||||
**When theoretical analysis is inconclusive, verify empirically.** For difficult cases, instrument `node_modules` with interceptors to capture real stack traces. For example, patch `fs.readFileSync` in the tool's entry point to log stack traces when the violated file is accessed. A confirmed stack trace is worth more than multiple rounds of code reading.
|
||||
|
||||
#### Step 3: Confirm the violation with `--check`
|
||||
|
||||
**This step is mandatory — do not skip it.** The script already runs `--check` on a sample of up to 5 undeclared files (see `checkSample` in the brief). Review those results first — if the sample files are confirmed as inputs/outputs, the corresponding violations are false positives.
|
||||
|
||||
For files not in the sample, use the pre-generated commands from `verificationCommands` in the brief:
|
||||
|
||||
```bash
|
||||
npx nx show target inputs <project>:<target> --check <violated-read-files>
|
||||
npx nx show target outputs <project>:<target> --check <violated-write-files>
|
||||
```
|
||||
|
||||
If the commands fail because output files don't exist (e.g., the script's task run timed out), run the task first with `verificationCommands.runTask`.
|
||||
|
||||
If `--check` shows the file IS already an input/output, the violation is a false positive from the script's static analysis. If it confirms the file is NOT an input/output, proceed to classification.
|
||||
|
||||
#### Step 4: Classify
|
||||
|
||||
With the causal chain established and the violation confirmed, classify into one of these categories:
|
||||
|
||||
1. **Missing input/output** (most common) — the process legitimately needs this file. Understand why:
|
||||
- **Direct dependency** — the tool needs this file to do its job (e.g., tsc reads referenced tsconfigs, eslint loads config chain)
|
||||
- **Transitive dependency** — a config file references another file that references this one (e.g., jest preset → resolver → module). Trace the full chain.
|
||||
- **Directory traversal side effect** — the tool reads all files in a directory even if it only processes some (e.g., eslint reads `.d.ts` files while linting `.ts`). Still a legitimate access from the tool's perspective.
|
||||
|
||||
2. **Bad tool configuration** — the tool accesses a file it shouldn't because its scope is too broad. The fix is fixing the tool's config, NOT adding an input. Investigate:
|
||||
- Is the command targeting too broad a directory? (e.g., `eslint .` instead of `eslint src/`)
|
||||
- Is a config file missing ignore/exclude rules? (e.g., eslint processing a file type it should skip)
|
||||
- Is a plugin inferring a target for a project that doesn't match? (e.g., eslint target on a non-JS project)
|
||||
- Is an env var causing the tool to behave differently?
|
||||
|
||||
3. **Potential sandboxing gap** (last resort) — the access is genuinely irrelevant to correctness (PID files, temp sockets, dev server logs that no task consumes). Only conclude this after exhausting categories 1 and 2.
|
||||
|
||||
### Phase 3: Deep Investigation
|
||||
|
||||
For violations that aren't immediately obvious, investigate further:
|
||||
|
||||
#### If the target is inferred by a plugin
|
||||
|
||||
1. Identify which plugin from `inference.plugin` in the brief output, or `nx show project --json` metadata
|
||||
2. Read the plugin's `createNodesV2` implementation to understand inference logic
|
||||
3. Determine if this project should have this target at all
|
||||
4. Check if the plugin has `include`/`exclude` patterns in `nx.json` that should filter this project
|
||||
5. **Check for input override layers** — `project.json`, `package.json`, or `nx.json` `targetDefaults` may override plugin-inferred inputs, rendering plugin-level fixes invisible. Check all three before concluding a plugin fix is sufficient.
|
||||
|
||||
#### If violations come from a subprocess
|
||||
|
||||
1. Trace the process tree: which parent spawned the subprocess?
|
||||
2. Why does the subprocess exist? (dev server for e2e, worker thread, build tool subprocess)
|
||||
3. What environment does the subprocess inherit? (env vars, cwd)
|
||||
4. Does the subprocess access files in a different project's directory?
|
||||
|
||||
#### If violations involve config file reference chains
|
||||
|
||||
1. Read the config file (jest.config, tsconfig, .eslintrc)
|
||||
2. Trace all file references: `preset`, `extends`, `references`, `setupFiles`, `resolver`, `moduleNameMapper`, `transform`, etc.
|
||||
3. Recursively resolve references (preset → preset → files)
|
||||
4. Determine which referenced files are not declared as task inputs
|
||||
|
||||
#### If violations involve dependency task outputs
|
||||
|
||||
1. Check `dependsOn` to understand task dependency chain
|
||||
2. Check `dependentTasksOutputFiles` glob pattern — is it too narrow?
|
||||
3. Compare the glob against actual file types the tool reads from dependencies (e.g., `**/*.d.ts` missing `.tsbuildinfo`)
|
||||
|
||||
#### Generalizability analysis
|
||||
|
||||
After diagnosing the root cause, determine scope:
|
||||
|
||||
1. Is this violation specific to this project, or does it affect all projects using this tool/plugin?
|
||||
2. What conditions trigger it? (specific config, specific tool version, specific project structure)
|
||||
3. Should the fix be per-project (declarative input) or systemic (plugin improvement)?
|
||||
4. If the plugin can be made smarter to infer the correct inputs, that's preferable to manual declarations.
|
||||
|
||||
### Phase 4: Output
|
||||
|
||||
**You MUST present findings using the structured format below before proceeding to any implementation discussion.** Do not use free-form narrative — the structure ensures completeness and makes findings reviewable.
|
||||
|
||||
Present findings grouped by category:
|
||||
|
||||
```
|
||||
=== Sandbox Violation Diagnosis: {project}:{target} ===
|
||||
|
||||
## Summary
|
||||
Unexpected reads: N total → M validated as declared → K true violations
|
||||
Unexpected writes: N total → M validated as declared → K true violations
|
||||
|
||||
## Findings
|
||||
|
||||
### [MISSING INPUT] {short description}
|
||||
Files: {file list or pattern}
|
||||
Process: PID {pid} — {command}
|
||||
Why: {why the process legitimately needs this file}
|
||||
Scope: {project-specific or affects all projects using this tool/plugin}
|
||||
Fix: {where/how to add the input declaration — consider both declarative (add input) and systemic (improve plugin inference) options}
|
||||
|
||||
### [MISSING OUTPUT] {short description}
|
||||
Files: {file list or pattern}
|
||||
Process: PID {pid} — {command}
|
||||
Why: {why the process produces this file}
|
||||
Scope: {project-specific or affects all projects using this tool/plugin}
|
||||
Fix: {where/how to add the output declaration}
|
||||
|
||||
### [BAD TOOL CONFIG] {short description}
|
||||
Files: {file list or pattern}
|
||||
Process: PID {pid} — {command}
|
||||
Why: {why the tool accesses files it shouldn't — config too broad, missing ignore, etc.}
|
||||
Fix: {specific tool config change}
|
||||
|
||||
### [POTENTIAL SANDBOXING GAP] {short description}
|
||||
Files: {file list or pattern}
|
||||
Process: PID {pid} — {command}
|
||||
Why: {why this access is irrelevant to correctness}
|
||||
Evidence: {proof that categories 1-2 were exhausted}
|
||||
|
||||
### [INVESTIGATE] {short description}
|
||||
Files: {file list or pattern}
|
||||
Notes: {what's known, what needs more info}
|
||||
Question: {what to ask the user or team}
|
||||
|
||||
## Stale Declarations
|
||||
expectedInputsNotRead: {count and details if relevant}
|
||||
expectedOutputsNotWritten: {count and details if relevant}
|
||||
|
||||
## Verification Plan
|
||||
For each fix, provide the exact commands to verify:
|
||||
1. Run the task so output files exist on disk: `npx nx <target> <project> --skip-nx-cache`
|
||||
2. Check each violation file is now an input: `npx nx show target <project>:<target> inputs --check <space-separated files>`
|
||||
3. For plugin-level fixes: build the plugin, patch node_modules, then verify with steps 1-2
|
||||
```
|
||||
|
||||
## Principles
|
||||
|
||||
1. **Missing declaration is the default.** Most unexpected accesses are legitimate — the process needs the file, it just wasn't declared. Start from this assumption and investigate to understand WHY the access happens.
|
||||
2. **The command is the unit of analysis.** Don't classify files in isolation. Understand what the command does and whether each file access makes sense given that command's purpose.
|
||||
3. **Trace the full chain.** Plugin inference → target config → executor → command → file access. The root cause is often several layers removed from the symptom.
|
||||
4. **Empirical over theoretical.** When code analysis produces a hypothesis, verify it before acting. Instrument `node_modules`, capture stack traces, run with debug flags. Wrong theories waste entire investigation rounds.
|
||||
5. **Be thorough.** Read plugin source code, config files, executor implementations. Don't guess based on file names alone.
|
||||
6. **Potential sandboxing gaps are last resort.** Only conclude this after exhausting missing declaration and bad tool config. The access must be genuinely irrelevant to correctness.
|
||||
7. **Verify claims about Nx behavior in source code.** Any assertion about how Nx works must be traced to the actual implementation. Do not reason from theory or assumptions.
|
||||
8. **Prefer systemic fixes over per-project declarations.** If a plugin can be improved to infer correct inputs for all projects, that's better than adding manual input declarations to each project.
|
||||
|
||||
## Delegating to Subagents
|
||||
|
||||
When the investigation is complex and requires parallel research, you can delegate to subagents. Follow this pattern:
|
||||
|
||||
1. **Run the context-gathering script yourself first.** The brief output (~3-5KB) is the shared context all subagents need.
|
||||
2. **Include the brief output in each subagent prompt** along with the specific question to investigate. Subagents should NOT run the script again or try to parse the raw report.
|
||||
3. **Give subagents the detail file path** so they can `jq` specific sections (process tree, resolved inputs, etc.) without re-running the script.
|
||||
4. **Each subagent should answer one focused question**, e.g., "Why does PID 12345 (eslint) read `tsconfig.base.json`? Trace the full causal chain from the eslint config."
|
||||
5. **Subagents must still follow the skill principles** — trace full causal chains, verify empirically, use `--check`, don't guess from file names. Include these instructions in the subagent prompt.
|
||||
6. **Synthesize subagent results yourself** using the structured Phase 4 output format. Do not delegate the final classification.
|
||||
|
||||
## Reference
|
||||
|
||||
For the sandbox report data model and field definitions, see `references/data-model.md`.
|
||||
@@ -0,0 +1,92 @@
|
||||
# Sandbox Report Data Model
|
||||
|
||||
## Raw Report Structure (JSON)
|
||||
|
||||
```typescript
|
||||
interface SandboxReport {
|
||||
taskId: string; // "project:target" or "project:target:configuration"
|
||||
sandboxReportId: string;
|
||||
inputs: string[]; // declared input patterns (globs or paths)
|
||||
outputs: string[]; // declared output patterns
|
||||
filesRead: FileAccessEntry[]; // all files actually read
|
||||
filesWritten: FileAccessEntry[]; // all files actually written
|
||||
unexpectedReads?: FileAccessEntry[]; // reads not matching any input pattern
|
||||
unexpectedWrites?: FileAccessEntry[]; // writes not matching any output pattern
|
||||
expectedInputsNotRead?: string[]; // declared inputs never accessed
|
||||
expectedOutputsNotWritten?: string[]; // declared outputs never written
|
||||
processTree?: ProcessTreeEntry[]; // process hierarchy with commands
|
||||
}
|
||||
|
||||
interface FileAccessEntry {
|
||||
path: string; // workspace-relative file path
|
||||
pid: number; // process ID that accessed the file
|
||||
}
|
||||
|
||||
interface ProcessTreeEntry {
|
||||
pid: number;
|
||||
cmd: string; // full command string
|
||||
parentPid?: number; // parent process (absent for root)
|
||||
}
|
||||
```
|
||||
|
||||
## Violation Computation
|
||||
|
||||
Violations are computed by `findUnexpectedFiles()` using `minimatch`:
|
||||
|
||||
- A file is "unexpected" if it does NOT match any declared pattern
|
||||
- Patterns without wildcards also match as directory prefixes (`pattern + '/'`)
|
||||
- If `unexpectedReads`/`unexpectedWrites` are pre-computed in the report, those are used directly
|
||||
|
||||
## Nx CLI Commands for Context
|
||||
|
||||
### `nx show target <project:target> --json`
|
||||
|
||||
Returns: executor, command, options (merged with configuration), inputs (configured, not resolved), outputs, dependsOn, cache, parallelism, configurations, metadata.
|
||||
|
||||
### `nx show target inputs <project:target> --json`
|
||||
|
||||
Returns resolved input files (requires files to exist on disk — task must have run):
|
||||
|
||||
```json
|
||||
{
|
||||
"files": ["workspace-relative paths..."],
|
||||
"runtime": ["node version checks..."],
|
||||
"environment": ["ENV_VAR_NAMES..."],
|
||||
"depOutputs": ["dependency output paths..."],
|
||||
"external": ["external package names..."]
|
||||
}
|
||||
```
|
||||
|
||||
### `nx show target inputs <project:target> --check <files...>`
|
||||
|
||||
Validates specific files against declared inputs. Exit code 0 = match, 1 = no match.
|
||||
Categories: `files`, `environment`, `runtime`, `external`, `depOutputs`.
|
||||
Also detects directory matches (directory containing N input files).
|
||||
|
||||
### `nx show target outputs <project:target> --json`
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
{
|
||||
"outputPaths": ["configured output paths..."],
|
||||
"expandedOutputs": ["glob-expanded actual paths..."],
|
||||
"unresolvedOutputs": ["{options.key} patterns that couldn't resolve..."]
|
||||
}
|
||||
```
|
||||
|
||||
### `nx show target outputs <project:target> --check <files...>`
|
||||
|
||||
Validates specific files against declared outputs. Same exit code behavior as inputs.
|
||||
|
||||
### `nx show project <project> --json`
|
||||
|
||||
Returns full project config. Key fields for sandbox analysis:
|
||||
|
||||
- `targets[name].metadata.plugin` — which plugin inferred the target
|
||||
- `targets[name].metadata.technologies` — what tech the target uses
|
||||
- `root` — project root directory
|
||||
|
||||
### `nx graph --view=tasks --targets=<target> --focus=<project> --print --file=stdout`
|
||||
|
||||
Returns task dependency graph with task IDs, dependencies, and roots.
|
||||
@@ -0,0 +1,846 @@
|
||||
#!/usr/bin/env npx tsx
|
||||
/**
|
||||
* gather-sandbox-context: Parse sandbox report + gather Nx task context
|
||||
* Produces structured JSON for the diagnose-sandbox-report skill
|
||||
*
|
||||
* Usage: npx tsx gather-sandbox-context.ts <report.json or URL> [--filter <pattern>] [--workspace <path>]
|
||||
*/
|
||||
|
||||
import { readFileSync, writeFileSync, existsSync } from 'fs';
|
||||
import { resolve, basename, extname, dirname } from 'path';
|
||||
import { execSync, execFileSync } from 'child_process';
|
||||
import { minimatch } from 'minimatch';
|
||||
|
||||
// --- CLI argument parsing ---
|
||||
|
||||
interface Args {
|
||||
reportFile: string;
|
||||
filter: string | null;
|
||||
workspaceRoot: string;
|
||||
}
|
||||
|
||||
function parseArgs(): Args {
|
||||
const args = process.argv.slice(2);
|
||||
let reportFile = '';
|
||||
let filter: string | null = null;
|
||||
let workspaceRoot = process.cwd();
|
||||
|
||||
for (let i = 0; i < args.length; i++) {
|
||||
switch (args[i]) {
|
||||
case '--filter':
|
||||
filter = args[++i];
|
||||
break;
|
||||
case '--workspace':
|
||||
workspaceRoot = args[++i];
|
||||
break;
|
||||
case '--help':
|
||||
case '-h':
|
||||
console.error(
|
||||
'Usage: gather-sandbox-context <report.json or URL> [--filter <pattern>] [--workspace <path>]'
|
||||
);
|
||||
process.exit(1);
|
||||
default:
|
||||
if (args[i].startsWith('-')) {
|
||||
console.error(`Unknown option: ${args[i]}`);
|
||||
process.exit(1);
|
||||
}
|
||||
reportFile = args[i];
|
||||
}
|
||||
}
|
||||
|
||||
if (!reportFile) {
|
||||
console.error(
|
||||
'Usage: gather-sandbox-context <report.json or URL> [--filter <pattern>] [--workspace <path>]'
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
return { reportFile, filter, workspaceRoot };
|
||||
}
|
||||
|
||||
// --- Types ---
|
||||
|
||||
interface FileAccessEntry {
|
||||
path: string;
|
||||
pid: number;
|
||||
}
|
||||
|
||||
interface ProcessTreeEntry {
|
||||
pid: number;
|
||||
cmd: string;
|
||||
parentPid?: number;
|
||||
}
|
||||
|
||||
interface SandboxReport {
|
||||
taskId: string;
|
||||
unexpectedReads?: FileAccessEntry[];
|
||||
unexpectedWrites?: FileAccessEntry[];
|
||||
expectedInputsNotRead?: string[];
|
||||
expectedOutputsNotWritten?: string[];
|
||||
filesRead?: FileAccessEntry[];
|
||||
filesWritten?: FileAccessEntry[];
|
||||
processTree?: ProcessTreeEntry[];
|
||||
}
|
||||
|
||||
// --- Helpers ---
|
||||
|
||||
function downloadUrl(url: string): string {
|
||||
const tmpPath = `/tmp/sandbox-report-${Date.now()}.json`;
|
||||
try {
|
||||
execFileSync('curl', ['-sL', '-o', tmpPath, url], { stdio: 'pipe' });
|
||||
} catch {
|
||||
console.error(`Error: Failed to download report from URL: ${url}`);
|
||||
process.exit(1);
|
||||
}
|
||||
return tmpPath;
|
||||
}
|
||||
|
||||
function runNxCommand(
|
||||
args: string[],
|
||||
workspaceRoot: string,
|
||||
timeoutMs = 30000
|
||||
): string | null {
|
||||
try {
|
||||
return execFileSync('npx', ['nx', ...args], {
|
||||
cwd: workspaceRoot,
|
||||
timeout: timeoutMs,
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
encoding: 'utf-8',
|
||||
});
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function safeJsonParse<T>(str: string | null, fallback: T): T {
|
||||
if (!str) return fallback;
|
||||
try {
|
||||
return JSON.parse(str);
|
||||
} catch {
|
||||
return fallback;
|
||||
}
|
||||
}
|
||||
|
||||
function filterEntries(
|
||||
entries: FileAccessEntry[],
|
||||
filterStr: string | null
|
||||
): FileAccessEntry[] {
|
||||
if (!filterStr) return entries;
|
||||
|
||||
const patterns = filterStr.split(',').map((p) => p.trim());
|
||||
return entries.filter((entry) =>
|
||||
patterns.some((pattern) => {
|
||||
if (
|
||||
pattern.includes('*') ||
|
||||
pattern.includes('?') ||
|
||||
pattern.includes('[')
|
||||
) {
|
||||
// Glob pattern — if no slashes, match against basename
|
||||
if (!pattern.includes('/')) {
|
||||
return minimatch(basename(entry.path), pattern);
|
||||
}
|
||||
return minimatch(entry.path, pattern);
|
||||
}
|
||||
// Literal: exact match or directory prefix
|
||||
return entry.path === pattern || entry.path.startsWith(pattern + '/');
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
function groupByDirPrefix(
|
||||
paths: string[],
|
||||
depth = 3
|
||||
): { prefix: string; count: number }[] {
|
||||
const groups: Record<string, number> = {};
|
||||
for (const p of paths) {
|
||||
const prefix = p.split('/').slice(0, depth).join('/');
|
||||
groups[prefix] = (groups[prefix] || 0) + 1;
|
||||
}
|
||||
return Object.entries(groups)
|
||||
.map(([prefix, count]) => ({ prefix, count }))
|
||||
.sort((a, b) => b.count - a.count);
|
||||
}
|
||||
|
||||
function groupByExtension(paths: string[]): { ext: string; count: number }[] {
|
||||
const groups: Record<string, number> = {};
|
||||
for (const p of paths) {
|
||||
const ext = extname(p) || '(no ext)';
|
||||
groups[ext] = (groups[ext] || 0) + 1;
|
||||
}
|
||||
return Object.entries(groups)
|
||||
.map(([ext, count]) => ({ ext, count }))
|
||||
.sort((a, b) => b.count - a.count);
|
||||
}
|
||||
|
||||
function classifyFiles(
|
||||
undeclared: string[],
|
||||
projectRoot: string,
|
||||
projectRoots: Record<string, string>
|
||||
) {
|
||||
const projects = Object.entries(projectRoots).map(([project, root]) => ({
|
||||
project,
|
||||
root,
|
||||
}));
|
||||
|
||||
const isBuildArtifact = (f: string) =>
|
||||
f.startsWith('dist/') ||
|
||||
f.startsWith('build/') ||
|
||||
f.startsWith('out-tsc/') ||
|
||||
f.startsWith('.next/') ||
|
||||
f.includes('/node_modules/.cache/') ||
|
||||
f.endsWith('.tsbuildinfo') ||
|
||||
f.includes('/dist/') ||
|
||||
f.includes('/build/output/');
|
||||
|
||||
const configBasenames = new Set(['nx.json', 'project.json', 'package.json']);
|
||||
const configPrefixes = [
|
||||
'tsconfig',
|
||||
'jest.config',
|
||||
'jest.preset',
|
||||
'.eslintrc',
|
||||
'eslint.config',
|
||||
'playwright.config',
|
||||
'webpack.config',
|
||||
'vite.config',
|
||||
'babel.config',
|
||||
'.babelrc',
|
||||
'rollup.config',
|
||||
];
|
||||
const isConfigFile = (f: string) => {
|
||||
const b = basename(f);
|
||||
return (
|
||||
configBasenames.has(b) ||
|
||||
configPrefixes.some((prefix) => b.startsWith(prefix))
|
||||
);
|
||||
};
|
||||
|
||||
const isEnvFile = (f: string) => {
|
||||
const b = basename(f);
|
||||
return b === '.env' || b.startsWith('.env.');
|
||||
};
|
||||
|
||||
const classified = undeclared.map((f) => {
|
||||
const inProjectRoot = projectRoot !== '' && f.startsWith(projectRoot + '/');
|
||||
const owner = projects.find((p) => f.startsWith(p.root + '/'));
|
||||
return {
|
||||
path: f,
|
||||
inProjectRoot,
|
||||
ownerProject: owner?.project ?? null,
|
||||
isBuildArtifact: isBuildArtifact(f),
|
||||
isConfigFile: isConfigFile(f),
|
||||
isEnvFile: isEnvFile(f),
|
||||
};
|
||||
});
|
||||
|
||||
return {
|
||||
crossProject: classified
|
||||
.filter((c) => !c.inProjectRoot)
|
||||
.map((c) => ({ path: c.path, owner: c.ownerProject })),
|
||||
buildArtifacts: classified
|
||||
.filter((c) => c.isBuildArtifact)
|
||||
.map((c) => c.path),
|
||||
configFiles: classified.filter((c) => c.isConfigFile).map((c) => c.path),
|
||||
envFiles: classified.filter((c) => c.isEnvFile).map((c) => c.path),
|
||||
inProjectRoot: classified.filter((c) => c.inProjectRoot).map((c) => c.path),
|
||||
outsideProjectRoot: classified
|
||||
.filter((c) => !c.inProjectRoot)
|
||||
.map((c) => c.path),
|
||||
total: undeclared.length,
|
||||
};
|
||||
}
|
||||
|
||||
function validateViolations(
|
||||
violations: string[],
|
||||
resolvedFiles: Set<string>
|
||||
): { confirmed: string[]; undeclared: string[] } {
|
||||
const confirmed: string[] = [];
|
||||
const undeclared: string[] = [];
|
||||
const seen = new Set<string>();
|
||||
for (const f of violations) {
|
||||
if (seen.has(f)) continue;
|
||||
seen.add(f);
|
||||
if (resolvedFiles.has(f)) {
|
||||
confirmed.push(f);
|
||||
} else {
|
||||
undeclared.push(f);
|
||||
}
|
||||
}
|
||||
return { confirmed, undeclared };
|
||||
}
|
||||
|
||||
function validateOutputViolations(
|
||||
violations: string[],
|
||||
resolvedOutputs: string[]
|
||||
): { confirmed: string[]; undeclared: string[] } {
|
||||
const outputSet = new Set(resolvedOutputs);
|
||||
const outputDirs = resolvedOutputs.map((o) => o + '/');
|
||||
const confirmed: string[] = [];
|
||||
const undeclared: string[] = [];
|
||||
const seen = new Set<string>();
|
||||
for (const f of violations) {
|
||||
if (seen.has(f)) continue;
|
||||
seen.add(f);
|
||||
if (outputSet.has(f) || outputDirs.some((d) => f.startsWith(d))) {
|
||||
confirmed.push(f);
|
||||
} else {
|
||||
undeclared.push(f);
|
||||
}
|
||||
}
|
||||
return { confirmed, undeclared };
|
||||
}
|
||||
|
||||
function extractCommands(
|
||||
processTree: ProcessTreeEntry[],
|
||||
readsByPid: Record<string, string[]>,
|
||||
writesByPid: Record<string, string[]>
|
||||
) {
|
||||
const pidToCmd: Record<string, string> = {};
|
||||
for (const entry of processTree) {
|
||||
pidToCmd[String(entry.pid)] = entry.cmd;
|
||||
}
|
||||
|
||||
return processTree
|
||||
.filter(
|
||||
(entry) =>
|
||||
(readsByPid[String(entry.pid)]?.length ?? 0) > 0 ||
|
||||
(writesByPid[String(entry.pid)]?.length ?? 0) > 0
|
||||
)
|
||||
.map((entry) => {
|
||||
const parts = entry.cmd.split(' ');
|
||||
const exe = parts[0].split('/').pop() ?? parts[0];
|
||||
return {
|
||||
pid: entry.pid,
|
||||
cmd: entry.cmd,
|
||||
parentPid: entry.parentPid ?? null,
|
||||
parentCmd: entry.parentPid
|
||||
? (pidToCmd[String(entry.parentPid)] ?? null)
|
||||
: null,
|
||||
unexpectedReadCount: readsByPid[String(entry.pid)]?.length ?? 0,
|
||||
unexpectedWriteCount: writesByPid[String(entry.pid)]?.length ?? 0,
|
||||
unexpectedReads: readsByPid[String(entry.pid)] ?? [],
|
||||
unexpectedWrites: writesByPid[String(entry.pid)] ?? [],
|
||||
executable: exe,
|
||||
arguments: parts.slice(1).join(' '),
|
||||
};
|
||||
})
|
||||
.sort(
|
||||
(a, b) =>
|
||||
b.unexpectedReadCount +
|
||||
b.unexpectedWriteCount -
|
||||
(a.unexpectedReadCount + a.unexpectedWriteCount)
|
||||
);
|
||||
}
|
||||
|
||||
function resolveExecutorSource(
|
||||
executor: string | undefined,
|
||||
workspaceRoot: string
|
||||
): { executor: string; sourcePath: string } {
|
||||
if (
|
||||
!executor ||
|
||||
executor === 'null' ||
|
||||
executor.includes('nx:run-commands')
|
||||
) {
|
||||
return { executor: executor ?? '', sourcePath: '' };
|
||||
}
|
||||
|
||||
const lastColon = executor.lastIndexOf(':');
|
||||
const pkg = executor.substring(0, lastColon);
|
||||
const name = executor.substring(lastColon + 1);
|
||||
|
||||
try {
|
||||
const result = execFileSync(
|
||||
'node',
|
||||
[
|
||||
'-e',
|
||||
`
|
||||
try {
|
||||
const pkg = require('${pkg}/package.json');
|
||||
const executors = pkg.executors || pkg.builders;
|
||||
if (executors) {
|
||||
const p = require.resolve('${pkg}/' + executors);
|
||||
const dir = require('path').dirname(p);
|
||||
const json = require(p);
|
||||
const impl = json.executors?.['${name}']?.implementation ||
|
||||
json.builders?.['${name}']?.implementation;
|
||||
if (impl) console.log(require.resolve(dir + '/' + impl));
|
||||
}
|
||||
} catch(e) {}
|
||||
`,
|
||||
],
|
||||
{
|
||||
cwd: workspaceRoot,
|
||||
encoding: 'utf-8',
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
timeout: 10000,
|
||||
}
|
||||
).trim();
|
||||
return { executor, sourcePath: result };
|
||||
} catch {
|
||||
return { executor, sourcePath: '' };
|
||||
}
|
||||
}
|
||||
|
||||
function extractDepTaskOutputFiles(
|
||||
targetConfig: any,
|
||||
workspaceRoot: string
|
||||
): { dependentTasksOutputFiles: any[]; namedInputs: string[] } {
|
||||
const inputs: any[] = targetConfig?.inputs ?? [];
|
||||
const depOutputs: any[] = [];
|
||||
const namedInputs: string[] = [];
|
||||
|
||||
for (const input of inputs) {
|
||||
if (
|
||||
typeof input === 'object' &&
|
||||
input !== null &&
|
||||
'dependentTasksOutputFiles' in input
|
||||
) {
|
||||
depOutputs.push({
|
||||
glob: input.dependentTasksOutputFiles,
|
||||
transitive: input.transitive ?? false,
|
||||
});
|
||||
} else if (
|
||||
typeof input === 'string' &&
|
||||
!input.startsWith('{') &&
|
||||
!input.startsWith('^') &&
|
||||
!input.includes('/') &&
|
||||
!input.includes('.')
|
||||
) {
|
||||
namedInputs.push(input);
|
||||
}
|
||||
}
|
||||
|
||||
// Resolve named inputs from nx.json
|
||||
const nxJsonPath = resolve(workspaceRoot, 'nx.json');
|
||||
if (existsSync(nxJsonPath) && namedInputs.length > 0) {
|
||||
try {
|
||||
const nxJson = JSON.parse(readFileSync(nxJsonPath, 'utf-8'));
|
||||
for (const name of namedInputs) {
|
||||
const namedDef = nxJson.namedInputs?.[name] ?? [];
|
||||
for (const entry of namedDef) {
|
||||
if (
|
||||
typeof entry === 'object' &&
|
||||
entry !== null &&
|
||||
'dependentTasksOutputFiles' in entry
|
||||
) {
|
||||
depOutputs.push({
|
||||
glob: entry.dependentTasksOutputFiles,
|
||||
transitive: entry.transitive ?? false,
|
||||
fromNamedInput: name,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// ignore nx.json parse errors
|
||||
}
|
||||
}
|
||||
|
||||
return { dependentTasksOutputFiles: depOutputs, namedInputs };
|
||||
}
|
||||
|
||||
function analyzeStaleDeclarations(
|
||||
expectedInputsNotRead: string[],
|
||||
expectedOutputsNotWritten: string[]
|
||||
) {
|
||||
const classifyPattern = (value: string) => {
|
||||
if (/[*{]/.test(value)) return 'glob';
|
||||
if (value.startsWith('^')) return 'depOutput';
|
||||
return 'file';
|
||||
};
|
||||
|
||||
const groupByType = (items: string[]) => {
|
||||
const groups: Record<string, string[]> = {};
|
||||
for (const item of items) {
|
||||
const type = classifyPattern(item);
|
||||
(groups[type] ??= []).push(item);
|
||||
}
|
||||
return Object.entries(groups).map(([type, values]) => ({
|
||||
type,
|
||||
count: values.length,
|
||||
samples: values.slice(0, 3),
|
||||
}));
|
||||
};
|
||||
|
||||
return {
|
||||
expectedInputsNotRead: expectedInputsNotRead.length,
|
||||
expectedOutputsNotWritten: expectedOutputsNotWritten.length,
|
||||
staleInputsByType: groupByType(expectedInputsNotRead),
|
||||
staleOutputsByType: groupByType(expectedOutputsNotWritten),
|
||||
};
|
||||
}
|
||||
|
||||
// --- Main ---
|
||||
|
||||
async function main() {
|
||||
const args = parseArgs();
|
||||
let reportPath = args.reportFile;
|
||||
|
||||
// Handle URL inputs
|
||||
if (reportPath.startsWith('http')) {
|
||||
reportPath = downloadUrl(reportPath);
|
||||
}
|
||||
|
||||
if (!existsSync(reportPath)) {
|
||||
console.error(`Error: Report file not found: ${reportPath}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
reportPath = resolve(reportPath);
|
||||
process.chdir(args.workspaceRoot);
|
||||
|
||||
// Phase 1: Parse report (single read)
|
||||
let report: SandboxReport;
|
||||
try {
|
||||
report = JSON.parse(readFileSync(reportPath, 'utf-8'));
|
||||
} catch {
|
||||
console.error(`Error: Report file is not valid JSON: ${reportPath}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (!report.taskId) {
|
||||
console.error('Error: Report file has no .taskId field');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const [project, target, config] = report.taskId.split(':');
|
||||
const taskRef = config
|
||||
? `${project}:${target}:${config}`
|
||||
: `${project}:${target}`;
|
||||
|
||||
const unexpectedReads = report.unexpectedReads ?? [];
|
||||
const unexpectedWrites = report.unexpectedWrites ?? [];
|
||||
|
||||
// Apply filter
|
||||
const filteredReads = filterEntries(unexpectedReads, args.filter);
|
||||
const filteredWrites = filterEntries(unexpectedWrites, args.filter);
|
||||
|
||||
const readPaths = filteredReads.map((e) => e.path);
|
||||
const writePaths = filteredWrites.map((e) => e.path);
|
||||
|
||||
// Build pid → files maps
|
||||
const readsByPid: Record<string, string[]> = {};
|
||||
const writesByPid: Record<string, string[]> = {};
|
||||
for (const entry of filteredReads) {
|
||||
(readsByPid[String(entry.pid)] ??= []).push(entry.path);
|
||||
}
|
||||
for (const entry of filteredWrites) {
|
||||
(writesByPid[String(entry.pid)] ??= []).push(entry.path);
|
||||
}
|
||||
|
||||
// Phase 2: Gather Nx task context (run task + parallel nx commands)
|
||||
runNxCommand(['run', taskRef], args.workspaceRoot, 120000);
|
||||
|
||||
const [
|
||||
targetConfigStr,
|
||||
projectConfigStr,
|
||||
resolvedInputsStr,
|
||||
resolvedOutputsStr,
|
||||
graphResult,
|
||||
] = await Promise.all([
|
||||
runNxCommand(['show', 'target', taskRef, '--json'], args.workspaceRoot),
|
||||
runNxCommand(['show', 'project', project, '--json'], args.workspaceRoot),
|
||||
runNxCommand(
|
||||
['show', 'target', 'inputs', taskRef, '--json'],
|
||||
args.workspaceRoot
|
||||
),
|
||||
runNxCommand(
|
||||
['show', 'target', 'outputs', taskRef, '--json'],
|
||||
args.workspaceRoot
|
||||
),
|
||||
(() => {
|
||||
const graphPath = `/tmp/sandbox-project-graph-${Date.now()}.json`;
|
||||
runNxCommand(['graph', '--file', graphPath], args.workspaceRoot);
|
||||
try {
|
||||
return readFileSync(graphPath, 'utf-8');
|
||||
} catch {
|
||||
return '{"graph":{"nodes":{}}}';
|
||||
}
|
||||
})(),
|
||||
]);
|
||||
|
||||
const targetConfig = safeJsonParse(targetConfigStr, {} as any);
|
||||
const projectConfig = safeJsonParse(projectConfigStr, {} as any);
|
||||
const resolvedInputs = safeJsonParse(resolvedInputsStr, {} as any);
|
||||
const resolvedOutputs = safeJsonParse(resolvedOutputsStr, {} as any);
|
||||
const projectGraph = safeJsonParse(graphResult, {
|
||||
graph: { nodes: {} },
|
||||
} as any);
|
||||
|
||||
// Phase 3: Validate violations
|
||||
const resolvedInputFiles = new Set([
|
||||
...(resolvedInputs.files ?? []),
|
||||
...(resolvedInputs.depOutputs ?? []),
|
||||
]);
|
||||
const resolvedOutputFiles = [
|
||||
...(resolvedOutputs.outputPaths ?? []),
|
||||
...(resolvedOutputs.expandedOutputs ?? []),
|
||||
];
|
||||
|
||||
const checkInputs = validateViolations(readPaths, resolvedInputFiles);
|
||||
const checkOutputs = validateOutputViolations(
|
||||
writePaths,
|
||||
resolvedOutputFiles
|
||||
);
|
||||
|
||||
// Phase 3.5: Sample --check verification
|
||||
let checkSampleInputs: any = {};
|
||||
let checkSampleOutputs: any = {};
|
||||
const sampleReadFiles = checkInputs.undeclared.slice(0, 5);
|
||||
if (sampleReadFiles.length > 0) {
|
||||
const result = runNxCommand(
|
||||
[
|
||||
'show',
|
||||
'target',
|
||||
'inputs',
|
||||
taskRef,
|
||||
'--check',
|
||||
...sampleReadFiles,
|
||||
'--json',
|
||||
],
|
||||
args.workspaceRoot
|
||||
);
|
||||
checkSampleInputs = safeJsonParse(result, {});
|
||||
}
|
||||
const sampleWriteFiles = checkOutputs.undeclared.slice(0, 5);
|
||||
if (sampleWriteFiles.length > 0) {
|
||||
const result = runNxCommand(
|
||||
[
|
||||
'show',
|
||||
'target',
|
||||
'outputs',
|
||||
taskRef,
|
||||
'--check',
|
||||
...sampleWriteFiles,
|
||||
'--json',
|
||||
],
|
||||
args.workspaceRoot
|
||||
);
|
||||
checkSampleOutputs = safeJsonParse(result, {});
|
||||
}
|
||||
|
||||
// Phase 4: File classification
|
||||
const projectRoots: Record<string, string> = {};
|
||||
for (const [name, node] of Object.entries(projectGraph.graph?.nodes ?? {})) {
|
||||
projectRoots[name] = (node as any).data?.root ?? name;
|
||||
}
|
||||
const taskProjectRoot = projectRoots[project] ?? '';
|
||||
|
||||
const readClassification = classifyFiles(
|
||||
checkInputs.undeclared,
|
||||
taskProjectRoot,
|
||||
projectRoots
|
||||
);
|
||||
const writeClassification = classifyFiles(
|
||||
checkOutputs.undeclared,
|
||||
taskProjectRoot,
|
||||
projectRoots
|
||||
);
|
||||
|
||||
// Phase 5: Command extraction
|
||||
const processTree = report.processTree ?? [];
|
||||
const commands = extractCommands(processTree, readsByPid, writesByPid);
|
||||
|
||||
// Phase 6: Inference detection
|
||||
const targetMeta = projectConfig.targets?.[target]?.metadata ?? {};
|
||||
const inference = {
|
||||
isInferred: 'plugin' in targetMeta || 'technologies' in targetMeta,
|
||||
plugin: targetMeta.plugin ?? null,
|
||||
technologies: targetMeta.technologies ?? null,
|
||||
description: targetMeta.description ?? null,
|
||||
};
|
||||
|
||||
let pluginRegistration: any = {};
|
||||
const nxJsonPath = resolve(args.workspaceRoot, 'nx.json');
|
||||
if (inference.plugin && existsSync(nxJsonPath)) {
|
||||
try {
|
||||
const nxJson = JSON.parse(readFileSync(nxJsonPath, 'utf-8'));
|
||||
const plugins = (nxJson.plugins ?? []).map((p: any) =>
|
||||
typeof p === 'string' ? { plugin: p, options: {} } : p
|
||||
);
|
||||
pluginRegistration =
|
||||
plugins.find((p: any) => p.plugin === inference.plugin) ?? {};
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
// Phase 6.5: dependentTasksOutputFiles + executor resolution
|
||||
const depTaskOutputs = extractDepTaskOutputFiles(
|
||||
targetConfig,
|
||||
args.workspaceRoot
|
||||
);
|
||||
const executorInfo = resolveExecutorSource(
|
||||
targetConfig.executor ?? targetConfig.command,
|
||||
args.workspaceRoot
|
||||
);
|
||||
|
||||
// Phase 7: Cross-project dependency check
|
||||
const dependsOn = (targetConfig.dependsOn ?? []).map((d: any) =>
|
||||
typeof d === 'string' ? d : (d.target ?? '')
|
||||
);
|
||||
const checkCrossProject = (classification: typeof readClassification) => {
|
||||
const owners = [
|
||||
...new Set(
|
||||
classification.crossProject
|
||||
.map((c) => c.owner)
|
||||
.filter((o): o is string => o !== null)
|
||||
),
|
||||
];
|
||||
return owners.map((owner) => ({
|
||||
project: owner,
|
||||
isDependency: dependsOn.some(
|
||||
(d: string) =>
|
||||
d === owner ||
|
||||
d === `${owner}:build` ||
|
||||
d === `^${owner}:build` ||
|
||||
d.includes(`^${owner}`)
|
||||
),
|
||||
files: classification.crossProject
|
||||
.filter((c) => c.owner === owner)
|
||||
.map((c) => c.path),
|
||||
}));
|
||||
};
|
||||
|
||||
const crossProjectDeps = {
|
||||
reads: checkCrossProject(readClassification),
|
||||
writes: checkCrossProject(writeClassification),
|
||||
};
|
||||
|
||||
// Phase 8: Stale declarations
|
||||
const staleDeclarations = analyzeStaleDeclarations(
|
||||
report.expectedInputsNotRead ?? [],
|
||||
report.expectedOutputsNotWritten ?? []
|
||||
);
|
||||
|
||||
// Assemble outputs
|
||||
const detailFile = `/tmp/sandbox-diagnosis-detail-${taskRef.replace(/[/:@]/g, '-')}.json`;
|
||||
|
||||
const detail = {
|
||||
processTree: {
|
||||
processTree,
|
||||
processPidToCmd: Object.fromEntries(
|
||||
processTree.map((e) => [String(e.pid), e.cmd])
|
||||
),
|
||||
readsByPid,
|
||||
writesByPid,
|
||||
},
|
||||
targetConfig,
|
||||
projectConfig,
|
||||
resolvedInputs,
|
||||
resolvedOutputs,
|
||||
validation: { reads: checkInputs, writes: checkOutputs },
|
||||
classification: { reads: readClassification, writes: writeClassification },
|
||||
report: {
|
||||
taskId: report.taskId,
|
||||
totalFilesRead: report.filesRead?.length ?? 0,
|
||||
totalFilesWritten: report.filesWritten?.length ?? 0,
|
||||
totalUnexpectedReads: unexpectedReads.length,
|
||||
totalUnexpectedWrites: unexpectedWrites.length,
|
||||
expectedInputsNotRead: report.expectedInputsNotRead ?? [],
|
||||
expectedOutputsNotWritten: report.expectedOutputsNotWritten ?? [],
|
||||
},
|
||||
commands,
|
||||
crossProjectDependencyCheck: crossProjectDeps,
|
||||
staleDeclarations,
|
||||
inference,
|
||||
pluginRegistration,
|
||||
dependentTasksOutputFiles: depTaskOutputs,
|
||||
executorInfo,
|
||||
};
|
||||
writeFileSync(detailFile, JSON.stringify(detail, null, 2));
|
||||
|
||||
// Brief to stdout
|
||||
const brief = {
|
||||
task: {
|
||||
ref: taskRef,
|
||||
project,
|
||||
target,
|
||||
configuration: config ?? null,
|
||||
projectRoot: taskProjectRoot,
|
||||
},
|
||||
summary: {
|
||||
unexpectedReads: unexpectedReads.length,
|
||||
unexpectedWrites: unexpectedWrites.length,
|
||||
filteredReads: filteredReads.length,
|
||||
filteredWrites: filteredWrites.length,
|
||||
filterApplied: args.filter !== null,
|
||||
filterPattern: args.filter,
|
||||
confirmedReads: checkInputs.confirmed.length,
|
||||
undeclaredReads: checkInputs.undeclared.length,
|
||||
confirmedWrites: checkOutputs.confirmed.length,
|
||||
undeclaredWrites: checkOutputs.undeclared.length,
|
||||
},
|
||||
undeclaredFiles: {
|
||||
reads: checkInputs.undeclared,
|
||||
writes: checkOutputs.undeclared,
|
||||
},
|
||||
grouping: {
|
||||
readsByDirectory: groupByDirPrefix(readPaths),
|
||||
writesByDirectory: groupByDirPrefix(writePaths),
|
||||
byExtension: {
|
||||
readsByExt: groupByExtension(readPaths),
|
||||
writesByExt: groupByExtension(writePaths),
|
||||
},
|
||||
},
|
||||
commands: commands.map(
|
||||
({
|
||||
pid,
|
||||
cmd,
|
||||
parentCmd,
|
||||
executable,
|
||||
arguments: args,
|
||||
unexpectedReadCount,
|
||||
unexpectedWriteCount,
|
||||
}) => ({
|
||||
pid,
|
||||
cmd,
|
||||
parentCmd,
|
||||
executable,
|
||||
arguments: args,
|
||||
unexpectedReadCount,
|
||||
unexpectedWriteCount,
|
||||
})
|
||||
),
|
||||
checkSample: {
|
||||
inputs: checkSampleInputs,
|
||||
outputs: checkSampleOutputs,
|
||||
},
|
||||
classificationSummary: {
|
||||
reads: {
|
||||
crossProject: readClassification.crossProject.length,
|
||||
buildArtifacts: readClassification.buildArtifacts.length,
|
||||
configFiles: readClassification.configFiles.length,
|
||||
envFiles: readClassification.envFiles.length,
|
||||
inProjectRoot: readClassification.inProjectRoot.length,
|
||||
outsideProjectRoot: readClassification.outsideProjectRoot.length,
|
||||
},
|
||||
writes: {
|
||||
crossProject: writeClassification.crossProject.length,
|
||||
buildArtifacts: writeClassification.buildArtifacts.length,
|
||||
configFiles: writeClassification.configFiles.length,
|
||||
envFiles: writeClassification.envFiles.length,
|
||||
inProjectRoot: writeClassification.inProjectRoot.length,
|
||||
outsideProjectRoot: writeClassification.outsideProjectRoot.length,
|
||||
},
|
||||
},
|
||||
crossProjectDependencyCheck: crossProjectDeps,
|
||||
staleDeclarations,
|
||||
dependentTasksOutputFiles: depTaskOutputs.dependentTasksOutputFiles,
|
||||
executorInfo,
|
||||
inference,
|
||||
pluginRegistration,
|
||||
verificationCommands: {
|
||||
checkInputs: `npx nx show target inputs ${taskRef} --check <files...>`,
|
||||
checkOutputs: `npx nx show target outputs ${taskRef} --check <files...>`,
|
||||
runTask: `npx nx run ${taskRef} --skip-nx-cache`,
|
||||
},
|
||||
detailFile,
|
||||
};
|
||||
|
||||
console.log(JSON.stringify(brief, null, 2));
|
||||
}
|
||||
|
||||
main().catch((err) => {
|
||||
console.error(`Script failed: ${err.message}`);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,47 @@
|
||||
{
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Bash(find:*)",
|
||||
"Bash(ls:*)",
|
||||
"Bash(mkdir:*)",
|
||||
"WebFetch(domain:github.com)",
|
||||
"WebFetch(domain:www.typescriptlang.org)",
|
||||
"Bash(git log:*)",
|
||||
"Bash(gh issue list:*)",
|
||||
"Bash(gh issue view:*)",
|
||||
"Bash(npx prettier:*)",
|
||||
"Bash(nx prepush:*)",
|
||||
"Bash(pnpm commit:*)",
|
||||
"Bash(rg:*)",
|
||||
"mcp__nx__nx_docs",
|
||||
"mcp__nx__nx_workspace",
|
||||
"mcp__nx__nx_project_details",
|
||||
"Bash(nx show projects:*)",
|
||||
"Bash(nx run-many:*)",
|
||||
"Bash(nx run:*)",
|
||||
"Bash(nx affected:*)",
|
||||
"Bash(nx lint:*)",
|
||||
"Bash(nx test:*)",
|
||||
"Bash(nx build:*)",
|
||||
"Bash(nx documentation:*)"
|
||||
],
|
||||
"deny": []
|
||||
},
|
||||
"enableAllProjectMcpServers": true,
|
||||
"env": {
|
||||
"BASH_MAX_TIMEOUT_MS": "1800000"
|
||||
},
|
||||
"extraKnownMarketplaces": {
|
||||
"nx-claude-plugins": {
|
||||
"source": {
|
||||
"source": "github",
|
||||
"repo": "nrwl/nx-ai-agents-config",
|
||||
"ref": "experimental"
|
||||
}
|
||||
}
|
||||
},
|
||||
"enabledPlugins": {
|
||||
"nx@nx-claude-plugins": true,
|
||||
"pr-review-toolkit@claude-plugins-official": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,590 @@
|
||||
---
|
||||
name: dist-build-migration
|
||||
description: Migrate an Nx package to build to a local dist/ directory with nodenext module resolution, exports map, and @nx/nx-source condition.
|
||||
allowed-tools: Bash, Read, Glob, Grep, Agent, Edit, Write
|
||||
---
|
||||
|
||||
# Migrate Package to Local Dist Build
|
||||
|
||||
You are migrating an Nx monorepo package from building to `../../dist/packages/<name>` to building locally to `packages/<name>/dist/`. This matches the pattern already used by `nx` and `devkit`.
|
||||
|
||||
## Argument
|
||||
|
||||
The user provides a package name (e.g., `js`, `webpack`, `angular`). The package lives at `packages/<name>/`.
|
||||
|
||||
## Steps
|
||||
|
||||
### 0. Preflight: check `workspace:*` deps for unmigrated packages
|
||||
|
||||
Read `packages/<name>/package.json` and list every `workspace:*` dep (in `dependencies`, `devDependencies`, `peerDependencies`).
|
||||
|
||||
For each such dep, look at the target package's `project.json`. If it does **not** override `release.version.manifestRootsToUpdate` to `["packages/{projectName}"]`, that target package is still on the old layout. You **must** migrate those packages too (apply this skill to each), in the same PR.
|
||||
|
||||
**Why:** With `preserveLocalDependencyProtocols: true` (the new pattern), `nx release version` does not substitute `workspace:*` in your manifest. At publish time, pnpm resolves `workspace:*` by reading the target's _source_ `packages/<dep>/package.json`. The default `manifestRootsToUpdate: ["dist/packages/{projectName}"]` only bumps the dist copy, so pnpm picks up the unbumped source `0.0.1` and publishes your package with a dep on a version that does not exist in the registry. Local registry installs then fail with `ERR_PNPM_NO_MATCHING_VERSION`.
|
||||
|
||||
A `workspace:*` dep on a still-on-old-layout package is a hard blocker — migrate it before continuing.
|
||||
|
||||
### 1. Read current state
|
||||
|
||||
Read these files for the target package:
|
||||
|
||||
- `packages/<name>/package.json`
|
||||
- `packages/<name>/project.json`
|
||||
- `packages/<name>/tsconfig.lib.json`
|
||||
- `packages/<name>/tsconfig.spec.json` (if exists)
|
||||
- `packages/<name>/.eslintrc.json` (if exists)
|
||||
- `packages/<name>/assets.json` (if exists)
|
||||
- `packages/<name>/.npmignore` (if exists)
|
||||
- `packages/<name>/.gitignore` (if exists)
|
||||
|
||||
Also read the reference implementations:
|
||||
|
||||
- `packages/devkit/tsconfig.lib.json`
|
||||
- `packages/devkit/package.json`
|
||||
- `packages/devkit/project.json`
|
||||
- `packages/devkit/.npmignore`
|
||||
|
||||
Run `pnpm nx show target <name>:build-base` to see the inferred build target.
|
||||
Run `pnpm nx show target <name>:build` to see the full build target.
|
||||
|
||||
### 2. Identify entry points
|
||||
|
||||
Look at the package's root `.ts` files and any existing `exports` field. Common entry points:
|
||||
|
||||
- `index.ts` (main)
|
||||
- `testing.ts`
|
||||
- `internal.ts`
|
||||
- `ngcli-adapter.ts`
|
||||
- Any other `.ts` files at the package root that re-export from `src/`
|
||||
|
||||
Also check for `migrations.json` and `generators.json`/`executors.json` — these need exports entries too.
|
||||
|
||||
### 3. Update `tsconfig.lib.json`
|
||||
|
||||
Transform from the old pattern to the new pattern:
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"outDir": "../../dist/packages/<name>",
|
||||
"tsBuildInfoFile": "../../dist/packages/<name>/tsconfig.tsbuildinfo"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"outDir": "dist",
|
||||
"rootDir": ".",
|
||||
"declarationDir": "dist",
|
||||
"declarationMap": false,
|
||||
"tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
|
||||
"types": ["node"],
|
||||
"composite": true,
|
||||
"module": "nodenext",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true
|
||||
},
|
||||
"exclude": ["node_modules", "dist", ...existing excludes, ".eslintrc.json"],
|
||||
"include": ["*.ts", "src/**/*.ts"]
|
||||
}
|
||||
```
|
||||
|
||||
**Important**: Adjust `include` based on the package's actual structure. If the package has directories like `bin/`, `plugins/`, etc. at the root level (like `nx` does), include those too.
|
||||
|
||||
### 4. Update `tsconfig.spec.json` (if exists)
|
||||
|
||||
Change `outDir` from `../../dist/packages/<name>/spec` to `dist/spec`.
|
||||
|
||||
### 5. Update `package.json`
|
||||
|
||||
Key changes:
|
||||
|
||||
- Add `"type": "commonjs"` near the top (after `private`)
|
||||
- Change `"main"` to `"./dist/index.js"`
|
||||
- Change `"types"` to `"./dist/index.d.ts"`
|
||||
- Add `"typesVersions"` for backwards compatibility with `moduleResolution: "node"` consumers
|
||||
- Add `"exports"` map with entries for each entry point
|
||||
|
||||
Each export entry follows this pattern:
|
||||
|
||||
```json
|
||||
"./entry-name": {
|
||||
"@nx/nx-source": "./entry-name.ts",
|
||||
"types": "./entry-name.d.ts",
|
||||
"default": "./dist/entry-name.js"
|
||||
}
|
||||
```
|
||||
|
||||
The main entry (`.`) uses `./index.ts`, `./index.d.ts`, `./dist/index.js`.
|
||||
|
||||
Always include:
|
||||
|
||||
```json
|
||||
"./package.json": "./package.json"
|
||||
```
|
||||
|
||||
Include `"./migrations.json": "./migrations.json"` if the package has migrations.
|
||||
|
||||
**Note**: The `@nx/nx-source` condition is a custom condition used for source-level resolution within the workspace (so other packages import from source, not dist).
|
||||
|
||||
Add a `typesVersions` field for consumers using `moduleResolution: "node"` (which doesn't read `exports`):
|
||||
|
||||
```json
|
||||
"typesVersions": {
|
||||
"*": {
|
||||
"testing": ["dist/testing.d.ts"],
|
||||
"ngcli-adapter": ["dist/ngcli-adapter.d.ts"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Add an entry for each subpath export (excluding `.`, `./package.json`, and `./migrations.json`).
|
||||
|
||||
### 6. Update `project.json`
|
||||
|
||||
Add these sections:
|
||||
|
||||
```json
|
||||
{
|
||||
"release": {
|
||||
"version": {
|
||||
"generator": "@nx/js:release-version",
|
||||
"preserveLocalDependencyProtocols": true,
|
||||
"manifestRootsToUpdate": ["packages/{projectName}"]
|
||||
}
|
||||
},
|
||||
"targets": {
|
||||
"nx-release-publish": {
|
||||
"options": {
|
||||
"packageRoot": "packages/{projectName}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Do **not** override `build-base.outputs` in `project.json`. The `@nx/js/typescript` plugin reads `outDir` and `tsBuildInfoFile` from `tsconfig.lib.json` and infers the correct outputs (including the tsbuildinfo and the full set of file extensions). A hand-written override is almost always less complete than the inferred set.
|
||||
|
||||
If the package already has a hand-written `build-base.outputs` array, **delete it** — don't try to patch it. An incomplete override that omits `dist/tsconfig.tsbuildinfo` causes a sandbox violation in _every consumer_ that has a TypeScript project reference to this package: their `tsc --build` reads the referenced project's `.tsbuildinfo`, but `dependentTasksOutputFiles` can only collect it if this package declares it as an output.
|
||||
|
||||
Verify the inferred outputs include the tsbuildinfo:
|
||||
|
||||
```bash
|
||||
pnpm nx show project <name> --json | jq '.targets["build-base"].outputs'
|
||||
# Must include "{projectRoot}/dist/tsconfig.tsbuildinfo"
|
||||
```
|
||||
|
||||
Update the existing `build` target's `outputs` if they reference `{workspaceRoot}/dist/packages/<name>` — they should now reference `{projectRoot}/dist/`.
|
||||
|
||||
Also update `dependsOn` in the `build` target: replace `"^build"` with `"^build"` if it isn't already, and make sure `"build-base"` is listed.
|
||||
|
||||
### 7. Update eslint config
|
||||
|
||||
Add `dist` to the ignores. For flat config (`eslint.config.mjs`):
|
||||
|
||||
```js
|
||||
{ ignores: ['**/__fixtures__/**', 'dist'] },
|
||||
```
|
||||
|
||||
For legacy `.eslintrc.json`:
|
||||
|
||||
```json
|
||||
"ignorePatterns": ["!**/*", "node_modules", "dist"]
|
||||
```
|
||||
|
||||
Do **not** add `*.d.ts` or `**/*.d.ts` — the base config already ignores `**/dist`, and `tsconfig.lib.json` (Step 4) sends all generated `.d.ts` files into `dist`, so they're already out of scope. Hand-authored `.d.ts` files in `src/` (e.g. `schema.d.ts`) generally don't need ignoring.
|
||||
|
||||
### 8. Update `assets.json` (if exists)
|
||||
|
||||
Change `outDir` from `"dist/packages/<name>"` to `"packages/<name>/dist"`.
|
||||
|
||||
### 9. Add `files` field to `package.json`
|
||||
|
||||
Instead of using `.npmignore`, add a `"files"` field to `package.json` (matching the `nx` package pattern). Remove `.npmignore` if it exists.
|
||||
|
||||
```json
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/tsconfig.tsbuildinfo",
|
||||
"migrations.json"
|
||||
]
|
||||
```
|
||||
|
||||
Adjust based on the package's needs:
|
||||
|
||||
- Add `"executors.json"` and/or `"generators.json"` if the package has them
|
||||
- Add any other non-TS files that need to be published
|
||||
- npm always includes `package.json` and `README.md` automatically — no need to list them
|
||||
|
||||
### 10. Rename README.md and update build command
|
||||
|
||||
If the package has a `README.md` at its root and uses the `copy-readme.js` script in its build target:
|
||||
|
||||
1. Rename `README.md` to `readme-template.md` (`git mv`)
|
||||
2. Update the build command to pass explicit paths:
|
||||
```
|
||||
node ./scripts/copy-readme.js <name> packages/<name>/readme-template.md packages/<name>/README.md
|
||||
```
|
||||
3. Update the build target `outputs` to `["{projectRoot}/README.md"]`
|
||||
|
||||
The script's default behavior reads `packages/<name>/README.md` and writes to `dist/packages/<name>/README.md` — both wrong for the new layout. Passing explicit args fixes both.
|
||||
|
||||
### 11. Update root `.gitignore`
|
||||
|
||||
Under the section that lists generated README files (look for `packages/nx/README.md`), add:
|
||||
|
||||
```
|
||||
packages/<name>/README.md
|
||||
```
|
||||
|
||||
The generated README is written next to source (not into `dist/`), so it needs its own ignore.
|
||||
|
||||
Do **not** add a `packages/<name>/**/*.d.ts` rule. The root `.gitignore` already has a top-level `dist` entry that ignores every `dist/` directory in the repo — and `tsconfig.lib.json` (Step 4) sets `declarationDir: "dist"`, so all generated `.d.ts` files land there. Adding a package-wide `**/*.d.ts` rule plus `!` re-includes for hand-authored `.d.ts` files (like committed `schema.d.ts` source files) is redundant defense-in-depth.
|
||||
|
||||
### 12. Update docs generation paths
|
||||
|
||||
Check `astro-docs/src/plugins/utils/` for any code that references `.d.ts` files from the package. The docs generation reads `.d.ts` entry points to build API reference pages. Paths that previously pointed to `dist/packages/<name>/foo.d.ts` (workspace root dist) or `packages/<name>/foo.d.ts` (package root) now need to point to `packages/<name>/dist/foo.d.ts`.
|
||||
|
||||
For example, `devkit-generation.ts` had to be updated to look for `packages/devkit/dist/index.d.ts` instead of `packages/devkit/index.d.ts`.
|
||||
|
||||
### 13. Update `scripts/nx-release.ts`
|
||||
|
||||
Two things to do here:
|
||||
|
||||
1. **Add the package to `packagesToReset`.** That array (around `scripts/nx-release.ts:76`) is the snapshot/restore list — every package whose source `package.json` gets mutated by `nx release` (because it now publishes from `packages/<name>/` directly, not `dist/packages/<name>/`) must be in this list. Otherwise the release will leave `packages/<name>/package.json` dirty in the working tree after running. **Easy to forget — and there is no test that catches it.**
|
||||
|
||||
2. **Update any package-specific paths.** If the package has special release handling (like devkit's `hackFixForDevkitPeerDependencies`), update any paths from `./dist/packages/<name>/` to `./packages/<name>/`.
|
||||
|
||||
### 14. Update imports across the workspace
|
||||
|
||||
Search for imports from `@nx/<name>/src/` across all other packages. These internal imports need to be updated:
|
||||
|
||||
- If the imported thing is re-exported through a public entry point (index.ts, internal.ts, etc.), update the import to use that entry point
|
||||
- If not, consider adding it to `internal.ts` or the appropriate entry point
|
||||
|
||||
Use: `grep -r "from '@nx/<name>/src/" packages/ --include="*.ts" -l` to find affected files.
|
||||
|
||||
Also check for imports in:
|
||||
|
||||
- `e2e/` tests
|
||||
- `scripts/`
|
||||
- `tools/workspace-plugin/`
|
||||
- `astro-docs/`
|
||||
- `examples/`
|
||||
|
||||
### 14b. (Optional) Lock down `./src/*` and route internal consumers through `./internal`
|
||||
|
||||
When you ship the migration, the package's `exports` map exposes everything under `./src/*` if you keep the wildcard. That's a 100s-of-symbols-wide semi-private surface that pins the implementation layout forever — consumers (first-party and external) can reach into any source file. The cleaner long-term shape, matching `@nx/devkit`/`@nx/workspace`, is to drop the wildcard and route internal consumers through a single curated `./internal` entry. Skip this step if you'd rather defer (e.g. the package has very heavy internal usage and you'd prefer a smaller PR), but plan a follow-up.
|
||||
|
||||
#### When to lock down vs defer
|
||||
|
||||
- **Lock down in the same PR** if internal subpath imports number in the low hundreds AND the package isn't `workspace:*`-pinned by other not-yet-migrated packages whose dist code would crash at runtime against the older published version (see "Published-version mismatch" below).
|
||||
- **Defer to a follow-up PR** if the inventory is huge OR if dist-output code in other workspace packages depends on the OLD `./src/*` paths and those packages can't be migrated to local-dist yet. Lock down only once the immediate runtime-resolution surface is contained.
|
||||
|
||||
#### Step-by-step
|
||||
|
||||
**1. Inventory the subpath imports.** Scan for `from '@nx/<name>/src/...'`, plus runtime `require()`, dynamic `import()`, and `jest`/`vi.mock`-family calls:
|
||||
|
||||
```bash
|
||||
grep -rEln "from ['\"]@nx/<name>/src/" --include="*.ts" --include="*.tsx" --include="*.js" --include="*.mjs" packages/ e2e/ scripts/
|
||||
grep -rEln "(require|jest\.mock|jest\.requireActual)\(['\"]@nx/<name>/src/" packages/ e2e/ scripts/
|
||||
```
|
||||
|
||||
Compile a `subpath → set-of-imported-symbols` map. About 30 distinct subpaths and 60 symbols is typical for a package the size of `@nx/js`.
|
||||
|
||||
**2. Identify runtime-string-resolved subpaths.** Some subpaths are referenced by _string default values_ the nx runtime resolves later (not static imports). The classic example: `packages/nx/src/command-line/release/config/config.ts` has `DEFAULT_VERSION_ACTIONS_PATH = '@nx/js/src/release/version-actions'`. These strings are also baked into pre-existing user `nx.json` files and you cannot rewrite them via a migration. **Keep those exact subpaths as explicit non-wildcard entries in the exports map** (not under `./internal`), and have the migration skip rewriting them.
|
||||
|
||||
```bash
|
||||
# Search for string-default usages of the subpath in nx core
|
||||
grep -rEn "['\"]@nx/<name>/src/[^'\"]+['\"]" packages/nx/src/ --include="*.ts"
|
||||
```
|
||||
|
||||
**3. Build `packages/<name>/internal.ts` at the package ROOT** (not inside `src/`, to mirror `@nx/devkit/internal`). Re-export every symbol callers reach for via `@nx/<name>/src/*`, BUT only symbols not already exported from `packages/<name>/src/index.ts`. Anything already public stays public — the migration sends those callers to `@nx/<name>`, not `@nx/<name>/internal`.
|
||||
|
||||
To compute the public set:
|
||||
|
||||
```bash
|
||||
grep -E "^export " packages/<name>/src/index.ts
|
||||
```
|
||||
|
||||
…and recursively expand any `export *` lines. The "public-export reachability" calculation is fiddly enough that a small Python script with a recursive expand is worth it (see PR #35538 commit history for an example).
|
||||
|
||||
Curate the new file:
|
||||
|
||||
```ts
|
||||
// Semi-private surface for first-party Nx packages.
|
||||
//
|
||||
// External plugins should NOT import from here — this entry is curated for
|
||||
// internal consumers and may change without semver protection. Mirrors
|
||||
// `@nx/devkit/internal`.
|
||||
|
||||
// Re-exports of nx-source internals (need `no-restricted-imports` overrides).
|
||||
// eslint-disable-next-line @typescript-eslint/no-restricted-imports
|
||||
export { ... } from 'nx/src/plugins/.../something';
|
||||
|
||||
export { walkTsconfigExtendsChain, type RawTsconfigJsonCache } from './src/utils/typescript/raw-tsconfig';
|
||||
// ... and so on, grouping by area.
|
||||
```
|
||||
|
||||
Delete any pre-existing `packages/<name>/src/internal.ts` once its exports have been folded in.
|
||||
|
||||
**4. Update `packages/<name>/package.json`.** Drop wildcards, add `./internal`, keep runtime-string subpaths as explicit entries:
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"exports": {
|
||||
".": {
|
||||
"@nx/nx-source": "./src/index.ts",
|
||||
"types": "./dist/src/index.d.ts",
|
||||
"default": "./dist/src/index.js",
|
||||
},
|
||||
"./package.json": "./package.json",
|
||||
"./migrations.json": "./migrations.json",
|
||||
"./generators.json": "./generators.json",
|
||||
"./executors.json": "./executors.json",
|
||||
// Public side-channels (whatever you already had).
|
||||
"./babel": {
|
||||
"@nx/nx-source": "./babel.ts",
|
||||
"types": "./dist/babel.d.ts",
|
||||
"default": "./dist/babel.js",
|
||||
},
|
||||
// The new curated entry.
|
||||
"./internal": {
|
||||
"@nx/nx-source": "./internal.ts",
|
||||
"types": "./dist/internal.d.ts",
|
||||
"default": "./dist/internal.js",
|
||||
},
|
||||
// Runtime-string-resolved subpath kept for back-compat.
|
||||
"./src/release/version-actions": {
|
||||
"@nx/nx-source": "./src/release/version-actions.ts",
|
||||
"types": "./dist/src/release/version-actions.d.ts",
|
||||
"default": "./dist/src/release/version-actions.js",
|
||||
},
|
||||
// DROPPED: "./src/*", "./src/*.js", "./src/*/schema", "./src/*/schema.json"
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Also strip `src/*` glob entries from `typesVersions`. Replace with explicit non-wildcard entries that mirror the kept exports.
|
||||
|
||||
**5. Codemod consumers in two passes.** Mechanical sed-style first, then a smarter split:
|
||||
|
||||
```bash
|
||||
# Pass 1: every `from '@nx/<name>/src/...'` → `from '@nx/<name>/internal'`,
|
||||
# except the preserved subpaths from step 2.
|
||||
# (Use a Python/TS script — sed is fine for the simple cases too.)
|
||||
```
|
||||
|
||||
```bash
|
||||
# Pass 2: split mixed imports. Any line like
|
||||
# import { libraryGenerator, ensureTypescript } from '@nx/<name>/internal';
|
||||
# where `libraryGenerator` is publicly exported from `src/index.ts` becomes:
|
||||
# import { libraryGenerator } from '@nx/<name>';
|
||||
# import { ensureTypescript } from '@nx/<name>/internal';
|
||||
```
|
||||
|
||||
Also handle these non-static cases:
|
||||
|
||||
- `jest.mock('@nx/<name>/src/...', ...)` and `jest.requireActual(...)` — same rewrite. The whole mock surface is now `@nx/<name>/internal`, so `...jest.requireActual('@nx/<name>/internal')` spreads more than the original site mocked, but that's fine in practice.
|
||||
- Runtime `require('@nx/<name>/src/...')` — same rewrite.
|
||||
- Template-string fixtures inside `.spec.ts` files — careful! Don't let your codemod rewrite literal `from "@nx/<name>/internal"` substrings that _test_ the migration (it'll flip quote style and break the test). Either skip `*.spec.ts` files containing fixtures, or operate at AST level.
|
||||
|
||||
**6. Collapse duplicate imports.** After the two-pass codemod, many files end up with two `import { ... } from '@nx/<name>/internal'` lines (or two `from '@nx/<name>'`). Run a third pass to merge same-source-same-`type`-prefix imports:
|
||||
|
||||
```python
|
||||
# Match lines (anchored): `^import [type ]{ ... } from '@nx/<name>[/internal]';$`
|
||||
# Group by (is_type_only, source). For each group with >1 entry: keep the first
|
||||
# occurrence's position, merge the named bindings (dedupe), delete the others.
|
||||
# Don't merge across type/non-type — the semantics differ.
|
||||
```
|
||||
|
||||
**7. Public-symbol audit.** After splitting, `internal.ts` must not re-export anything already exported from `src/index.ts`. If it does, namespace consumers (`import * as shared from '@nx/<name>/internal'`) will see only the curated set and `shared.publiclyExportedSymbol` becomes `undefined`. Cross-check:
|
||||
|
||||
```bash
|
||||
# Symbols in internal.ts that are ALSO in the recursive index.ts export set
|
||||
# are a bug. Remove them from internal.ts. The codemod from step 5 should
|
||||
# have already routed their callers to `@nx/<name>`, but verify nothing is
|
||||
# left pointing at `@nx/<name>/internal` for these.
|
||||
```
|
||||
|
||||
The three load-bearing patterns to verify:
|
||||
|
||||
- `import * as shared from '@nx/<name>/internal'` followed by `shared.publicSymbol` — fix by changing source to `@nx/<name>`.
|
||||
- Runtime `const shared = require('@nx/<name>/internal')` followed by `shared.publicSymbol` — same fix.
|
||||
- Named imports of public symbols from `@nx/<name>/internal` — already split by step 5; verify nothing slipped through.
|
||||
|
||||
**8. Ship a migration.** Add `packages/<name>/src/migrations/update-<version>/rewrite-<name>-internal-subpath-imports.ts` based on the workspace `move-typescript-compilation-import` template. It needs to handle:
|
||||
|
||||
- Static `import [type] { ... } from '@nx/<name>/src/<anything>'`
|
||||
- `export [type] { ... } from '@nx/<name>/src/<anything>'`
|
||||
- Dynamic `import('@nx/<name>/src/<anything>')`
|
||||
- `require('@nx/<name>/src/<anything>')`
|
||||
- `jest.mock|unmock|doMock|dontMock|requireActual|requireMock|importActual|importMock(...)` and the `vi.` equivalents
|
||||
|
||||
**Route by symbol, not blindly to `./internal`.** Some symbols reachable via `@nx/<name>/src/*` are _public_ — they're exported from `packages/<name>/src/index.ts` and ship on the main `@nx/<name>` entry. A migration that rewrites every `@nx/<name>/src/*` import to `@nx/<name>/internal` silently breaks any consumer importing a public symbol that way, because `internal.ts` deliberately does **not** re-export public symbols (step 7). Instead:
|
||||
|
||||
- Hard-code the public symbol set (the recursively-expanded `export`s of `src/index.ts`) in the migration.
|
||||
- For a **named** `import`/`export` declaration, partition the named bindings: public symbols go to `@nx/<name>`, the rest to `@nx/<name>/internal`. Classify an `orig as alias` binding by `orig`. If both groups are non-empty, replace the single declaration with two — one per target — preserving any `import type` / `export type` modifier.
|
||||
- A **namespace** import (`import * as ns`), a **default** import, `export *`, every **call expression** (`require`, dynamic `import`, `jest.mock` family), and `typeof import('...')` **type queries** (`ImportTypeNode`) reference the module as a whole and can't be symbol-split — route them to `@nx/<name>/internal`.
|
||||
|
||||
Skip the preserved subpaths from step 2 (e.g. `@nx/<name>/src/release/version-actions`). Use `ts.createSourceFile` for AST-based detection so you don't rewrite literals inside comments or template strings.
|
||||
|
||||
**Don't forget `typeof import('...')`.** It parses as an `ImportTypeNode`, not a `CallExpression`, so it's a separate AST branch from the `require`/dynamic-`import` handling. Real-world consumers use the idiom `const m = require('@nx/<name>/src/x') as typeof import('@nx/<name>/src/x')` to get a typed runtime `require` — if the codemod only rewrites the runtime arg, the type arg stays pointing at the now-removed `./src/*` wildcard and the consumer fails to type-check. Handle it explicitly: walk `ImportTypeNode`s and rewrite `node.argument.literal` when the string starts with `@nx/<name>/src/`.
|
||||
|
||||
Register in `packages/<name>/migrations.json` with `version: <current beta>`. The description should state the routing rule: named public-symbol imports/exports go to `@nx/<name>`, everything else to `@nx/<name>/internal`.
|
||||
|
||||
Add a spec covering: public-symbol import (→ `@nx/<name>`), internal-symbol import (→ `@nx/<name>/internal`), mixed import split into two, aliased bindings classified by original name, type-only split, `export { ... } from` (public / internal / mixed), `export *`, namespace import, **default import**, single-quoted, double-quoted, deep subpath, `.js` extension, `require()`, dynamic `import()`, **`typeof import()` type queries (→ `/internal`)**, **a `<typeof import()>require()` cast in tandem** (catches the regression where the runtime arg gets rewritten but the type arg doesn't), the **full** jest mock family (`it.each` over `MOCK_HELPER_METHODS`), the **full** vi mock family, **`jest.mock('...', factory)` with a factory argument**, a non-mock `jest.*` call left alone, an import + `jest.mock` in the same file, preserved subpaths, non-`@nx/<name>` imports, unrelated string literals inside comments. Make sure every entry in `PUBLIC_SYMBOLS` and every entry in `MOCK_HELPER_METHODS` is exercised at least once — drift from hardcoded sets is the most likely silent regression.
|
||||
|
||||
**9. Watch for the published-version-mismatch gotcha in example/test builds.**
|
||||
|
||||
The workspace's root `node_modules/@nx/<name>` is the _published_ version (root `package.json` pins it to a real release tag, not `workspace:*`). When code at `dist/packages/<X>/...` does `require('@nx/<name>/internal')` at runtime, Node walks up from `dist/` and finds workspace-root `node_modules/@nx/<name>` — the published copy. If that version was released BEFORE this PR, it has no `internal.js` and resolution fails.
|
||||
|
||||
Symptom:
|
||||
|
||||
```
|
||||
Error: Cannot find module '@nx/<name>/internal'
|
||||
requireStack: [
|
||||
'/path/to/workspace/dist/packages/<X>/src/utils/foo.js',
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
This bites specifically for examples or e2e flows that load `dist/packages/<other-package>/...` artifacts (e.g. an angular-rspack module-federation example that monkey-patches `Module._resolveFilename` to redirect `@nx/<other-package>` to dist). If the other-package's dist code does `require('@nx/<name>/internal')`, you'll hit this.
|
||||
|
||||
Two fixes:
|
||||
|
||||
- **(Preferred, if applicable.)** Migrate the _other_ package to local-dist too. Then its built code lives at `packages/<other>/dist/...`, walks up to `packages/<other>/node_modules/@nx/<name>` (a workspace symlink to source), and resolution finds the new `internal.js` because workspace source has it.
|
||||
- **(Band-aid for the in-between window.)** If migrating the other package is out of scope, extend the example's existing request-path patch to also redirect `@nx/<name>/internal` to the workspace source `packages/<name>/dist/internal`. Document it as a temporary measure tied to the same TODO that exists for the other-package redirect.
|
||||
|
||||
Search aggressively for this pattern after step 8:
|
||||
|
||||
```bash
|
||||
grep -rln "patchModuleFederationRequestPath\|Module._resolveFilename" examples/ e2e/ packages/
|
||||
```
|
||||
|
||||
Any file that monkeypatches resolution is a candidate for needing the redirect.
|
||||
|
||||
#### Validation
|
||||
|
||||
After steps 1–9:
|
||||
|
||||
```bash
|
||||
# Build the package (emits dist/internal.{js,d.ts})
|
||||
pnpm nx run <name>:build-base
|
||||
|
||||
# Lint the package — @nx/dependency-checks may complain that the package
|
||||
# "uses itself" because of the dynamic self-reference in versions.ts. Add
|
||||
# `@nx/<name>` to `ignoredDependencies` in the dependency-checks rule config
|
||||
# (with a comment explaining: self-reference for require(join('@nx/<name>', 'package.json'))).
|
||||
pnpm nx run <name>:lint
|
||||
|
||||
# Spec the migration
|
||||
pnpm nx test <name> -- --testPathPatterns=rewrite-<name>-internal-subpath-imports
|
||||
|
||||
# Full affected — catches consumers, example monkey-patches, and any
|
||||
# missed split-mixed-imports.
|
||||
pnpm nx affected -t build,lint --base=<base-sha-before-migration>
|
||||
```
|
||||
|
||||
If `nx affected` fails on a single example test with `Cannot find module '@nx/<name>/internal'`, that's step 9 — extend the example's request-path patch.
|
||||
|
||||
If `nx affected` fails on a package with `TS2339: Property 'foo' does not exist on type 'typeof import(".../internal")'`, that's step 7 — a `shared.publicSymbol` call survived. Find it (`grep -rn 'shared\.<symbol>' packages/`) and rewrite the namespace source to `@nx/<name>`.
|
||||
|
||||
### 15. Audit `require('../../package.json')` (or similar relative paths to the package.json)
|
||||
|
||||
Search for `require\(['"]\.\..*package\.json` inside `packages/<name>/src/`. Any TS source file that reads the package's own `package.json` via a relative path is a **layout-fragility bug** that this migration triggers:
|
||||
|
||||
- Before migration: source `packages/<name>/src/utils/versions.ts` → built `dist/packages/<name>/src/utils/versions.js`. `'../../package.json'` resolves to `dist/packages/<name>/package.json` (which the old build path copied there).
|
||||
- After migration: source unchanged → built `packages/<name>/dist/src/utils/versions.js`. `'../../package.json'` now resolves to `packages/<name>/dist/package.json` — **doesn't exist**. Every consumer that pulls in `nxVersion`/`NX_VERSION`/etc. crashes at module-load time with `Cannot find module '../../package.json'`. This breaks e2e tests broadly because most generators load `versions.ts`.
|
||||
|
||||
**Fix**: replace the relative path with a **package-name self-reference**, using the dynamic `join()` form so eslint's `@nx/enforce-module-boundaries` doesn't trip on it:
|
||||
|
||||
```ts
|
||||
// Before
|
||||
export const nxVersion = require('../../package.json').version;
|
||||
|
||||
// After
|
||||
import { join } from 'path';
|
||||
export const nxVersion = require(join('@nx/<name>', 'package.json')).version;
|
||||
```
|
||||
|
||||
A literal `require('@nx/<name>/package.json')` works at runtime but trips `enforce-module-boundaries`'s `noSelfCircularDependencies` check — the rule statically pattern-matches self-imports and fires before checking whether the import resolves to a non-main entry. The dynamic `join()` form is opaque to the static check, matches `@nx/devkit`'s established pattern, and resolves to the same path at runtime.
|
||||
|
||||
Node resolves `@nx/<name>/package.json` via `node_modules` (workspace symlink in dev, real install in published), and the package.json's `exports` map already declares `./package.json` (you ensured this in Step 5). Works identically in source and dist contexts.
|
||||
|
||||
Reference implementations:
|
||||
|
||||
- `packages/nx/src/utils/versions.ts` — `require('nx/package.json').version` (works because `nx` is the project's own name; the static rule's entry-point check is lenient for the top-level `nx` package specifically)
|
||||
- `packages/devkit/src/utils/package-json.ts` — `NX_VERSION = require(join('nx', 'package.json')).version` (dynamic form)
|
||||
|
||||
This was the source of the workspace-migration e2e regressions (PR #35643) and is one of the most-failure-prone steps to forget. Audit aggressively.
|
||||
|
||||
### 15b. Audit `ensurePackage` + `await import(...)` pairs
|
||||
|
||||
Search for `ensurePackage\(['"]@nx/` inside `packages/<name>/src/`. For every match, look at the next 5–20 lines for a `await import('@nx/<other>/...')` pulling from the same package. This pattern is **broken** under `nodenext`:
|
||||
|
||||
- Before migration: `module: commonjs` made TypeScript downlevel `await import('@nx/<other>')` to `Promise.resolve(require('@nx/<other>'))`. The synchronous `require()` honors `Module._initPaths`, which is exactly where `ensurePackage` registers the on-demand temp install. Resolution succeeds.
|
||||
- After migration: `module: nodenext` preserves `import()` as a true ESM dynamic import. ESM resolution **ignores** `Module._initPaths` — it walks up `node_modules` from the importing file's location only. The temp install lives in a different temp dir, so the import fails with `Cannot find package '@nx/<other>'`.
|
||||
|
||||
**Fix**: replace the dynamic import with a synchronous `require()`. The `ensurePackage` side effect makes it findable via `_initPaths`, and `require()` honors that:
|
||||
|
||||
```ts
|
||||
// Before
|
||||
ensurePackage('@nx/eslint', nxVersion);
|
||||
const { foo, bar } = await import('@nx/eslint/internal');
|
||||
|
||||
// After
|
||||
ensurePackage('@nx/eslint', nxVersion);
|
||||
// `require()` honors Module._initPaths (which ensurePackage updates); ESM
|
||||
// dynamic `import()` doesn't, so it can't see the temp install.
|
||||
const {
|
||||
foo,
|
||||
bar,
|
||||
}: typeof import('@nx/eslint/internal') = require('@nx/eslint/internal');
|
||||
```
|
||||
|
||||
Collapse multiple successive `await import()`s of the same module into one `require()` destructuring while you're at it.
|
||||
|
||||
This was the source of the M2 e2e regressions (Playwright/Web/React generators crashed at `Cannot find package '@nx/eslint'` from `ignore-vite-temp-files.js` and `ignore-vitest-temp-files.js`). One-line failure mode, but it can sit hidden in any code path that the unit-test suite doesn't exercise — only the published-then-installed flow exposes it. Audit every `ensurePackage` callsite.
|
||||
|
||||
### 16. Preserve `add-extra-dependencies` if the package has one
|
||||
|
||||
`scripts/add-dependency-to-build.js` is a release-time hack that injects an extra dep into the **published** `package.json` (e.g., it adds `nx` to `@nx/workspace`'s `dependencies`). It is **not dead code** — without it the transitive resolution chain breaks for downstream consumers.
|
||||
|
||||
Concretely: created workspaces depend on `@nx/js`, which transitively depends on `@nx/workspace`. When the fork in `generate-preset.ts` runs `nx g @nx/workspace:preset`, Node's `require.resolve('@nx/workspace/package.json')` only finds the transitively-installed package because pnpm hoists `nx` along with `@nx/workspace` into `.pnpm/node_modules/` — and `nx` is hoisted there only because the **published** `@nx/workspace/package.json` declares it as a regular dependency. Drop that injection and the fork in the new workspace fails with `Unable to resolve @nx/workspace:preset` → `unable to find tsconfig.base.json`.
|
||||
|
||||
When migrating a package that has the `add-extra-dependencies` target:
|
||||
|
||||
1. **Keep** the target in `packages/<name>/project.json`.
|
||||
2. **Update** `scripts/add-dependency-to-build.js`: change the `pkgPath` from `../dist/packages/<package>/package.json` to `../packages/<package>/package.json` (the source manifest is now the published manifest under the local-dist layout).
|
||||
3. **Keep** the `pnpm nx run-many -t add-extra-dependencies --parallel 8` invocations in `scripts/nx-release.ts` (both the GitHub-release path and the local-publish path) — they fire between `runNxReleaseVersion` and `nx run nx:expand-deps`.
|
||||
4. Confirm the snapshot/reset list (`packagesToReset`) covers this package so the injection is undone after publish.
|
||||
|
||||
If the package does not have the target, leave the script and the run-many calls alone — they no-op for any project without the target.
|
||||
|
||||
### 17. Verify
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
pnpm nx run-many -t test,build,lint -p <name>
|
||||
```
|
||||
|
||||
Then:
|
||||
|
||||
```bash
|
||||
pnpm nx affected -t build,test,lint
|
||||
```
|
||||
|
||||
### Summary of the pattern
|
||||
|
||||
The core idea is simple: instead of building to a shared `dist/packages/<name>/` at the workspace root, each package builds to its own `packages/<name>/dist/`. The `exports` map with `@nx/nx-source` condition lets workspace packages resolve to `.ts` source files during development, while external consumers get the built `.js` from `dist/`. This is like giving each package its own "output mailbox" instead of sharing one big mailbox.
|
||||
@@ -0,0 +1,399 @@
|
||||
---
|
||||
name: multi-version-compliance
|
||||
description: >
|
||||
Apply or review multi-version support compliance for first-party Nx
|
||||
plugins. Primary entry point: a Linear task ID (NXC-XXXX) from the
|
||||
"Multi-version supported across plugins" milestone — the task carries the
|
||||
resolved support window, findings, and "Needs human decision" items. Falls
|
||||
back to self-discovery when no task exists. Use when asked to "fix
|
||||
multi-version compliance for @nx/X", "do NXC-XXXX", "review this
|
||||
compliance PR", or when working on a branch / PR titled "multi-version
|
||||
support compliance for @nx/X". Covers the canonical shape
|
||||
(assertSupportedPackageVersion, all-generators-enforce-floor.spec.ts,
|
||||
peer dep alignment, requires-gate auditing, user-pin preservation,
|
||||
executor / inferred-plugin feature gating).
|
||||
argument-hint: '[<NXC-XXXX> | @nx/<plugin> | review #<PR>]'
|
||||
allowed-tools: Bash, Read, Edit, Write, Glob, Grep, Agent, mcp__linear-server__get_issue, mcp__linear-server__list_comments, mcp__linear-server__get_milestone, mcp__linear-server__list_issues
|
||||
---
|
||||
|
||||
# Multi-version compliance for Nx plugins
|
||||
|
||||
## What this is
|
||||
|
||||
The `nx migrate --first-party-only` flag lets users upgrade Nx without
|
||||
dragging the managed third-party ecosystems (Angular, Cypress, Playwright,
|
||||
Jest, Vitest, ESLint, etc.) along. For that to be safe, every first-party
|
||||
plugin must keep working across its declared support window — not silently
|
||||
fall through to the latest install constants on older workspaces, not
|
||||
silently break on newer ones.
|
||||
|
||||
**Source-of-truth split:**
|
||||
|
||||
| Source | Owns |
|
||||
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Linear milestone "Multi-version supported across plugins" (project NXC-4072) | What's wrong per plugin, the resolved support window, open human decisions. Per-plugin tasks NXC-4381..NXC-4410 (P1–P29). |
|
||||
| This skill | How to implement the canonical shape, code-level anti-patterns, gotchas, findings doc shape (no-task case). |
|
||||
|
||||
The skill is the gap-closer: it accepts a Linear task, parses it, drives
|
||||
the fix. When no task exists for the plugin, fix mode runs discovery in
|
||||
Phase 1–2 and produces a findings doc that mirrors a Linear task body —
|
||||
so the user can file it as a new task before proceeding.
|
||||
|
||||
**Reference PRs (the canonical shape):**
|
||||
|
||||
- `#35587` — `@nx/angular` — merged. Set the precedent. Introduced
|
||||
`throwForUnsupportedVersion`.
|
||||
- `#35642` — `@nx/playwright` — merged. Generalized the shared helpers
|
||||
into `@nx/devkit/internal`. Established executor / runtime feature-
|
||||
gating.
|
||||
- `#35670` — `@nx/cypress` — merged. Added `excludeGenerators` to the
|
||||
parameterized test helper.
|
||||
- `#35671` — `@nx/vitest` — open at time of writing. Demonstrates
|
||||
"drop phantom peer-range claim" and "declared floor < effective floor"
|
||||
patterns.
|
||||
|
||||
Before citing any PR by number, verify state — these go stale:
|
||||
`gh pr view <N> --repo nrwl/nx --json state`. Verify any unmerged PR's
|
||||
contents via `gh pr diff <N> --repo nrwl/nx`.
|
||||
|
||||
## Entry points
|
||||
|
||||
| Invocation | Mode | Behavior |
|
||||
| ----------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `multi-version-compliance <NXC-XXXX>` | Fix (primary) | Fetch task, surface findings + decisions in Phase 2, wait for user OK before Phase 3 edits. |
|
||||
| `multi-version-compliance` (no arg) | Ask for task ID | Prompt for NXC-XXXX. |
|
||||
| `multi-version-compliance @nx/<plugin>` (bare plugin) | Fix (task lookup) | Look up the per-plugin task in milestone NXC-4072. If found, confirm with user and enter fix mode. If not found, run discovery in Phase 1–2 (rubric against code), present findings, suggest filing as a new task before any edits. |
|
||||
| `multi-version-compliance review #<N>` | Review | Fetch PR, derive Linear task from branch name if possible, compare diff vs. task findings (or run pure code-level review if no task). |
|
||||
|
||||
**Stop-after-Phase-2 (audit-equivalent):** if you want findings without
|
||||
edits, decline to approve at the end of Phase 2. The skill stops, no
|
||||
branch, no commits.
|
||||
|
||||
**On a branch matching `nxc-NNNN` with no explicit arg:** before
|
||||
asking the user, suggest "Use NXC-NNNN?" inferred from the branch name.
|
||||
|
||||
## Linear-fetching protocol
|
||||
|
||||
Before any code-level work in Linear-driven mode, the skill MUST:
|
||||
|
||||
1. **Check Linear MCP availability.** If `mcp__linear-server__get_issue`
|
||||
isn't available (MCP server not installed / not connected), tell the
|
||||
user and fall through to the no-task discovery path (fix mode Phase 1
|
||||
step 2). Don't pretend to fetch.
|
||||
2. **Fetch the task.** `mcp__linear-server__get_issue id="NXC-XXXX"`.
|
||||
If the call errors (invalid ID, network), halt and ask the user to
|
||||
verify the ID.
|
||||
3. **Verify shape.** Confirm:
|
||||
- Title matches `[multi-version][P##] \`@nx/<plugin>\` — multi-version support compliance`(per-plugin) or`[multi-version][W#] ...` (cross-cutting). If the pattern doesn't match, halt and ask the user to confirm this is the right task.
|
||||
- Status. `Done` → ask whether re-audit or follow-up. `Canceled` → halt and ask.
|
||||
4. **Read description sections.** Every per-plugin task has:
|
||||
- **Plugin:** — path, upstream support, peerDep declarations, per-major install map, paired secondaries.
|
||||
- **Needs human decision** — open items blocking implementation.
|
||||
- **Findings** — `(high|medium|low)` items with `[file:line]` and a suggested fix per item.
|
||||
- **Verification checklist** — Sections A (Support window declarations) / B (Generator inputs) / C (Generator outputs) / D (Migrations) / E (Runtime) / F (Out-of-window UX).
|
||||
5. **Fetch comments.** `mcp__linear-server__list_comments issueId="..."`.
|
||||
Audits attached as files / linked uploads may carry additional
|
||||
context.
|
||||
6. **Surface "Needs human decision" as a batch.** Restate every decision
|
||||
item in chat. The user can resolve all, defer some, or override.
|
||||
Block until the user has acknowledged the set — don't proceed silently.
|
||||
7. **Translate findings → code changes.** Map each finding to a canonical
|
||||
pattern in `references/canonical-shape.md`. The Linear task's
|
||||
suggested fix is the authoritative scope; the skill verifies it
|
||||
conforms to the canonical shape and flags any deviation.
|
||||
8. **Run the A–F checklist** against the final code state. The task's
|
||||
checklist is the agreed scope. The skill verifies code-level
|
||||
conformance.
|
||||
|
||||
**Default to the task's resolved support window.** Don't re-derive it
|
||||
from code unless the user explicitly overrides. If the user overrides:
|
||||
restate the new window and confirm before applying.
|
||||
|
||||
**Don't expand scope beyond the task's Findings without asking.** If you
|
||||
spot a new issue mid-fix: stop, present it, ask whether to (a) add it to
|
||||
this PR, (b) defer as a follow-up, or (c) update the Linear task as a
|
||||
comment.
|
||||
|
||||
## Mode workflows
|
||||
|
||||
### Fix mode (primary)
|
||||
|
||||
**Phase 1 — Read.**
|
||||
|
||||
1. If a Linear task ID was provided, fetch it per the Linear-fetching
|
||||
protocol. If only a plugin name was provided, look up the per-plugin
|
||||
task in milestone NXC-4072.
|
||||
2. **No task case.** If no task exists for this plugin: run discovery
|
||||
instead — apply the policy ladder for the support window
|
||||
(Rule 1: upstream LTS for Angular/React/ESLint/Next/Expo; Rule 2:
|
||||
N & N-1; widen to existing supported set if larger), inventory the
|
||||
plugin's code against the A–F rubric, find the effective floor by
|
||||
walking imports, classify all results as new findings. The skill is
|
||||
producing audit-quality output for a plugin that wasn't ticketed.
|
||||
3. If on a branch matching `nxc-NNNN`, read recent commits to understand
|
||||
prior scope decisions.
|
||||
4. Read `references/canonical-shape.md` and `references/anti-patterns.md`.
|
||||
|
||||
**Phase 2 — Align.**
|
||||
|
||||
5. **(task case)** Surface every "Needs human decision" item from the
|
||||
task as a batch. Wait for resolutions.
|
||||
6. **(task case)** Restate the Findings list with severity tags. Confirm
|
||||
scope.
|
||||
7. **(no-task case)** Surface findings discovered from the rubric
|
||||
inventory + decisions the rubric surfaces (floor raise/drop, peer
|
||||
declarations, optional-vs-required peer, one-sided gates, etc.).
|
||||
Suggest filing them as a new Linear task in milestone NXC-4072
|
||||
before proceeding to Phase 3.
|
||||
8. **User OK gate.** Wait for explicit "proceed" before Phase 3.
|
||||
Declining stops the skill — no branch, no edits. (This is the
|
||||
audit-equivalent.)
|
||||
|
||||
**Phase 3 — Implement** (per `canonical-shape.md`).
|
||||
|
||||
9. Branch from `master` if needed using the repo's `nxc-NNNN` convention.
|
||||
10. Order: any shared-helper extension lands first; plugin changes land
|
||||
after. Commit/PR titling defers to the user's conventions.
|
||||
11. For each Finding category, apply the canonical pattern:
|
||||
- Section A → peer ranges + version map + install constants. Every
|
||||
third-party package the plugin **invokes at runtime** (TS import,
|
||||
executor spawning the CLI binary, or inferred-plugin emitting a
|
||||
target with `command: '<bin>'`) gets a peer entry. Default to
|
||||
`optional: true` via `peerDependenciesMeta` for gated surfaces
|
||||
(executor opt-in, inferred plugin gated on config file presence).
|
||||
Non-optional peers are reserved for packages every workspace using
|
||||
the plugin needs.
|
||||
- Section B → generator entry asserts, `keepExistingVersions`,
|
||||
fresh-install branch.
|
||||
- Section C → templates, schema stubs with runtime throws,
|
||||
version-map coverage.
|
||||
- Section D → `requires` gates per package per AND-semantics; split
|
||||
mixed entries; retain intentional pre-floor entries. **Default to
|
||||
bilateral bounds** (`>=N <M`) when writing a cross-major gate.
|
||||
One-sided gates (`<N` with no lower, `>=N` with no upper) need a
|
||||
justified reason (legacy cleanup, undefined source, v0→v1 bridge)
|
||||
— record the reason in the findings doc or as a code comment.
|
||||
- Section E → executor and inferred-plugin feature gates.
|
||||
- Section F → below-floor throw via shared util.
|
||||
- **Cross-cutting:** if the fix changes runtime behavior, update any
|
||||
in-codebase docs (`astro-docs/`, `docs/`, inline `.md`) that
|
||||
describe the changed behavior. Docs that contradict the code are a
|
||||
correctness bug, not a PR-body concern.
|
||||
12. If during implementation you spot something not in the task's
|
||||
Findings: stop, surface it, ask whether to (a) add to this PR, (b)
|
||||
defer as a follow-up, or (c) update the Linear task as a comment.
|
||||
|
||||
**Phase 4 — Tests** (same commit as Phase 3 usually).
|
||||
|
||||
13. Add `all-generators-enforce-floor.spec.ts` — parameterized via
|
||||
`assertGeneratorsEnforceVersionFloor`. This exercises every
|
||||
generator's floor assert and is the high-value spec.
|
||||
14. Footgun: assert calls must be in place in every generator BEFORE
|
||||
running the parameterized spec, or every untouched generator fails
|
||||
and you'll restart.
|
||||
15. Optional: a per-plugin `assert-supported-<pkg>-version.spec.ts`
|
||||
with the 5 canonical cases. The shared `assertSupportedPackageVersion`
|
||||
already has full coverage in devkit, so this is mostly symmetry
|
||||
across the PR series — skip unless the user asks.
|
||||
|
||||
**Phase 5 — Verify locally.**
|
||||
|
||||
16. `npx nx test <plugin> --testPathPattern="all-generators-enforce-floor"`
|
||||
(add `assert-supported-` if you added the optional wrapper spec).
|
||||
17. `npx nx test <plugin> --testPathPattern="<modified-generator>"` per
|
||||
touched generator.
|
||||
18. `npx nx format`.
|
||||
|
||||
**Phase 6 — Hand off.** Code changes complete. The user drives
|
||||
commit/push/PR per their own conventions (loaded globally from
|
||||
`~/.claude/memory/workflow/git/`). This skill does not enforce PR title,
|
||||
body, commit shape, or related-issues format.
|
||||
|
||||
### Review mode
|
||||
|
||||
1. **Fetch PR.** `gh pr view <N> --repo nrwl/nx` and
|
||||
`gh pr diff <N> --repo nrwl/nx`. For a local branch:
|
||||
`git diff master...HEAD`.
|
||||
2. **Derive the Linear task.** Branch name `nxc-NNNN` → `NXC-NNNN`. If
|
||||
no match: ask the user.
|
||||
3. **Fetch the task** (if derivable). Compare diff vs. task Findings:
|
||||
every Finding addressed; nothing extra without justification. Flag
|
||||
scope drift.
|
||||
**If no task and the user has none:** skip task-comparison; run pure
|
||||
code-level review against `canonical-shape.md` and `anti-patterns.md`.
|
||||
4. **Code-level checks.** Run the "Code-level verification (review-mode
|
||||
lens)" section of `canonical-shape.md`. Cross-reference
|
||||
`anti-patterns.md`. For each finding, anchor at `file:line` and cite
|
||||
which reference PR / file demonstrates the correct pattern.
|
||||
**Scope:** code, configs, migrations, and in-codebase docs that claim
|
||||
runtime behavior. NOT PR title / body / commit shape — those defer to
|
||||
the user's PR conventions.
|
||||
5. **Classify each finding.**
|
||||
- **Only two inline categories:** `[blocker]` and `[non-blocker]`. No
|
||||
"open question," "ask," or other inline tags. Questions for the
|
||||
author surface in the closing "Open questions for author" block,
|
||||
drawn from non-blocker findings — list each question once.
|
||||
- **Severity is independent of scope-drift.** A finding can be both a
|
||||
blocker AND not in the Linear task. Flag it as a blocker in the
|
||||
code-level section AND list it under "in PR but not in Linear task"
|
||||
in scope drift. Don't hedge with "in this PR or follow-up?" — if
|
||||
it's a blocker, the answer is "this PR."
|
||||
- **Group related non-blockers.** When multiple non-blockers describe
|
||||
symptoms of one blocker (e.g., five symptoms of a single
|
||||
`version-utils.ts` duplication), list them as sub-bullets under
|
||||
the blocker with "(resolved when §X is fixed)" rather than as N
|
||||
separate top-level non-blockers.
|
||||
- **Be terse on passes.** A section with no findings gets a single
|
||||
summary line ("Pass — all 7 generator entries assert at first
|
||||
statement"), not a per-file enumeration. Detail is reserved for
|
||||
blockers and non-blockers. The reviewer's audience skims for
|
||||
actionable items; passing checks should not eat reading budget.
|
||||
6. **Output.** Markdown checklist of blockers / non-blockers anchored at
|
||||
`file:line`, followed by the structured verdict block from
|
||||
`canonical-shape.md` §"Verdict template". The verdict block is the
|
||||
skimmable index — produce it, don't substitute a free-form prose
|
||||
summary. Do not post via `gh pr review` unless the user explicitly
|
||||
asks.
|
||||
|
||||
## Which references to load (context hygiene)
|
||||
|
||||
| Mode | Required | Optional |
|
||||
| ---------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| Fix | `canonical-shape.md`, `anti-patterns.md` | `gotchas.md` (effective floor, ecosystem lockstep, cypress inline tree), `examples.md` (when copying a pattern) |
|
||||
| Review | `anti-patterns.md`, `canonical-shape.md` (especially the "Code-level verification" section) | `gotchas.md` (cross-plugin coordination, lockstep), `examples.md` (when citing) |
|
||||
| "What is compliance?" answer | none | answer from SKILL.md alone |
|
||||
|
||||
References are ~100–500 lines each. Don't pull all of them just because
|
||||
you're invoked. Match the load to the mode.
|
||||
|
||||
## Critical rules (apply in every mode)
|
||||
|
||||
1. **Linear task is the source of truth for scope** (ratified decisions
|
||||
and Findings).
|
||||
- (a) Don't produce a parallel scope document. The task IS the scope.
|
||||
Fix mode runs against the task as input — drift checks, new
|
||||
findings, and decisions feed back to the task (via comments or as
|
||||
deferred items), not into a competing source of truth.
|
||||
- (b) Don't expand a fix beyond the task's Findings without
|
||||
surfacing the new issue.
|
||||
- (c) Don't second-guess the task's resolved support window without
|
||||
an explicit user override.
|
||||
2. **Do not create or duplicate shared helpers.** They live in
|
||||
`@nx/devkit/internal` (`assertSupportedPackageVersion`,
|
||||
`getInstalledPackageVersion`, `getDeclaredPackageVersion`,
|
||||
`throwForUnsupportedVersion`, `normalizeSemver`, `isNonSemverDistTag`)
|
||||
and `@nx/devkit/internal-testing-utils`
|
||||
(`assertGeneratorsEnforceVersionFloor`). Reject any local
|
||||
re-implementation (`cleanVersion`, `getInstalled<Pkg>VersionRuntime`,
|
||||
private `throwBelowFloor`, etc.). See `canonical-shape.md`.
|
||||
3. **Above-ceiling is silent fallthrough.** Do not warn, do not throw,
|
||||
do not branch. Reject `throwAboveWindow`, `warnAboveCeiling`,
|
||||
`versions()` with `switch + throw default:`. The only throw is below
|
||||
the declared floor.
|
||||
4. **`keepExistingVersions: true` is for generators only.** Migration
|
||||
generators (`src/migrations/`) are exempt — their job is to bump.
|
||||
Do not flag missing flags in migration code.
|
||||
5. **Floor assert is the first statement in the function doing the
|
||||
actual work.** Wrapper/internal split (cypress, playwright): in
|
||||
`*Internal`. Single-function generators (angular): in the function
|
||||
itself. Not conditional, not inside an install branch, not after a
|
||||
tree read.
|
||||
6. **Phase 1–2 never writes, never branches.** Discovery, finding
|
||||
classification, and decision-surfacing happen on the current branch
|
||||
with no edits. Any working artifact (e.g., a findings doc for a
|
||||
no-task case, multi-plugin scratch notes) goes in `tmp/` (gitignored)
|
||||
and stays uncommitted. No `TRIAGE-REPORT.md` / `AUDIT.md` at repo
|
||||
root. Branch creation and edits start at Phase 3, after the user OK.
|
||||
7. **PR / commit conventions are out of scope.** Title format, body shape,
|
||||
commit-message structure, related-issues handling, push flags, etc.
|
||||
are governed by the user's global memory (`pr-creation-shorthand.md`,
|
||||
`push-conventions.md`, `explain-before-committing.md`,
|
||||
`chore-not-fix-non-prod.md`). Don't enforce or flag these from this
|
||||
skill — defer to whatever the user's conventions resolve to at PR time.
|
||||
|
||||
## Findings doc template (Phase 2 output, used when no Linear task exists)
|
||||
|
||||
When fix mode hits the no-task case (Phase 1 step 2), produce
|
||||
`tmp/<plugin>-findings.md` shaped to mirror a Linear task body so the
|
||||
user can file it as a new task in milestone NXC-4072 before proceeding
|
||||
to Phase 3.
|
||||
|
||||
For plugins managing multiple primary packages, repeat the install-map
|
||||
/ decisions / findings bullets per primary.
|
||||
|
||||
```md
|
||||
# @nx/<plugin> — multi-version support compliance findings
|
||||
|
||||
> No Linear task in milestone NXC-4072. This doc is filing-ready —
|
||||
> create the task with this body before proceeding to fix.
|
||||
|
||||
## Plugin
|
||||
|
||||
- Path: packages/<plugin>
|
||||
- Upstream support: <official policy if any, else "no formal LTS">
|
||||
- peerDep declarations: <list>
|
||||
- Per-major install (`<file>` branches on installed `<package>` major):
|
||||
- v<N-1>: <constants>
|
||||
- v<N>: <constants> (default)
|
||||
- Paired secondaries: <list of ecosystem-locked siblings>
|
||||
|
||||
## Needs human decision
|
||||
|
||||
1. <decision 1 — e.g., raise floor to vN.0.0 vs keep current>
|
||||
2. <decision 2 — e.g., drop ^1.0.0 from peer (no v1 install lane)>
|
||||
|
||||
## Findings
|
||||
|
||||
- **(high) <one-line summary>** [file:line]
|
||||
_Suggested fix_: <one-line>
|
||||
- **(medium) ...**
|
||||
- **(low) ...**
|
||||
|
||||
## Verification checklist (A–F)
|
||||
|
||||
### A. Support window declarations
|
||||
|
||||
- [ ] peerDep ranges match the support window
|
||||
- [ ] Version map / runtime branching covers every supported major
|
||||
- [ ] Every third-party package the plugin **invokes at runtime** has a peerDep entry. "Invokes" = TS import/`require` OR executor spawns its CLI binary OR inferred plugin emits a target whose `command` invokes its CLI (look for `externalDependencies: ['<pkg>']` in emitted target inputs). Packages the generator installs for the user to consume independently (ESLint plugins loaded by the user's eslintrc, `@types/*`) don't need peer-declaration.
|
||||
- [ ] Peers needed only when a user opts into a specific surface (executor opt-in, inferred plugin gated on config file presence, opt-in preset) are declared **optional** via `peerDependenciesMeta: { "<pkg>": { "optional": true } }`. Required-non-optional peers are reserved for packages every workspace using the plugin needs.
|
||||
|
||||
### B. Generator inputs
|
||||
|
||||
- [ ] Generators don't overwrite installed third-party versions
|
||||
- [ ] `addDependenciesToPackageJson` passes `keepExistingVersions=true` or branches on detected version
|
||||
- [ ] Fresh-install path installs the latest supported version
|
||||
|
||||
### C. Generator outputs
|
||||
|
||||
- [ ] Templates compile and run on every supported version
|
||||
- [ ] Generated `project.json` target shape valid on every major
|
||||
- [ ] Default option values valid on every major
|
||||
- [ ] Version map covers every managed third-party dep — no gaps
|
||||
- [ ] Schema accepts union of options; runtime throws when inapplicable
|
||||
|
||||
### D. Migrations (migrations.json + packageJsonUpdates)
|
||||
|
||||
- [ ] Cross-major `packageJsonUpdates` declare `requires` per bumped package
|
||||
- [ ] `requires` ranges are bilateral (`>=N <M`) by default. One-sided ranges (`<N` with no lower, `>=N` with no upper) are intentional (legacy cleanup, undefined source major, v0→v1 bridge) — flagged in "Needs human decision" or noted in the Findings.
|
||||
- [ ] Every migration declares `requires` against the touched package
|
||||
- [ ] Nx-only migrations have no third-party `requires`
|
||||
- [ ] No silent gap in `packageJsonUpdates` across the support window
|
||||
|
||||
### E. Runtime
|
||||
|
||||
- [ ] Executors branch on installed version where behavior diverges
|
||||
- [ ] Inferred plugin (createNodes/V2) parses configs across every major
|
||||
|
||||
### F. Out-of-window UX
|
||||
|
||||
- [ ] Below-floor: throws via shared util naming package + installed + floor; no silent fall-through
|
||||
|
||||
## Out-of-scope (deferred follow-ups)
|
||||
|
||||
- <e.g., consolidate ... across plugins — separate PR>
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
See "Which references to load" near the top. Don't pull all of them.
|
||||
@@ -0,0 +1,329 @@
|
||||
# Anti-patterns
|
||||
|
||||
Patterns to reject in your own work and flag in reviews. Each entry: what it looks like, why it's wrong, what to do instead, and a reference.
|
||||
|
||||
## 1. Local re-implementation of the shared helpers
|
||||
|
||||
**Looks like:** A new file in the plugin defining any of:
|
||||
|
||||
- `throwBelowFloor` / `throwAboveWindow` / `assertVersion` / `checkMinimumVersion` — duplicates `throwForUnsupportedVersion` / `assertSupportedPackageVersion`.
|
||||
- `function cleanVersion(v) { return clean(v) ?? coerce(v)?.version ?? undefined; }` — duplicates `normalizeSemver`.
|
||||
- `getInstalledRsbuildVersionRuntime` / `getInstalled<X>FromFs` reading `require('<pkg>/package.json')` directly — duplicates `getInstalledPackageVersion`.
|
||||
- Inline `clean(declared) ?? coerce(declared)` chain at a generator entry point — duplicates `getDeclaredPackageVersion`.
|
||||
- Open-coded tree-branch in `getInstalled<Pkg>Version(tree?)`: `getDependencyVersionFromPackageJson(tree, pkg)` + an `installedVersion === 'latest' || installedVersion === 'next'` check + a `clean(...) ?? coerce(...)?.version ?? null` chain. The dist-tag list and the normalization chain are both centralized in `getDeclaredPackageVersion` (via `NON_SEMVER_DIST_TAGS` / `normalizeSemver`). A local copy silently misses new entries if `NON_SEMVER_DIST_TAGS` grows.
|
||||
|
||||
**Why wrong:** The shared helpers in `@nx/devkit/internal` and `@nx/devkit/internal-testing-utils` already exist. Duplicates create drift — one will get the `latest`/`next` handling, the other won't; one will use `getNxRequirePaths()` for pnpm-strict resolution, the other won't.
|
||||
|
||||
**Do instead:** Call `assertSupportedPackageVersion(tree, pkg, floor)` via the per-plugin wrapper (`assertSupportedXVersion`). For executor-side reads: `getInstalledPackageVersion(pkg)`. For tree-side normalization: `getDeclaredPackageVersion(tree, pkg, latestKnown)`. For raw semver cleaning: `normalizeSemver(v)`.
|
||||
|
||||
For the `getInstalled<Pkg>Version(tree?)` wrapper specifically:
|
||||
|
||||
```ts
|
||||
export function getInstalledCypressVersion(tree?: Tree): string | null {
|
||||
if (!tree) {
|
||||
return getInstalledPackageVersion('cypress');
|
||||
}
|
||||
return getDeclaredPackageVersion(tree, 'cypress');
|
||||
}
|
||||
```
|
||||
|
||||
**Omit the third arg by default.** It conflates "missing" with "dist tag" — both fall back to the supplied fresh-install constant. That's almost never what the caller wants; consumers that need a `?? latest` fallback should encode it at the call site, not globally in the helper (rspack/rsbuild precedent). See `canonical-shape.md` §"Dist-tag semantics — third arg".
|
||||
|
||||
**Reference:** Compliant — `packages/cypress/src/utils/assert-supported-cypress-version.ts` (7 lines); `packages/cypress/src/utils/versions.ts` `getInstalledCypressVersion` (no third arg); `packages/rspack/src/utils/version-utils.ts` and `packages/rsbuild/src/utils/version-utils.ts` (same shape). Concrete anti-pattern — PR `#35676` introduces `function cleanVersion` (`packages/rsbuild/src/utils/versions.ts`) and `getInstalledRsbuildVersionRuntime` reading `require('@rsbuild/core/package.json')`. Both should call the shared helpers instead.
|
||||
|
||||
## 2. Above-ceiling throw or warn
|
||||
|
||||
**Looks like:** `if (major > maxKnown) throw …`, `if (major > maxKnown) logger.warn …`, `versions()` with a `switch + throw default:`, any `warnAboveCeiling` / `throwAboveWindow` helper.
|
||||
|
||||
**Why wrong:** Explicit policy. Above-ceiling falls through silently to `latestVersions`. Throwing breaks users on newer versions of third-party packages, which is the opposite of the initiative's intent. The angular reference implementation does not warn or branch above the highest known major, and every subsequent plugin compliance PR follows that convention.
|
||||
|
||||
**Do instead:** `versionMap[major] ?? latestVersions`. Below-floor is caught by the generator-level assert; the `versions()` function is just a lookup.
|
||||
|
||||
**Reference:** Compliant — `packages/cypress/src/utils/versions.ts` after `#35670` rewrite. Anti-pattern (before fix) — same file before `#35670` had `switch + throw default:`.
|
||||
|
||||
## 3. Hardcoded third-party version in generator body
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```ts
|
||||
addDependenciesToPackageJson(tree, {}, { rspack: '^1.1.10' });
|
||||
```
|
||||
|
||||
in a generator.
|
||||
|
||||
**Why wrong:** Bypasses the `versions(tree)` routing and the install-lane logic. New majors will not be picked up; older workspaces get the wrong version.
|
||||
|
||||
**Do instead:** Route through `versions(tree)` and reference the per-major entry. If you genuinely have a version that's the same across all majors, still put it in the map for consistency.
|
||||
|
||||
## 4. Init generator overwriting pinned versions
|
||||
|
||||
**Looks like:** `addDependenciesToPackageJson(tree, …, …, undefined, options.keepExistingVersions)` where the schema default is `false`. Or no fifth argument at all (defaults to `false`).
|
||||
|
||||
**Known-incomplete reference:** `@nx/angular`'s `init/schema.json` currently has `default: false` and `init.ts` passes `options.keepExistingVersions` directly — PR `#35587` did not fix this. The angular init generator therefore still has this bug. Flagging it in a non-angular compliance PR is correct; fixing it in passing during another angular PR is also appropriate.
|
||||
|
||||
**Why wrong:** Generators bump packages = the user's pinned version is silently overwritten on re-run. Bumping is the job of migrations, not generators.
|
||||
|
||||
**Do instead:** Pass `keepExistingVersions: true` (positional 5th arg) or `options.keepExistingVersions ?? true`. Flip the schema default to `true`.
|
||||
|
||||
**Reference:** Compliant — `packages/cypress/src/generators/init/init.ts` and `init/schema.json` after `#35670`. Anti-pattern — the same files before `#35670` had schema default `false`.
|
||||
|
||||
## 5. `requires` gate on an Nx-only migration
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```json
|
||||
{
|
||||
"update-unit-test-runner-option": {
|
||||
"requires": { "@angular/core": ">=21.0.0" },
|
||||
"description": "Update 'vitest' unit test runner option to 'vitest-analog' in generator defaults."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
when the migration only writes to `nx.json`.
|
||||
|
||||
**Why wrong:** The migration applies regardless of third-party version — it's rewriting an Nx-owned generator default. The gate causes pre-v21 workspaces with the stale default to silently skip the migration and stay broken.
|
||||
|
||||
**Do instead:** Remove the `requires` entry entirely. Nx-only migrations have no third-party gate.
|
||||
|
||||
**Reference:** Anti-pattern (before fix) — `packages/angular/migrations.json` `update-unit-test-runner-option`. Fix — `#35587` removed the gate.
|
||||
|
||||
## 6. Cross-major `packageJsonUpdates` with no `requires`
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```json
|
||||
{
|
||||
"21.3.0": {
|
||||
"packages": {
|
||||
"jest": { "version": "^30.0.0" }
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
with no `requires` gate, when this is a v29 → v30 bump.
|
||||
|
||||
**Why wrong:** The bump fires for every workspace — including workspaces already on v30 (idempotent best case) or workspaces on v28 or below (which would silently land on v30 without going through any v29 → v30 codemods). Source-major gate ensures the bump only fires for workspaces actually in the source range.
|
||||
|
||||
**Do instead:**
|
||||
|
||||
```json
|
||||
{
|
||||
"21.3.0": {
|
||||
"requires": { "jest": ">=29.0.0 <30.0.0" },
|
||||
"packages": { "jest": { "version": "^30.0.0" } }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Reference:** Compliant — `packages/angular/migrations.json` MF entries after `#35587`. Anti-pattern examples on master at time of writing — `@nx/jest` `21.3.0`, `@nx/eslint` `20.7.0`, `@nx/vite` `20.5.0` (verify by inspecting each plugin's `migrations.json` for cross-major `packageJsonUpdates` entries lacking `requires`).
|
||||
|
||||
## 7. Gating ecosystem-locked siblings on the primary's major alone
|
||||
|
||||
**Looks like:** A migration that bumps `@ngrx/store` from v18 to v19 with `requires: { "@angular/core": ">=19.0.0" }` only — no `@ngrx/store` entry.
|
||||
|
||||
**Why wrong:** `@ngrx/store` is independent of `@angular/core` versioning. A workspace can be on `@angular/core: 19` without having `@ngrx/store: 18` (might not use ngrx at all, or might be on v17). Gating on `@angular/core` fires the migration in workspaces where it has nothing to do.
|
||||
|
||||
**Do instead:** Add the sibling to `requires`: `{ "@angular/core": ">=19.0.0", "@ngrx/store": ">=18.0.0 <19.0.0" }`. For Angular ecosystem siblings: `@angular/cli`, `@angular/ssr`, `@angular-devkit/build-angular` (v20+) are peer-locked via `@angular/core` and don't need their own gate. `@ngrx/*`, `@angular-eslint/*`, `zone.js`, `jest-preset-angular` are independent and do.
|
||||
|
||||
**How to verify pairing:** read the sibling package's `peerDependencies` at the version range being bumped from. If it pins the primary's major, the primary's `requires` covers it. If it doesn't, the sibling is independent and needs its own gate.
|
||||
|
||||
## 8. Peer dep claiming a major with no install branch (phantom claim)
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```json
|
||||
{
|
||||
"peerDependencies": {
|
||||
"vitest": "^1.0.0 || ^2.0.0 || ^3.0.0 || ^4.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
when `versions.ts` has no v1 entry and no `isVitestV1` branch anywhere.
|
||||
|
||||
**Why wrong:** The plugin advertises support for a version it doesn't honor. v1 workspaces silently fall through to v4 install constants.
|
||||
|
||||
**Do instead:** Drop the unsupported major from the peer. `vitest: "^2.0.0 || ^3.0.0 || ^4.0.0"`. If the support is desired, add the install lane.
|
||||
|
||||
**Reference:** Pattern demonstrated in open PR `#35671` (`@nx/vitest`) — drops `^1.0.0` from the `vitest` peer because there's no v1 install lane in the plugin's `versions.ts`. Inspect via `gh pr diff 35671 --repo nrwl/nx -- packages/vitest/package.json`. Verify state first.
|
||||
|
||||
**Related — drop EOL major (different reasoning, same action):** the major HAS an install lane but is EOL upstream (e.g., Storybook's official policy is "top 3 majors only"; v7 is EOL). Drop it from the peer because it's upstream-unsupported, not because the plugin doesn't honor it. Concrete example: NXC-4406 calls out dropping Storybook v7 from `@nx/storybook`'s peer per Storybook's top-3-majors policy.
|
||||
|
||||
## 8a. PeerDep range wider than the runtime dep pin
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```json
|
||||
{
|
||||
"peerDependencies": {
|
||||
"@typescript-eslint/parser": "^6.0.0 || ^7.0.0 || ^8.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@typescript-eslint/parser": "^8.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The plugin's own runtime dep pins ^8, but the peer claims ^6/^7/^8.
|
||||
|
||||
**Why wrong:** Distinct from §8 — here the install lane exists (in `dependencies`), but the lane only ships one major. The peer is over-promising relative to what the plugin actually runs against. A workspace on ^6 will satisfy the peer but won't get a compatible runtime once `@typescript-eslint/parser@^8` resolves.
|
||||
|
||||
**Do instead:** Tighten the peer to the actually-supported runtime range, or widen the runtime dep + add the install/branch lanes for the additional majors.
|
||||
|
||||
**Reference:** NXC-4388 (`@nx/eslint-plugin`).
|
||||
|
||||
## 9. Top-level `require()` of an optional peer in an executor
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```ts
|
||||
// at the top of executor.impl.ts
|
||||
const cypress = require('cypress');
|
||||
```
|
||||
|
||||
**Why wrong:** When cypress is absent (not yet installed, peer mismatch, etc.), the executor throws `MODULE_NOT_FOUND` at module load time, before any user-friendly error. Especially bad for deprecated executors that should fail with a deprecation message.
|
||||
|
||||
**Do instead:** `require` inside the function body, after the version detection / clear error.
|
||||
|
||||
## 10. Anything-but-`requires` as substitute for `requires`
|
||||
|
||||
**Looks like (variant A — `incompatibleWith` standing in):**
|
||||
|
||||
```json
|
||||
{
|
||||
"21.0.0-source-bump": {
|
||||
"incompatibleWith": { "@angular-devkit/build-angular": "<21.0.0" },
|
||||
"packages": { "...": { "version": "..." } }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
to "gate" a bump to v21+ source workspaces.
|
||||
|
||||
**Looks like (variant B — runtime per-package guard):**
|
||||
|
||||
```ts
|
||||
// inside the migration function body
|
||||
const installed = getInstalledVersion('@typescript-eslint/parser');
|
||||
if (gte(installed, '8.0.0') && lt(installed, '8.13.0')) {
|
||||
// run the migration
|
||||
}
|
||||
return; // otherwise skip
|
||||
```
|
||||
|
||||
with no `requires` block on the migration entry in `migrations.json`.
|
||||
|
||||
**Why wrong:** Neither approach is a source-major gate.
|
||||
|
||||
- `incompatibleWith` blocks running on workspaces that have the matching version — it doesn't gate to a source-major range. A workspace on `@angular-devkit/build-angular: 22.0.0` will still pass the `incompatibleWith` check.
|
||||
- A runtime per-package guard runs the migration _body_ on every workspace and skips internally. The migration record still appears as "executed" to the migrate runner, and any side effects (logging, partial work) leak. The `nx migrate` runner uses `requires` as the source-major filter; bypassing it means the migration isn't filtered at the right layer.
|
||||
|
||||
**Do instead:** `requires: { "<pkg>": ">=N.0.0 <(N+1).0.0" }` — the actual source-major gate at the migration-entry level. Drop the in-body guard once the `requires` is in place.
|
||||
|
||||
**Reference:** Anti-pattern (variant B) — `@nx/eslint` `update-typescript-eslint-v8.13.0` (NXC-4387) has runtime `gte('8.0.0') + lt('8.13.0')` per-package guards but no `requires` block. `@nx/jest` similar with `incompatibleWith` (NXC-4391).
|
||||
|
||||
## 11. Naming a specific plugin in shared helper docstrings
|
||||
|
||||
**Looks like:** A JSDoc in `assert-generators-enforce-version-floor.ts` referencing `migrate-to-cypress-11` as the example use case for `excludeGenerators`.
|
||||
|
||||
**Why wrong:** The helper is shared across plugins. Naming one plugin in its docstring is leaky.
|
||||
|
||||
**Do instead:** Generic phrasing — "generators that must run below the floor by design (e.g., migrators that lift sub-floor workspaces onto a supported version)".
|
||||
|
||||
**Reference:** an early draft of `#35670`'s test helper had the plugin-specific JSDoc; the merged version uses generic phrasing.
|
||||
|
||||
## 12. Both schema `"default": true` AND `options.keepExistingVersions ?? true`
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```json
|
||||
{ "keepExistingVersions": { "default": true } }
|
||||
```
|
||||
|
||||
combined with
|
||||
|
||||
```ts
|
||||
addDependenciesToPackageJson(tree, …, …, undefined, options.keepExistingVersions ?? true);
|
||||
```
|
||||
|
||||
**Why wrong:** Two sources of truth. Either the schema default does the job (and `options.keepExistingVersions` will always be `true`) or the `?? true` fallback handles it (and the schema default is redundant).
|
||||
|
||||
**Do instead:** Pick one. Schema default is sufficient when the call site uses `options.keepExistingVersions` directly. The `?? true` fallback is only needed if the schema can be bypassed (programmatic invocation without schema validation).
|
||||
|
||||
## 13. Manual `RegExp` matching in tests instead of substring `toThrow`
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```ts
|
||||
.rejects.toThrow(new RegExp(`Unsupported version of \\\`${packageName}\\\` detected`));
|
||||
```
|
||||
|
||||
**Why wrong:** Escape bugs. The backtick and the `${}` are easy to get wrong. The shared helper uses substring matching for a reason.
|
||||
|
||||
**Do instead:**
|
||||
|
||||
```ts
|
||||
.rejects.toThrow(`Unsupported version of \`${packageName}\` detected`);
|
||||
```
|
||||
|
||||
**Reference:** see how `assertGeneratorsEnforceVersionFloor` itself does the match in `packages/nx/src/internal-testing-utils/assert-generators-enforce-version-floor.ts` (grep for `Unsupported version of`).
|
||||
|
||||
## 14. Validating only at install sites instead of generator entry
|
||||
|
||||
**Looks like:** A `if (installedVersion < floor) throw …` check guarding only the `addDependenciesToPackageJson` call inside a generator, while the rest of the generator runs unconditionally.
|
||||
|
||||
**Why wrong:** The generator may write configuration or templates incompatible with the sub-floor third-party version before reaching the install branch. The assert must be at the entry point so nothing else runs.
|
||||
|
||||
**Do instead:** `assertSupportedXVersion(tree)` as the first statement in the generator's working function (`*Internal` for plugins with the wrapper/internal split; the function itself for single-function generators). The install branch can then assume the floor is met.
|
||||
|
||||
## 15. Per-major version aliases alongside the bundle map
|
||||
|
||||
**Looks like:**
|
||||
|
||||
```ts
|
||||
export const vitestV4Version = '~4.1.0';
|
||||
export const vitestV3Version = '^3.0.0';
|
||||
export const vitestV2Version = '^2.1.8';
|
||||
export const vitestVersion = vitestV4Version;
|
||||
|
||||
export const vitestV4CoverageV8Version = '~4.1.0';
|
||||
export const vitestV3CoverageV8Version = '^3.0.5';
|
||||
// ...etc
|
||||
|
||||
const versionMap = {
|
||||
3: { vitestVersion: '^3.0.0', vitestCoverageV8Version: '^3.0.5' },
|
||||
4: { vitestVersion: '~4.1.0', vitestCoverageV8Version: '~4.1.0' },
|
||||
};
|
||||
```
|
||||
|
||||
**Why wrong:** The aliases (`vitestV3Version`, `vitestV3CoverageV8Version`, etc.) duplicate the `versionMap` entries. They drift over time — someone bumps the map but forgets the alias (or vice versa), and the plugin starts installing one version via generators and another via tests/runtime. Also: every dropped major (e.g., when raising the floor) becomes three or four delete lines instead of one map entry.
|
||||
|
||||
**Do instead:** Keep the bundle pattern — the per-major `versionMap` is the only place those values live. Stable (cross-version-identical) deps stay as top-level `export const`s; varying deps are accessed via `versions(tree).<key>` or directly from the top-level `latestVersions` bundle.
|
||||
|
||||
**Reference:** Open PR `#35671` initially carried `vitestV2Version` / `vitestV3Version` / `vitestV4Version` aliases. A follow-up commit (`chore(testing): adopt cypress version-resolution pattern in @nx/vitest`) dropped them in favor of the bundle pattern. Inspect via `gh pr view 35671 --repo nrwl/nx --json commits`.
|
||||
|
||||
## 16. Declared floor below the effective floor
|
||||
|
||||
**Looks like:** `peerDependencies` lists `"vitest": "^2.0.0 || ^3.0.0 || ^4.0.0"` and `versions.ts` has a `versionMap` entry for `2`, but somewhere in the plugin's executor / runtime / plugin code there's an import of a third-party API that only exists in v3+:
|
||||
|
||||
```ts
|
||||
// In a runtime helper used by the executor:
|
||||
import { getRelevantTestSpecifications } from 'vitest/node';
|
||||
// ^ This API only exists in vitest >= 3.0.0.
|
||||
```
|
||||
|
||||
**Why wrong:** A workspace on v2 will pass the floor assert (peer + versionMap claim support), then crash at runtime with `getRelevantTestSpecifications is not a function`. The peer is lying.
|
||||
|
||||
**Do instead:** Raise the floor to the lowest major where every called third-party API exists. Drop the now-unsupported entries from `versionMap`, `peerDependencies`, and the per-major version aliases (if any). The `assert-supported-<pkg>-version.spec.ts` sub-floor test now covers the dropped major.
|
||||
|
||||
**Reference:** Open PR `#35671`'s second commit (`fix(testing): drop vitest v2 support from @nx/vitest`) — originally proposed a v2 floor matching the lowest install lane, then raised to v3 after audit caught the `getRelevantTestSpecifications` usage. Inspect via `gh pr view 35671 --repo nrwl/nx --json commits`.
|
||||
|
||||
## 17. Creating a branch during Phase 1–2 (discovery / read-only)
|
||||
|
||||
**Looks like:** `git checkout -b <some-branch>` before the user has approved Phase 3 edits.
|
||||
|
||||
**Why wrong:** Phase 1–2 produces findings, not commits. Creating a branch creates pressure to commit something. Any working artifact (e.g., `tmp/<plugin>-findings.md` for the no-task case) goes in `tmp/` (gitignored) — for the user to read and scope from, not to commit.
|
||||
|
||||
**Do instead:** Run Phase 1–2 on the current branch (typically `master`). Output to `tmp/<plugin>-findings.md` if you wrote one. Branch creation belongs in Phase 3, after explicit user approval to proceed with edits.
|
||||
@@ -0,0 +1,655 @@
|
||||
# Canonical shape
|
||||
|
||||
What a compliant plugin looks like. Don't deviate without a documented reason.
|
||||
|
||||
The first half of this file ("How to write") describes the canonical structure
|
||||
you produce in fix mode. The tail section ("Code-level verification") is the
|
||||
review-mode lens — markers to look for in a diff.
|
||||
|
||||
## Shared helpers (already merged — use, don't duplicate)
|
||||
|
||||
### `@nx/devkit/internal`
|
||||
|
||||
Source: `packages/devkit/src/utils/version-floor.ts` and `packages/devkit/src/utils/installed-version.ts`.
|
||||
|
||||
```ts
|
||||
// version-floor.ts
|
||||
function throwForUnsupportedVersion(
|
||||
packageName: string,
|
||||
installedVersion: string,
|
||||
floor: string
|
||||
): never;
|
||||
|
||||
function assertSupportedPackageVersion(
|
||||
tree: Tree,
|
||||
packageName: string,
|
||||
minSupportedVersion: string
|
||||
): void;
|
||||
```
|
||||
|
||||
```ts
|
||||
// installed-version.ts
|
||||
function getInstalledPackageVersion(packageName: string): string | null;
|
||||
|
||||
function getDeclaredPackageVersion(
|
||||
tree: Tree,
|
||||
packageName: string,
|
||||
latestKnownVersion?: string
|
||||
): string | null;
|
||||
|
||||
const NON_SEMVER_DIST_TAGS = ['latest', 'next'] as const;
|
||||
function isNonSemverDistTag(version: string): version is NonSemverDistTag;
|
||||
function normalizeSemver(version: string): string | null;
|
||||
```
|
||||
|
||||
When to use which:
|
||||
|
||||
| Context | Function |
|
||||
| -------------------------------- | ----------------------------------------------------------------------------------- |
|
||||
| Generator entry (assert floor) | `assertSupportedPackageVersion(tree, pkg, floor)` |
|
||||
| Generator-time version branching | `getDeclaredPackageVersion(tree, pkg, latestKnownVersion)` |
|
||||
| Executor / runtime / preset | `getInstalledPackageVersion(pkg)` |
|
||||
| Anywhere | `isNonSemverDistTag`, `normalizeSemver` |
|
||||
| Never | `throwForUnsupportedVersion` directly — it's an implementation detail of the assert |
|
||||
|
||||
### `@nx/devkit/internal-testing-utils`
|
||||
|
||||
Source: `packages/nx/src/internal-testing-utils/assert-generators-enforce-version-floor.ts`.
|
||||
|
||||
```ts
|
||||
function assertGeneratorsEnforceVersionFloor(options: {
|
||||
packageRoot: string;
|
||||
packageName: string;
|
||||
subFloorVersion: string;
|
||||
excludeGenerators?: string[];
|
||||
}): void;
|
||||
```
|
||||
|
||||
Behavior: reads `generators.json` from `packageRoot`, iterates every entry, loads its factory, calls it against a tree with `{ [packageName]: subFloorVersion }` in `package.json`, expects a throw matching `Unsupported version of \`${packageName}\` detected`.
|
||||
|
||||
`excludeGenerators` is only for intentional sub-floor migrators (e.g., `migrate-to-cypress-11`). Comment the reason next to the array.
|
||||
|
||||
## Finding the existing floor (audit input)
|
||||
|
||||
When auditing a plugin you haven't touched before, the floor may not be declared in one place. Check, in order of authority:
|
||||
|
||||
1. **`minSupported<Pkg>Version` constant in `versions.ts`** — if it exists, that's the declared floor.
|
||||
2. **`peerDependencies` lowest range in `package.json`** — what the plugin advertises supporting.
|
||||
3. **Lowest major in `versionMap` / `backwardCompatibleVersions` / `supportedVersions`** — what the plugin has install lanes for.
|
||||
4. **Lowest `packageJsonUpdates` entry that touches the third-party package** — historical evidence of the supported range.
|
||||
5. **Highest API requirement in the plugin's own code (the _effective_ floor).** Grep for every `import` / `require` from the third-party package and identify which APIs are called. Cross-reference each against the third-party's changelog. The plugin's effective floor is the lowest major where **all** called APIs exist. **This trumps the declared floor** — if `versions.ts` claims v2 but the plugin imports an API only available in v3+, the declared floor is wrong.
|
||||
|
||||
These should agree. When they don't, the disagreement is the finding (phantom peer claim, drifted versionMap, declared floor below effective floor).
|
||||
|
||||
**Worked example:** During open PR `#35671`, the audit initially landed on a `v2.0.0` floor (matching the lowest install lane). Then a follow-up commit dropped the floor to `v3.0.0` after noticing the plugin's atomization code calls `getRelevantTestSpecifications`, which is a vitest v3+ API. Lesson: step 5 above is not optional. Always check what APIs the plugin's own runtime code uses — `versions()` having a v2 lane doesn't mean the plugin actually works on v2.
|
||||
|
||||
## The plugin wrapper (one per plugin)
|
||||
|
||||
Path: `packages/<plugin>/src/utils/assert-supported-<pkg>-version.ts`.
|
||||
|
||||
Two canonical shapes:
|
||||
|
||||
### Single-major floor (most plugins)
|
||||
|
||||
```ts
|
||||
import { type Tree } from '@nx/devkit';
|
||||
import { assertSupportedPackageVersion } from '@nx/devkit/internal';
|
||||
import { minSupportedCypressVersion } from './versions';
|
||||
|
||||
export function assertSupportedCypressVersion(tree: Tree): void {
|
||||
assertSupportedPackageVersion(tree, 'cypress', minSupportedCypressVersion);
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/cypress/src/utils/assert-supported-cypress-version.ts`, `packages/playwright/src/utils/assert-supported-playwright-version.ts`.
|
||||
|
||||
### Floor derived from supported-versions list (angular)
|
||||
|
||||
```ts
|
||||
import { type Tree } from '@nx/devkit';
|
||||
import { assertSupportedPackageVersion } from '@nx/devkit/internal';
|
||||
import { supportedVersions } from './backward-compatible-versions';
|
||||
|
||||
const minSupportedAngularMajor = Math.min(...supportedVersions);
|
||||
|
||||
export function assertSupportedAngularVersion(tree: Tree): void {
|
||||
assertSupportedPackageVersion(
|
||||
tree,
|
||||
'@angular/core',
|
||||
`${minSupportedAngularMajor}.0.0`
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/angular/src/utils/assert-supported-angular-version.ts`.
|
||||
|
||||
Pick the shape that matches whether the plugin already has a `supportedVersions` list (angular does; cypress/playwright/vitest don't).
|
||||
|
||||
### Plugins managing multiple primary packages
|
||||
|
||||
`@nx/jest` manages `jest`, `ts-jest`, `@types/jest`. `@nx/eslint` manages `eslint`, `@typescript-eslint/parser`, `@typescript-eslint/eslint-plugin`, `eslint-config-prettier`. The canonical wrapper signature takes one package; with multiple, decisions are needed:
|
||||
|
||||
- **Gate on the primary only** when the others are peer-locked (e.g., angular's strategy with `@angular/core` covering `@angular/cli`, `@angular/ssr`, etc.). This is sufficient when the siblings' peer-deps tie them to the primary's major.
|
||||
- **Gate on each independently** when the siblings can be installed at any major regardless of the primary (typescript-eslint pair vs eslint; ts-jest vs jest). In that case, the wrapper makes multiple `assertSupportedPackageVersion` calls in sequence:
|
||||
|
||||
```ts
|
||||
export function assertSupportedJestVersion(tree: Tree): void {
|
||||
assertSupportedPackageVersion(tree, 'jest', minSupportedJestVersion);
|
||||
// ts-jest is independent — declare and assert it separately.
|
||||
assertSupportedPackageVersion(tree, 'ts-jest', minSupportedTsJestVersion);
|
||||
}
|
||||
```
|
||||
|
||||
When in doubt: read each sibling's `peerDependencies` block at the version range being supported. If it pins the primary, it's covered by the primary's gate. If it doesn't (or pins something else), it needs its own.
|
||||
|
||||
## Skip writing the install constant when the package is already detected
|
||||
|
||||
Init generators that add the third-party package to `package.json` should NOT overwrite an already-installed minor/patch. The `keepExistingVersions: true` flag handles this at the `addDependenciesToPackageJson` level. But for code paths that compute the version to write (e.g., picking the major-specific value from `versionMap`), the rule is the same: read what's installed first; only write the fresh-install constant when nothing is detected.
|
||||
|
||||
Reference: `packages/cypress/src/generators/init/init.ts` `updateDependencies` — calls `getInstalledCypressVersion(tree)` first, then routes through `versions(tree)` which short-circuits to existing-version paths. The `keepExistingVersions ?? true` flag at the `addDependenciesToPackageJson` call site is the final safety net.
|
||||
|
||||
## The versions module
|
||||
|
||||
Path: `packages/<plugin>/src/utils/versions.ts`.
|
||||
|
||||
### Required exports
|
||||
|
||||
```ts
|
||||
// Plain string, no caret. Used as the floor for assertSupportedPackageVersion.
|
||||
export const minSupportedCypressVersion = '13.0.0';
|
||||
|
||||
// Fresh-install constants — may be HIGHER than minSupported when the feature
|
||||
// surface at the floor is incomplete. Playwright peer is ^1.36.0 but
|
||||
// fresh-install is ^1.37.0 so blob reporter + merge-reports work out of the
|
||||
// box.
|
||||
export const playwrightVersion = '^1.37.0';
|
||||
|
||||
// Optional: feature-gate thresholds for runtime/executor code.
|
||||
export const minPlaywrightVersionForBlobReports = '1.37.0';
|
||||
```
|
||||
|
||||
### Stable deps stay top-level; per-major-varying deps go in the bundle
|
||||
|
||||
A plugin typically manages one primary package whose version map drives several siblings. Deps that vary per major go into a typed bundle; deps that are version-stable stay as plain `export const`s.
|
||||
|
||||
```ts
|
||||
// Stable across all supported majors of the primary → plain exports.
|
||||
export const viteVersion = '^8.0.0';
|
||||
export const jsdomVersion = '^27.1.0';
|
||||
export const vitePluginReactVersion = '^6.0.0';
|
||||
|
||||
// Vary with the primary's major → bundle.
|
||||
export const vitestVersion = '~4.1.0';
|
||||
export const vitestCoverageV8Version = '~4.1.0';
|
||||
export const vitestCoverageIstanbulVersion = '~4.1.0';
|
||||
|
||||
type VitestVersions = {
|
||||
vitestVersion: string;
|
||||
vitestCoverageV8Version: string;
|
||||
vitestCoverageIstanbulVersion: string;
|
||||
};
|
||||
|
||||
// latestVersions reuses the top-level exports so import { vitestVersion }
|
||||
// stays valid for the fresh-install path while versions(tree).vitestVersion
|
||||
// is the route-aware version.
|
||||
const latestVersions: VitestVersions = {
|
||||
vitestVersion,
|
||||
vitestCoverageV8Version,
|
||||
vitestCoverageIstanbulVersion,
|
||||
};
|
||||
|
||||
type CompatVersions = 3;
|
||||
const versionMap: Record<CompatVersions, VitestVersions> = {
|
||||
3: {
|
||||
vitestVersion: '^3.0.0',
|
||||
vitestCoverageV8Version: '^3.0.5',
|
||||
vitestCoverageIstanbulVersion: '^3.0.5',
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
**Do not** keep per-major aliases like `vitestV3Version = '^3.0.0'` alongside the bundle — they duplicate the map entries and drift over time. See `anti-patterns.md` §15.
|
||||
|
||||
### The `versions(tree)` function
|
||||
|
||||
Falls through to latest on unknown majors — no `switch + throw default:`.
|
||||
|
||||
```ts
|
||||
export function versions(tree: Tree): VitestVersions {
|
||||
const installedVitestVersion = getInstalledVitestVersion(tree);
|
||||
if (!installedVitestVersion) {
|
||||
return latestVersions;
|
||||
}
|
||||
const vitestMajorVersion = major(installedVitestVersion);
|
||||
return versionMap[vitestMajorVersion as CompatVersions] ?? latestVersions;
|
||||
}
|
||||
```
|
||||
|
||||
### The `getInstalled<Pkg>Version(tree?)` helper
|
||||
|
||||
Optional `tree` parameter — with tree, reads declared from `package.json` via `getDeclaredPackageVersion` (handles dist-tag normalization, semver cleaning); without tree, routes through `getInstalledPackageVersion` from `@nx/devkit/internal` (FS resolution via `getNxRequirePaths()`).
|
||||
|
||||
**Do not open-code the tree-branch.** `getDeclaredPackageVersion` already centralizes the dist-tag list (`isNonSemverDistTag`) and the `clean(v) ?? coerce(v)?.version ?? null` chain (`normalizeSemver`). Local re-implementations drift when devkit's constants change. See `anti-patterns.md` §1.
|
||||
|
||||
```ts
|
||||
import { type Tree } from '@nx/devkit';
|
||||
import {
|
||||
getDeclaredPackageVersion,
|
||||
getInstalledPackageVersion,
|
||||
} from '@nx/devkit/internal';
|
||||
import { major } from 'semver';
|
||||
|
||||
export function getInstalledVitestVersion(tree?: Tree): string | null {
|
||||
if (!tree) {
|
||||
return getInstalledPackageVersion('vitest');
|
||||
}
|
||||
return getDeclaredPackageVersion(tree, 'vitest');
|
||||
}
|
||||
|
||||
export function getInstalledVitestMajorVersion(tree?: Tree): number | null {
|
||||
const installedVitestVersion = getInstalledVitestVersion(tree);
|
||||
return installedVitestVersion ? major(installedVitestVersion) : null;
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/cypress/src/utils/versions.ts`, `packages/rspack/src/utils/version-utils.ts`, `packages/rsbuild/src/utils/version-utils.ts`.
|
||||
|
||||
#### Dist-tag semantics — third arg (`latestKnownVersion`)
|
||||
|
||||
`getDeclaredPackageVersion(tree, pkg, latestKnownVersion?)`'s third arg falls back to `normalizeSemver(latestKnownVersion)` whenever the declared range can't be normalized to semver — both "package missing from `package.json`" AND "package declared as a dist tag (`latest` / `next`)". The helper does not distinguish the two cases.
|
||||
|
||||
**Default to omitting the third arg.** The wrapper returns `null` for both "missing" and "dist tag"; consumers that want `?? latestVersions` semantics should encode it at the call site (rspack/rsbuild precedent), not globally in the helper. Passing the third arg makes the helper claim the package is "installed at the fresh-install constant" even when nothing is declared — which silently disables init generators' "add the package" branches.
|
||||
|
||||
When a consumer specifically needs to distinguish "missing" from "dist tag", use `getDependencyVersionFromPackageJson` from `@nx/devkit` to inspect the raw declared string.
|
||||
|
||||
## Generator entry points
|
||||
|
||||
The assert goes in the function that does the actual work — first statement of the function body, before any other tree access or sub-generator call. (The assert itself reads the tree, of course; the rule is that nothing else in the generator runs against an unsupported version.)
|
||||
|
||||
### Plugins with a `<gen>` / `<gen>Internal` split (cypress, playwright)
|
||||
|
||||
The public wrapper merges defaults and delegates. Assert lives in `*Internal`:
|
||||
|
||||
```ts
|
||||
// Public wrapper — no assert, just default merging.
|
||||
export async function cypressInitGenerator(tree: Tree, options: Schema) {
|
||||
return cypressInitGeneratorInternal(tree, { addPlugin: false, ...options });
|
||||
}
|
||||
|
||||
// Working function — assert is the first statement.
|
||||
export async function cypressInitGeneratorInternal(
|
||||
tree: Tree,
|
||||
options: Schema
|
||||
) {
|
||||
assertSupportedCypressVersion(tree);
|
||||
|
||||
updateProductionFileset(tree);
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/cypress/src/generators/init/init.ts`, `packages/playwright/src/generators/init/init.ts`.
|
||||
|
||||
### Plugins with a single-function generator (angular)
|
||||
|
||||
No wrapper/internal split. The function itself asserts:
|
||||
|
||||
```ts
|
||||
export async function angularInitGenerator(tree: Tree, options: Schema) {
|
||||
assertSupportedAngularVersion(tree);
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/angular/src/generators/init/init.ts`.
|
||||
|
||||
### Double-asserts are established convention, not an edge case
|
||||
|
||||
When `configurationGenerator` calls `initGenerator` internally, both call their respective `assertSupportedXVersion`. This is the angular precedent (29 `generators.json` entries → 58 assert call sites). The assert is idempotent (one tree read + one semver comparison) and the parameterized floor spec treats every entry point as independent — both must throw on sub-floor. Don't refactor away.
|
||||
|
||||
## User-pin preservation
|
||||
|
||||
### `addDependenciesToPackageJson` call sites
|
||||
|
||||
Every call from a generator (NOT a migration) must pass `keepExistingVersions: true` as the fifth positional argument or via the `?? true` pattern.
|
||||
|
||||
```ts
|
||||
// Pattern A — explicit at the call site
|
||||
addDependenciesToPackageJson(
|
||||
tree,
|
||||
{},
|
||||
{ 'eslint-plugin-cypress': pkgVersions.eslintPluginCypressVersion },
|
||||
undefined,
|
||||
true
|
||||
);
|
||||
|
||||
// Pattern B — driven by schema (init generators only)
|
||||
addDependenciesToPackageJson(
|
||||
tree,
|
||||
{},
|
||||
devDependencies,
|
||||
undefined,
|
||||
options.keepExistingVersions ?? true
|
||||
);
|
||||
```
|
||||
|
||||
Reference: `packages/cypress/src/generators/init/init.ts`, `packages/cypress/src/utils/add-linter.ts`, `packages/angular/src/generators/add-linting/lib/add-angular-eslint-dependencies.ts`.
|
||||
|
||||
### init schema
|
||||
|
||||
```json
|
||||
{
|
||||
"keepExistingVersions": {
|
||||
"type": "boolean",
|
||||
"x-priority": "internal",
|
||||
"description": "Keep existing dependencies versions",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Reference (on master): `packages/cypress/src/generators/init/schema.json`, `packages/playwright/src/generators/init/schema.json`. (`@nx/vitest` follows the same pattern in its open PR — verify via `gh pr diff 35671`.)
|
||||
|
||||
## Migrations.json gates
|
||||
|
||||
Three categories of migration:
|
||||
|
||||
| Category | Touches | `requires` |
|
||||
| -------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| Nx-only | `nx.json`, executor options, generator defaults | none |
|
||||
| Codemod | source files / config tied to a third-party major | `{ "<pkg>": ">=N <N+1" }` (or open upper bound for legacy-cleanup codemods) |
|
||||
| `packageJsonUpdates` cross-major | bumps `<pkg>` from major N to N+1 | `{ "<pkg>": ">=N.0.0 <(N+1).0.0" }` (source-major gate) |
|
||||
| `packageJsonUpdates` same-major | bumps minor/patch | none required |
|
||||
|
||||
### Sibling packages
|
||||
|
||||
Ecosystem-locked siblings whose peer-on-the-primary covers them: no separate `requires`. Examples in Angular: `@angular/cli`, `@angular/ssr`, `@angular-devkit/build-angular` (from v20+, NOT v19).
|
||||
|
||||
Independent siblings: each needs its own `requires` entry. Examples in Angular: `@ngrx/*`, `@angular-eslint/*`, `zone.js`, `jest-preset-angular`.
|
||||
|
||||
### Reference examples
|
||||
|
||||
- `packages/angular/migrations.json` `20.2.0-module-federation`, `22.2.0`, `22.6.0-module-federation` — Module Federation entries gating on `@module-federation/enhanced` source range. Added in `#35587`.
|
||||
- `@nx/vitest`'s `update-22-1-0` and `update-22-3-2` migrations gating on `vitest: ">=4.0.0"` (Vitest-4-specific AI-instructions) — pattern proposed in open PR `#35671`. Inspect via `gh pr diff 35671 --repo nrwl/nx -- packages/vitest/migrations.json`.
|
||||
- `packages/angular/migrations.json` `update-unit-test-runner-option` — Nx-only migration with the over-gating `@angular/core` `requires` **removed** in `#35587`.
|
||||
|
||||
## Test specs
|
||||
|
||||
### Parameterized floor spec (one per plugin)
|
||||
|
||||
Path: `packages/<plugin>/src/utils/all-generators-enforce-floor.spec.ts`.
|
||||
|
||||
```ts
|
||||
import { assertGeneratorsEnforceVersionFloor } from '@nx/devkit/internal-testing-utils';
|
||||
import { join } from 'node:path';
|
||||
|
||||
describe('@nx/<plugin> generators enforce supported version floor', () => {
|
||||
assertGeneratorsEnforceVersionFloor({
|
||||
packageRoot: join(__dirname, '..', '..'),
|
||||
packageName: '<pkg>',
|
||||
subFloorVersion: '~<floor-minus-one>',
|
||||
// Required only when a generator must run below the floor by design.
|
||||
// excludeGenerators: ['migrate-to-cypress-11'],
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
Pick `subFloorVersion` such that `lt(coerce(it).version, floor)` is true. No pre-release identifiers. Reference values used in the repo: `~18.2.0` (angular, v19 floor), `~12.17.0` (cypress, v13 floor), `~1.35.0` (playwright, v1.36 floor).
|
||||
|
||||
### Plugin assert spec (optional, one per plugin)
|
||||
|
||||
Path: `packages/<plugin>/src/utils/assert-supported-<pkg>-version.spec.ts`.
|
||||
|
||||
`assertSupportedPackageVersion` is already fully tested in `@nx/devkit`,
|
||||
so a per-plugin spec mostly re-tests the shared helper. The early
|
||||
compliance PRs (`#35587` angular onward) ship one for symmetry, but it
|
||||
isn't required. If you add one, five canonical cases is the shape used:
|
||||
|
||||
```ts
|
||||
describe('assertSupportedCypressVersion', () => {
|
||||
it('throws when cypress is below the supported floor');
|
||||
it('does not throw when cypress is not installed (fresh-install path)');
|
||||
it('does not throw when cypress is `latest`');
|
||||
it('does not throw when cypress is `next`');
|
||||
it('does not throw when cypress is within the supported window');
|
||||
});
|
||||
```
|
||||
|
||||
Reference: `packages/angular/src/utils/assert-supported-angular-version.spec.ts` (originally landed in `#35587`).
|
||||
|
||||
### Test message matching
|
||||
|
||||
Use substring match on the error message:
|
||||
|
||||
```ts
|
||||
.rejects.toThrow(`Unsupported version of \`${packageName}\` detected`)
|
||||
```
|
||||
|
||||
Not a hand-rolled RegExp (avoid escape bugs). Reference: see how the shared `assertGeneratorsEnforceVersionFloor` itself does the match — search for `Unsupported version of` in `packages/nx/src/internal-testing-utils/assert-generators-enforce-version-floor.ts`.
|
||||
|
||||
## Standardized error format
|
||||
|
||||
```
|
||||
Unsupported version of `<pkg>` detected.
|
||||
|
||||
Installed: <declared-range-as-written-in-package.json>
|
||||
Supported: >= <floor>
|
||||
|
||||
Update `<pkg>` to <floor> or higher.
|
||||
```
|
||||
|
||||
Two notes:
|
||||
|
||||
- The `Installed:` line preserves the **original declared range** (e.g., `~18.2.0`), not the cleaned semver. `assertSupportedPackageVersion` passes `declared` through to `throwForUnsupportedVersion`.
|
||||
- Do not add an "above ceiling" branch to this message. Above-ceiling is silent fallthrough.
|
||||
|
||||
## Peer dep alignment
|
||||
|
||||
### What belongs in `peerDependencies`
|
||||
|
||||
The test: _would the plugin still work if this package were absent from the workspace, with the plugin's code paths unchanged?_
|
||||
|
||||
A package is required-peer if **any** of these is true:
|
||||
|
||||
- The plugin's TypeScript imports / `require`s it (executor, preset, runtime helper).
|
||||
- The plugin's executor spawns its CLI binary (`spawn('cypress')`, etc.).
|
||||
- The plugin's inferred plugin (`createNodes`/`createNodesV2`) **emits a target whose `command` invokes the package's CLI** (e.g., `command: 'rspack build'` → `@rspack/cli` is required). The `externalDependencies: ['<pkg>']` declaration in such targets is itself an admission of the runtime dependency.
|
||||
|
||||
A package is **not** required-peer when:
|
||||
|
||||
- The plugin's generator installs it into the user's workspace for the user to consume independently, and no plugin code (TypeScript, executor binary spawn, or inferred-plugin emitted command) ever invokes it. Example: ESLint plugins written into the user's eslintrc — `@nx/cypress` installs `eslint-plugin-cypress`, but its lint executor uses generic ESLint loading; the cypress plugin is loaded by ESLint per the user's config, not by `@nx/cypress`. Example: `@types/*` packages installed for the user's TS compilation but never imported by plugin code.
|
||||
|
||||
**Ecosystem-signal peer** (Angular's full `@angular/*` peer list) → judgment call, not a compliance requirement. Documents lockstep compatibility but isn't enforced by the multi-version rules.
|
||||
|
||||
### Required vs. optional peer
|
||||
|
||||
Most Nx plugin peers should be **optional** (`peerDependenciesMeta: { "<pkg>": { "optional": true } }`):
|
||||
|
||||
- Required peer: every user of the plugin needs this package, regardless of which surface they use. Example: `@angular-devkit/core`, `rxjs` in `@nx/angular` — every Angular Nx workspace uses them.
|
||||
- **Optional peer (the common case for inferred-plugin / executor surfaces):** the package is only needed when the user opts into a specific surface — an executor they have to write into `project.json`, an inferred plugin gated on the presence of a config file, a preset that auto-injects. Users who don't use that surface shouldn't see an unmet-peer warning. Examples: `@playwright/test` in `@nx/playwright`, `cypress` in `@nx/cypress`, `vitest` / `vite` in `@nx/vitest`, `@angular/build` / `@angular-devkit/build-angular` / `ng-packagr` in `@nx/angular`.
|
||||
|
||||
For `@rspack/cli` / `@rspack/core` in `@nx/rspack`: both surfaces (executor, inferred plugin) are gated — executor opt-in via `project.json`, inferred plugin gated on `rspack.config.{ts,js}` presence. Compliance fix should peer-declare both with `optional: true`.
|
||||
|
||||
Concrete examples:
|
||||
|
||||
| Package | Plugin | Plugin invokes? | Peer? | Optional? |
|
||||
| ----------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------- |
|
||||
| `cypress` | `@nx/cypress` | yes (executor spawns binary; inferred plugin emits `cypress run` commands) | **yes** | optional (executor + inferred plugin are both opt-in) |
|
||||
| `@playwright/test` | `@nx/playwright` | yes (executor + preset + inferred plugin) | **yes** | optional |
|
||||
| `vitest` | `@nx/vitest` | yes (executor + inferred plugin emits `vitest` commands) | **yes** | optional |
|
||||
| `@rspack/cli` | `@nx/rspack` | yes — inferred plugin emits `command: 'rspack build'` (`packages/rspack/src/plugins/plugin.ts:182,196`). Not imported in TS, but invoked via emitted CLI target. | **yes** | optional (both surfaces gated) |
|
||||
| `@angular-devkit/core` | `@nx/angular` | yes (used by every Angular Nx workspace) | **yes** | **not optional** |
|
||||
| `@angular/build` | `@nx/angular` | yes (only when user uses the @angular/build builder) | **yes** | optional |
|
||||
| `eslint-plugin-cypress` | `@nx/cypress` | no (generator writes it into user's eslintrc; ESLint loads it, not the plugin) | **no** | n/a |
|
||||
| `@types/node` | various | no (generator install only; types are build-time) | **no** | n/a |
|
||||
|
||||
### Range / version alignment
|
||||
|
||||
For packages that ARE peer-declared: the range must match the install lanes the code ships. If the code has no `isV1Installed` branch and no v1 entry in `versionMap`, do not list `^1.0.0` in the peer range.
|
||||
|
||||
Reference: open PR `#35671` (`@nx/vitest`) drops `^1.0.0` from the `vitest` peer range because there is no v1 install lane. Inspect via `gh pr diff 35671 --repo nrwl/nx -- packages/vitest/package.json`. Verify state — may have merged or closed since.
|
||||
|
||||
## Executor / runtime feature gating
|
||||
|
||||
Features introduced after the floor must gate at call time on the installed version, not on the floor. Use `getInstalledPackageVersion` + `lt` from `semver`.
|
||||
|
||||
```ts
|
||||
import { getInstalledPackageVersion } from '@nx/devkit/internal';
|
||||
import { lt } from 'semver';
|
||||
import { minPlaywrightVersionForBlobReports } from './versions';
|
||||
|
||||
const installed = getInstalledPackageVersion('@playwright/test');
|
||||
if (installed && lt(installed, minPlaywrightVersionForBlobReports)) {
|
||||
throw new Error(
|
||||
`The "@nx/playwright:merge-reports" executor requires "@playwright/test" version ${minPlaywrightVersionForBlobReports} or greater (the version that introduced the "blob" reporter and the "merge-reports" CLI). You are currently using version ${installed}.`
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Reference: `packages/playwright/src/executors/merge-reports/merge-reports.impl.ts`, `packages/playwright/src/utils/preset.ts`. Both added in `#35642`.
|
||||
|
||||
Two distinct cases:
|
||||
|
||||
- **Auto-injected feature** (preset's auto-blob in CI): skip injection silently when installed < threshold. Only throw when the user explicitly opted in (`generateBlobReports: true`) on an unsupported version.
|
||||
- **Direct invocation** (executor CLI subcommand): throw immediately with a clear "requires >= X.Y.Z (the version that introduced …)" message.
|
||||
|
||||
## File-layout summary
|
||||
|
||||
For plugin `@nx/<plugin>` managing `<pkg>` with floor `X.Y.Z`:
|
||||
|
||||
```
|
||||
packages/<plugin>/
|
||||
src/
|
||||
utils/
|
||||
versions.ts # add minSupportedXVersion
|
||||
assert-supported-<pkg>-version.ts # NEW — 7-line wrapper
|
||||
assert-supported-<pkg>-version.spec.ts # OPTIONAL — 5 cases (mostly re-tests shared helper)
|
||||
all-generators-enforce-floor.spec.ts # NEW — parameterized
|
||||
generators/
|
||||
<each>/
|
||||
<each>.ts # assert as first statement
|
||||
init/
|
||||
schema.json # keepExistingVersions default: true
|
||||
init.ts # keepExistingVersions ?? true
|
||||
executors/ # feature-gate via getInstalledPackageVersion
|
||||
plugins/ # same
|
||||
migrations.json # tighten / remove `requires` gates per audit
|
||||
package.json # align peer; add "semver": "catalog:" if newly used
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Code-level verification (review-mode lens)
|
||||
|
||||
In review mode, walk these markers against the diff.
|
||||
|
||||
Output rules:
|
||||
|
||||
- **Inline categories are `[blocker]` and `[non-blocker]` only.** No "open question," "ask," or other ad-hoc tags. Author-directed questions emerge from non-blocker findings and surface in the closing "Open questions for author" block.
|
||||
- **For each blocker / non-blocker:** anchor at `file:line` and cite which reference PR / file demonstrates the correct pattern. Cross-reference `anti-patterns.md` when the finding matches a numbered pattern.
|
||||
- **Sections without findings get a single summary line**, not a per-file enumeration. `"Pass — all 7 generator entries assert at first statement"` is right; listing seven file:lines is wrong. Reviewer time is spent on actionable items; passing checks should not eat reading budget.
|
||||
- **Produce the verdict block** at the end (see §"Verdict template"). The block is the skimmable index — produce it, don't substitute a free-form summary.
|
||||
|
||||
Scope:
|
||||
|
||||
- **In scope:** the diff's code, configs, schemas, migrations, and **in-codebase documentation that describes runtime behavior** (e.g., `.mdoc` / `.md` files under `astro-docs/` or `docs/` that claim how the plugin behaves). A docs claim that contradicts the code is a correctness issue and belongs here.
|
||||
- **Out of scope:** PR title, PR body shape, commit message format, related-issues section, branch naming. Defer to the user's PR/commit conventions (loaded globally from `~/.claude/memory/workflow/git/`). Don't flag PR/commit shape in this skill's review output.
|
||||
|
||||
## 1. Peer dep & install constants
|
||||
|
||||
- [blocker] `package.json` peer dep range matches the install lanes implemented in `versions.ts`. No phantom version claims. → If `versionMap` has no v1 entry, peer must not list `^1.0.0`. Reference correction: `#35671` (`@nx/vitest`). Anti-pattern: §8.
|
||||
- [blocker] **Declared floor matches the effective floor.** Grep every `import` / `require` from the third-party package in plugin code. If any imported API only exists at version >N, the declared floor must be >=N. Anti-pattern: §16. Reference correction: `#35671` second commit raised vitest from v2 to v3 after catching a `getRelevantTestSpecifications` import (v3+ only).
|
||||
- [blocker] Fresh-install constant exposes the **full feature surface**, not just the peer floor. → Playwright peer stayed `^1.36.0` but fresh-install moved to `^1.37.0` because blob reporter + `merge-reports` CLI both require 1.37. Reference: `#35642` `packages/playwright/src/utils/versions.ts`.
|
||||
- [blocker] No per-major version aliases (`<pkg>V3Version`, `<pkg>V4Version`, etc.) alongside a `versionMap` — pick one source of truth. Anti-pattern: §15. Reference: `#35671`'s third commit dropped these aliases.
|
||||
- [blocker] `versions.ts` exports `minSupportedXVersion = 'X.Y.Z'` as a plain string (no caret, no range markers). The wrapper passes this verbatim to `assertSupportedPackageVersion`.
|
||||
- [blocker] `versionMap[major]` lookup is `versionMap[major] ?? latestVersions`. No `switch + throw default:` or other above-ceiling throw. Anti-pattern: §2. Reference correction: `#35670` (`@nx/cypress` `versions()` rewrite).
|
||||
- [blocker] Every third-party package the **plugin invokes at runtime** has a `peerDependencies` entry. "Invokes" covers: (a) TypeScript `import`/`require`, (b) executor spawning the package's CLI binary, (c) inferred-plugin (`createNodes`/`createNodesV2`) emitting a target whose `command` invokes the package's CLI (the `externalDependencies: ['<pkg>']` field on such targets confirms the dependency). See §"Peer dep alignment" for the full categorization.
|
||||
- **Don't flag** packages the plugin's generator installs into the user's workspace for the user to consume independently, with no plugin codepath invoking them (e.g., ESLint plugins like `eslint-plugin-cypress` that ESLint loads from the user's eslintrc; `@types/*` packages).
|
||||
- Plugins flagged at time of writing for actually-invoked packages without a peer entry: `@nx/webpack`, `@nx/rollup`, `@nx/angular-rspack-compiler` (primary listed under `dependencies`); `@nx/jest`, `@nx/nest`, `@nx/module-federation`, `@nx/react`, `@nx/vue`, `@nx/expo`, `@nx/react-native`, `@nx/node`, `@nx/js` (verify per plugin — TS imports, binary spawns, AND inferred-plugin emitted commands all count).
|
||||
- [blocker] Peers that are only used when the user opts into a specific surface (executor opt-in, inferred plugin gated on config file presence, opt-in preset) are declared **optional** via `peerDependenciesMeta: { "<pkg>": { "optional": true } }`. Pattern is established across reference plugins — `@playwright/test`, `cypress`, `vitest`, `vite`, `@angular/build`, `ng-packagr` are all optional. Required-non-optional peers (`@angular-devkit/core`, `rxjs` in `@nx/angular`) are reserved for packages every workspace using the plugin needs. See §"Required vs. optional peer".
|
||||
- [non-blocker] If the PR introduces `semver` usage in the plugin, `package.json` `dependencies` lists `"semver": "catalog:"`. Reference: `#35642` added it to `packages/playwright/package.json`.
|
||||
|
||||
## 2. Generator entry points
|
||||
|
||||
- [blocker] **Every** entry in `generators.json` has its working function calling `assertSupported<Pkg>Version(tree)` as the **first statement** — before any tree reads, writes, or sub-generator calls. For wrapper/internal-split plugins (cypress, playwright): assert is in `*Internal`. For single-function generators (angular): in the function itself. Anti-pattern: §14.
|
||||
- [blocker] Plugin wrapper file `assert-supported-<pkg>-version.ts` imports `assertSupportedPackageVersion` from `@nx/devkit/internal`. No direct call to `throwForUnsupportedVersion`. No bespoke `throwBelowFloor` / `throwAboveWindow` / `assertVersion` / local `cleanVersion = clean(v) ?? coerce(v)?.version` helpers (use `normalizeSemver` / `getInstalledPackageVersion` / `getDeclaredPackageVersion`). Anti-pattern: §1. Concrete example: PR `#35676` introduces a local `cleanVersion` and `getInstalledRsbuildVersionRuntime` — both already exist as shared helpers.
|
||||
- [blocker] If `all-generators-enforce-floor.spec.ts` uses `excludeGenerators`, each excluded name has a code comment explaining why the generator must run sub-floor (e.g., `migrate-to-cypress-11` lifts v8–v10 workspaces onto v11).
|
||||
- [non-blocker] Double-assert chains (`configurationInternal` calls `initInternal`, both assert) are OK. Idempotent. Don't refactor away.
|
||||
|
||||
## 3. Generator outputs
|
||||
|
||||
- [blocker] Templates the generator writes (project files, configs, schemas) compile and run on every major in the support window. Verify with a quick mental walk: for each template referenced from the generator, identify any per-major-version conditional and confirm it's accurate.
|
||||
- [blocker] Generated `project.json` target shape (executor, options, schema) is valid on every supported major. If the executor's option schema differs across the support window, the generator branches or uses the union shape.
|
||||
- [blocker] Default option values are valid on every supported major. A default that's only valid above a specific major must be conditional.
|
||||
- [blocker] Version map covers every managed third-party dep. If the runtime later branches on a sibling's version (e.g., `@vitest/ui`), the version map must have an entry for that sibling per major — no gaps where the generator picks a constant the runtime then can't reconcile.
|
||||
- [blocker] Generator schema accepts the **union of options across the support window**. Options removed in a newer major still validate at schema level (with description-notice); runtime throws when inapplicable on the installed major. See `gotchas.md` §"Schema-level deprecated-option stubs with runtime throws".
|
||||
|
||||
## 4. `keepExistingVersions` (user-pin preservation)
|
||||
|
||||
- [blocker] Every `addDependenciesToPackageJson` call from a **generator** passes `keepExistingVersions: true` (positionally as the 5th arg) or `options.keepExistingVersions ?? true`.
|
||||
- [blocker] `init/schema.json` has `"keepExistingVersions": { "default": true }`. Not `false`. Not absent. **Known gap:** `@nx/angular`'s init schema currently has `default: false` and was NOT addressed in `#35587` — flagging in a non-angular PR is correct; fixing in passing in an angular PR is also correct. Anti-pattern: §4.
|
||||
- [blocker] Linter / sub-generator helpers (`add-linter.ts`, `add-angular-eslint-dependencies.ts`, equivalents) also pass `true`.
|
||||
- [non-blocker] If both schema `"default": true` AND `options.keepExistingVersions ?? true` are present, that's two sources of truth. Anti-pattern: §12.
|
||||
- **Migration generators are exempt.** Do not flag missing flags in code under `src/migrations/`.
|
||||
|
||||
## 5. `migrations.json` gates
|
||||
|
||||
- [blocker] Every `packageJsonUpdates` entry that bumps across a major version has `requires: { "<pkg>": ">=N.0.0 <(N+1).0.0" }`. Source-major gate, not target. Anti-pattern: §6. Reference: `#35587` Module Federation entries.
|
||||
- **Read the actual range strings; don't tick this by counting split entries.**
|
||||
- [non-blocker / ask author] One-sided gates (`<X` with no lower bound, or `>=Y` with no upper bound) may be intentional or accidental. Legitimate cases: legacy-cleanup codemods that should apply on every source major below the target; a v0→v1 bridge where every v0.x workspace should migrate; bumping a package introduced at vN from `undefined`. Illegitimate cases: a v1→v2 bump expressed as `<2.x` would fire for v0 workspaces too; a `>=N` with no upper bound would fire for future majors. **When you see a one-sided gate, ask the author to confirm intent** — don't auto-flag as blocker.
|
||||
- [blocker] Codemod migrations that only make sense at/above a specific third-party major have a `requires` entry. Open upper bound is intentional when the codemod cleans up legacy flags. Runtime per-package guards (`gte`/`lt` inside the migration body) are NOT a substitute for `requires`.
|
||||
- [blocker] **Nx-only migrations have NO `requires` gate.** A migration that only writes to `nx.json`, executor options, or generator defaults applies regardless of third-party version. Anti-pattern: §5. Reference correction: `#35587` removed the over-gating `@angular/core: >=21.0.0` from `update-unit-test-runner-option`.
|
||||
- [blocker] For independent siblings (Angular: `@ngrx/*`, `@angular-eslint/*`, `zone.js`, `jest-preset-angular`), gating on the primary's major is **not sufficient** — each needs its own `requires` entry. Anti-pattern: §7. Verify pairing by reading the sibling's `peerDependencies` at the version range being bumped from.
|
||||
- [blocker] A single `packageJsonUpdates` entry must not mix mutually-exclusive cross-major bumps under one `requires` (AND-semantics). Split into separate entries each with its own gate. Concrete example: React PR's `22.3.4` entry mixed `react-router 7.12.0` (cross-major) with `react-router-dom 6.30.3` (v6 patch) — must split.
|
||||
- [non-blocker] `incompatibleWith` is not a substitute for `requires`. Anti-pattern: §10. If you see `incompatibleWith` standing in for a source-major gate, ask for a `requires` instead.
|
||||
- [non-blocker] Sibling `packageJsonUpdates` entries within the same block that depend on a peer's post-bump version are fine — tier-1 chaining evaluates against post-bump state. Reference: Storybook 21.2.0 chains on the prior 21.1.0 bump.
|
||||
- [non-blocker] Pre-floor `packageJsonUpdates` entries targeting source majors below the current support floor are intentionally retained for users on older Nx versions. Don't _add_ a bridge entry without explicit decision, and don't _remove_ a legitimately-pre-floor entry mid-audit.
|
||||
|
||||
## 6. Executor / runtime / inferred-plugin feature gating
|
||||
|
||||
- [blocker] Executor code that invokes a CLI subcommand or uses an API introduced after the floor calls `getInstalledPackageVersion('<pkg>')` + `lt(installed, threshold)` from `semver` and throws a clear "requires >= X.Y.Z (the version that introduced …)" message. Reference: `packages/playwright/src/executors/merge-reports/merge-reports.impl.ts` (`#35642`).
|
||||
- [blocker] Preset / config builders that auto-inject feature-version-coupled config skip injection silently when installed < threshold, and only throw when the user **explicitly** opted in on an unsupported version. Reference: `packages/playwright/src/utils/preset.ts` (`#35642` — `generateBlobReports` logic).
|
||||
- [blocker] **Inferred plugins** (`createNodes`/`createNodesV2`) parse configs across every major in the support window. The plugin emits the same target shape regardless of the installed major (or branches if shapes diverge). Don't hardcode helper imports against one major.
|
||||
- [blocker] **Above-ceiling is silent fallthrough.** No warn, no throw, no branch. Anti-pattern: §2.
|
||||
- [non-blocker] Executors don't enforce the plugin floor. Floor enforcement is generator-only. Don't suggest adding an executor-level floor assert unless the user asks.
|
||||
- [non-blocker] `require('<pkg>')` for optional peers should live inside the function body, after version detection. Anti-pattern: §9.
|
||||
|
||||
## 7. Tests
|
||||
|
||||
- [blocker] `all-generators-enforce-floor.spec.ts` exists at `packages/<plugin>/src/utils/all-generators-enforce-floor.spec.ts`, calls `assertGeneratorsEnforceVersionFloor` from `@nx/devkit/internal-testing-utils`. This is the parameterized spec that exercises every generator's floor assert.
|
||||
- [blocker] `subFloorVersion` is a semver range where `lt(coerce(it).version, floor)` is true. No pre-release identifiers. Reference values: `~18.2.0` (angular, v19 floor), `~12.17.0` (cypress, v13 floor), `~1.35.0` (playwright, v1.36 floor).
|
||||
- [non-blocker] Plugins establishing the pattern (`#35587` angular) ship a `assert-supported-<pkg>-version.spec.ts` with the 5 canonical cases (sub-floor / fresh-install / `latest` / `next` / in-range). The underlying `assertSupportedPackageVersion` already has full coverage in `@nx/devkit`, so the per-plugin spec largely re-tests the shared helper. Useful for symmetry across the PR series but not required — don't block on missing.
|
||||
- [non-blocker] Runtime/executor feature-gate throw tests are nice-to-have, not required — reference PRs (`#35587`, `#35642`, `#35670`) do not have them today.
|
||||
- [non-blocker] Error message matching uses substring (`toThrow('Unsupported version of \`<pkg>\` detected')`) instead of hand-rolled `RegExp`. Anti-pattern: §13.
|
||||
- [non-blocker] FS-side helper migrated to `getInstalledPackageVersion`; tree-side helper may stay inline. The two helpers' `null` vs. fallback semantics differ. Reference: `#35670` `packages/cypress/src/utils/versions.ts` rewrite.
|
||||
|
||||
## Open questions to raise (when missing from the PR / Linear task)
|
||||
|
||||
1. **Floor:** deliberate raise from the previous declared peer, or matching the existing peer? If raise: do sub-floor users get a `packageJsonUpdates` bridge or manual bump?
|
||||
2. **Peer-range tightening:** dropping a major because there's no install lane (legitimate, `#35671` pattern) or because tests fail (regression risk — investigate)?
|
||||
3. **`requires` removals on Nx-only migrations:** genuinely Nx-only, or sneaking through a third-party-touching change?
|
||||
4. **Pruned migrations gaps:** if floor is being raised by N+ majors and prior `packageJsonUpdates` entries were removed, do sub-floor users have any auto-bump path? `git log --all -- packages/<plugin>/migrations.json`.
|
||||
5. **Runtime feature gates:** threshold verified against third-party release notes, or guessed?
|
||||
6. **Sibling classification:** ecosystem-locked vs. independent. Read the sibling's `peerDependencies` at the bumped-from range. `@angular-devkit/build-angular` is the gotcha — peer-locked from v20+, NOT v19.
|
||||
7. **Cross-plugin coordination:** if the plugin pins a third-party that another plugin also manages (e.g., `@nx/cypress` pinning vite for cypress v13/v14+; `@nx/vite` supporting vite v5–v8), confirm the windows stay aligned. If `@nx/vite` drops v5, `@nx/cypress` carries an orphaned install lane.
|
||||
|
||||
## Verdict template
|
||||
|
||||
```
|
||||
Blockers: <N>
|
||||
Non-blockers: <N>
|
||||
|
||||
1. Peer dep & install constants: [pass | <findings>]
|
||||
2. Generator entry points: [pass | <findings>]
|
||||
3. Generator outputs: [pass | <findings>]
|
||||
4. keepExistingVersions: [pass | <findings>]
|
||||
5. Migration gates: [pass | <findings>]
|
||||
6. Executor / runtime / inferred-plugin: [pass | <findings>]
|
||||
7. Tests: [pass | <findings>]
|
||||
|
||||
Open questions for author: [list]
|
||||
|
||||
Scope drift vs. Linear task (if applicable):
|
||||
- Findings in task NOT addressed: <list>
|
||||
- Changes in PR NOT in task: <list>
|
||||
```
|
||||
@@ -0,0 +1,115 @@
|
||||
# Examples & references
|
||||
|
||||
Concrete files, commits, and PRs to grep when you need a model.
|
||||
|
||||
## Reference PRs (in order of arrival)
|
||||
|
||||
| PR | Plugin | Branch | State | Why notable |
|
||||
| -------- | ---------------- | ---------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `#35587` | `@nx/angular` | `nxc-4381` | merged | First compliance PR. Established `throwForUnsupportedVersion`, the `assertSupported*Version` wrapper pattern, the `all-generators-enforce-floor.spec.ts` shape, the MF `requires`-gate pattern, the Nx-only-migration over-gate removal pattern. |
|
||||
| `#35642` | `@nx/playwright` | `nxc-4398` | merged | Generalized the helpers into `version-floor.ts`/`installed-version.ts`. Added `assertGeneratorsEnforceVersionFloor` in `internal-testing-utils`. Established executor/runtime feature-gating pattern (blob reporter / `merge-reports`). Demonstrated the "fresh-install constant higher than peer floor" pattern. |
|
||||
| `#35670` | `@nx/cypress` | `nxc-4384` | merged | Established `excludeGenerators` in the shared test helper for intentional sub-floor migrators (`migrate-to-cypress-11`). Demonstrated `versions()` switch-to-fallthrough rewrite. Demonstrated keeping the tree-side inline helper while migrating only the FS side to the shared helper. |
|
||||
| `#35671` | `@nx/vitest` | `nxc-4408` | open at time of writing | Three commits. (1) Establishes "drop phantom peer-range claim" (removes `^1.0.0` from peer); migration `requires` tightening for Vitest-4-only AI-instructions migrations. (2) Raises floor v2 → v3 after audit catches `getRelevantTestSpecifications` import (v3+ API) — establishes the **effective-floor-vs-declared-floor** pattern (see `anti-patterns.md` §16). (3) Adopts the cypress version-resolution pattern (bundle-of-varying-deps `versions(tree)`, `getInstalled<Pkg>Version(tree?)`, no per-major aliases — see `anti-patterns.md` §15). To inspect: `gh pr view 35671 --repo nrwl/nx --json commits` then `gh pr diff 35671`. Verify state — may have merged or closed. |
|
||||
|
||||
Always verify state with `gh pr view <N> --repo nrwl/nx --json state` before citing — this table goes stale.
|
||||
|
||||
## Reference commits (for `git show` inspection)
|
||||
|
||||
When the same change exists as both a pre-squash branch commit AND a merged squash on master, prefer the merged squash — it's the authoritative final state. Pre-squash SHAs are listed because they're easier to read in isolation (smaller diffs) when investigating one specific aspect.
|
||||
|
||||
**Merged on master (authoritative):**
|
||||
|
||||
| SHA | Subject |
|
||||
| ------------ | ---------------------------------------------------------------------------- |
|
||||
| `75578724fa` | `cleanup(core): add throwForUnsupportedVersion util to @nx/devkit/internal` |
|
||||
| `484ce6e5d5` | `fix(angular): multi-version support compliance (#35587)` |
|
||||
| `78f908d015` | `cleanup(angular): adopt shared version-floor helpers` |
|
||||
| `e2ef134645` | `fix(testing): multi-version support compliance for @nx/playwright (#35642)` |
|
||||
| `5d8b1bab7e` | `cleanup(devkit): allow excluding generators from version floor test helper` |
|
||||
| `bc35b484e3` | `fix(testing): multi-version support compliance for @nx/cypress (#35670)` |
|
||||
|
||||
Pre-squash branch SHAs are available via `gh pr view <N> --json commits` even after the branch is deleted; useful when inspecting one specific aspect of a merged PR in isolation. Example:
|
||||
|
||||
```bash
|
||||
gh pr view 35642 --repo nrwl/nx --json commits | jq -r '.commits[] | "\(.oid[:10]) \(.messageHeadline)"'
|
||||
```
|
||||
|
||||
## Shared helpers — current locations
|
||||
|
||||
| File | Exports |
|
||||
| ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `packages/devkit/src/utils/version-floor.ts` | `throwForUnsupportedVersion` (internal-only), `assertSupportedPackageVersion` |
|
||||
| `packages/devkit/src/utils/installed-version.ts` | `getInstalledPackageVersion`, `getDeclaredPackageVersion`, `isNonSemverDistTag`, `normalizeSemver`, `NON_SEMVER_DIST_TAGS` |
|
||||
| `packages/devkit/internal.ts` | re-exports from above (this is `@nx/devkit/internal`) |
|
||||
| `packages/nx/src/internal-testing-utils/assert-generators-enforce-version-floor.ts` | `assertGeneratorsEnforceVersionFloor` |
|
||||
| `packages/devkit/internal-testing-utils.ts` | re-exports `assertGeneratorsEnforceVersionFloor` (this is `@nx/devkit/internal-testing-utils`) |
|
||||
|
||||
## Per-plugin compliant files (grep for the pattern)
|
||||
|
||||
### `@nx/angular` (most extensive — has the `supportedVersions` list pattern)
|
||||
|
||||
- `packages/angular/src/utils/assert-supported-angular-version.ts` — wrapper using `Math.min(...supportedVersions)`
|
||||
- `packages/angular/src/utils/assert-supported-angular-version.spec.ts` — the canonical 5-case spec
|
||||
- `packages/angular/src/utils/all-generators-enforce-floor.spec.ts` — the parameterized floor spec
|
||||
- `packages/angular/src/generators/add-linting/lib/add-angular-eslint-dependencies.ts` — `keepExistingVersions: true` pattern
|
||||
- `packages/angular/migrations.json` — MF `requires` gates and the over-gate removal
|
||||
|
||||
### `@nx/playwright` (the helpers were generalized here)
|
||||
|
||||
- `packages/playwright/src/utils/assert-supported-playwright-version.ts` — wrapper using a `minSupportedPlaywrightVersion` constant
|
||||
- `packages/playwright/src/utils/all-generators-enforce-floor.spec.ts`
|
||||
- `packages/playwright/src/utils/preset.ts` — runtime feature gating (blob reporter)
|
||||
- `packages/playwright/src/executors/merge-reports/merge-reports.impl.ts` — executor feature gating
|
||||
- `packages/playwright/src/utils/versions.ts` — `minSupportedPlaywrightVersion`, `minPlaywrightVersionForBlobReports`, `playwrightVersion = '^1.37.0'` (fresh install higher than peer)
|
||||
- `packages/playwright/src/utils/add-linter.ts` — `keepExistingVersions: true` in linter helper
|
||||
- `packages/playwright/package.json` — peer `^1.36.0` (unchanged), added `"semver": "catalog:"`
|
||||
|
||||
### `@nx/cypress` (excludeGenerators + versions() rewrite)
|
||||
|
||||
- `packages/cypress/src/utils/assert-supported-cypress-version.ts`
|
||||
- `packages/cypress/src/utils/all-generators-enforce-floor.spec.ts` — uses `excludeGenerators: ['migrate-to-cypress-11']` with code comment
|
||||
- `packages/cypress/src/utils/versions.ts` — `versions()` rewritten to `versionMap[major] ?? latestVersions`; `getInstalledCypressVersion` FS-path migrated to shared helper, tree-path kept inline
|
||||
|
||||
## Finding current work-in-progress
|
||||
|
||||
To enumerate all compliance PRs (merged + open) without relying on out-of-tree tracking docs:
|
||||
|
||||
```bash
|
||||
# Open + merged compliance PRs
|
||||
gh pr list --repo nrwl/nx --search "multi-version compliance" --state all --limit 30 \
|
||||
--json number,title,state,headRefName,author
|
||||
|
||||
# Just open ones
|
||||
gh pr list --repo nrwl/nx --search "multi-version compliance" --state open
|
||||
```
|
||||
|
||||
This is the authoritative list. Plugins covered to date can be derived by inspecting which packages each merged PR touched.
|
||||
|
||||
To check which plugins still have known anti-patterns (e.g., phantom peer claims, missing floor assert), grep on master:
|
||||
|
||||
```bash
|
||||
# Plugins WITHOUT an assert-supported-<pkg>-version wrapper
|
||||
for d in packages/*/src/utils; do
|
||||
pkg=$(dirname "$d" | xargs basename)
|
||||
if [ ! -f "$d/assert-supported-$pkg-version.ts" ] && \
|
||||
[ ! -f "$d/assert-supported-${pkg/_/-}-version.ts" ]; then
|
||||
echo "$pkg: no assert-supported wrapper"
|
||||
fi
|
||||
done
|
||||
|
||||
# Plugins missing the parameterized floor spec
|
||||
find packages -name "all-generators-enforce-floor.spec.ts" -not -path "*/dist/*"
|
||||
```
|
||||
|
||||
Cross-reference with the third-party packages each plugin manages (peer deps in `package.json`).
|
||||
|
||||
## How to use these examples
|
||||
|
||||
When auditing a new plugin, before writing anything:
|
||||
|
||||
1. Read the PR body of `#35642` (`@nx/playwright`) — it's the most comprehensive description of the canonical shape.
|
||||
2. Read the four files from `@nx/playwright`: `versions.ts`, `assert-supported-playwright-version.ts`, `all-generators-enforce-floor.spec.ts`, and `preset.ts`. Five minutes.
|
||||
3. If your plugin has a `migrations.json` of any complexity, also read `packages/angular/migrations.json` MF entries and the `update-unit-test-runner-option` entry for the gate patterns.
|
||||
4. If the plugin has runtime feature gates, also read `packages/playwright/src/executors/merge-reports/merge-reports.impl.ts`.
|
||||
|
||||
When reviewing a compliance PR, the diff should look very similar to one of these reference PRs. Differences should be justifiable by the plugin's specifics (different floor, different feature gates, different migration shape) — not by departing from the canonical patterns.
|
||||
@@ -0,0 +1,241 @@
|
||||
# Gotchas & edge cases
|
||||
|
||||
Non-obvious behavior. Load these into your model before auditing or reviewing.
|
||||
|
||||
## `latest` / `next` dist-tags
|
||||
|
||||
When a workspace declares `"<pkg>": "latest"` or `"next"` in its `package.json`:
|
||||
|
||||
- `assertSupportedPackageVersion` no-ops via `isNonSemverDistTag` (NON_SEMVER_DIST_TAGS = `['latest', 'next']`). The floor check is skipped entirely.
|
||||
- `getDeclaredPackageVersion` falls back to the cleaned `latestKnownVersion` argument (if provided) or returns `null`.
|
||||
- `versions(tree)` returns `latestVersions` (the fresh-install path).
|
||||
|
||||
Tests must include `latest` and `next` cases. Both are no-ops; neither throws.
|
||||
|
||||
## pnpm `catalog:` references
|
||||
|
||||
Declared versions may be `"catalog:default"`, `"catalog:typescript"`, etc. (since pnpm 9.5):
|
||||
|
||||
- `getDependencyVersionFromPackageJson` (via the catalog manager in devkit) resolves these before the helper sees them. Don't call `clean`/`coerce` on raw values.
|
||||
- `normalizeSemver` behavior on a raw `catalog:` string is not explicitly tested (open question — verify if you encounter it).
|
||||
|
||||
Reference: PR `#35459` (`fix(misc): resolve pnpm catalog: refs in version lookups`) — landed catalog ref handling.
|
||||
|
||||
## Fresh-install path (package not declared)
|
||||
|
||||
When `<pkg>` is missing from the workspace's `package.json` entirely:
|
||||
|
||||
- `assertSupportedPackageVersion` no-ops.
|
||||
- `versions(tree)` returns `latestVersions`.
|
||||
- The generator proceeds with the fresh-install constant (e.g., `playwrightVersion = '^1.37.0'`).
|
||||
|
||||
This is intentional — the generator is being run on a new workspace or one that's adding this package for the first time.
|
||||
|
||||
## Error message preserves declared range, not cleaned semver
|
||||
|
||||
```
|
||||
Installed: ~18.2.0
|
||||
Supported: >= 19.0.0
|
||||
```
|
||||
|
||||
`Installed:` shows what's in `package.json` verbatim. Don't try to normalize it in the error message — it tells the user exactly what they typed, which helps them find it.
|
||||
|
||||
The argument flow: `assertSupportedPackageVersion` calls `throwForUnsupportedVersion(packageName, declared, minSupportedVersion)` with the raw `declared` value.
|
||||
|
||||
## Cypress's `getCypressVersionFromTree` stays inline
|
||||
|
||||
The shared `getDeclaredPackageVersion` falls back to `latestKnownVersion` when the declared value is `latest`/`next` or missing. Cypress's tree path returns `null` on missing. These semantics differ enough that the helper can't be consolidated without changing behavior.
|
||||
|
||||
The FS path (`getCypressVersionFromFileSystem`) was migrated to `getInstalledPackageVersion` (better resolution for pnpm strict / nested installs). The tree path stayed inline.
|
||||
|
||||
Reference: `packages/cypress/src/utils/versions.ts` after `#35670`.
|
||||
|
||||
## Double-asserts are fine
|
||||
|
||||
When `configurationInternal` calls `initInternal` (or any generator chain), both call their respective `assertSupportedXVersion(tree)`. The assert is idempotent and cheap (one tree read + one semver comparison). Don't refactor away.
|
||||
|
||||
The `assertGeneratorsEnforceVersionFloor` test treats both entry points as separate generators and asserts each throws — which is what we want.
|
||||
|
||||
## Angular ecosystem lockstep — what `@angular/core >=N` covers
|
||||
|
||||
Peer-locked to `@angular/core` (one `requires` on the primary is sufficient):
|
||||
|
||||
- `@angular/cli`
|
||||
- `@angular/ssr`
|
||||
- `@angular-devkit/build-angular` **from v20+** (NOT v19 — `@angular-devkit/build-angular@19` does not peer-on `@angular/core`)
|
||||
- `@angular/material`, `@angular/cdk`, all `@angular/*` framework packages
|
||||
- `@schematics/angular`
|
||||
|
||||
Independent (need their own `requires`):
|
||||
|
||||
- `@ngrx/*`
|
||||
- `@angular-eslint/*`
|
||||
- `zone.js`
|
||||
- `jest-preset-angular`
|
||||
- `karma`, `karma-*`
|
||||
- `protractor` (deprecated)
|
||||
- `tailwindcss` and CSS-tooling siblings
|
||||
|
||||
Always verify pairing at the actual version range being bumped from — `@angular-devkit/build-angular` is the classic gotcha (peers on `@angular/core` in some versions, not others).
|
||||
|
||||
## Pruned migrations leave no trace in `migrations.json`
|
||||
|
||||
Older `packageJsonUpdates` entries (e.g., `12.x` migrations) are removed during normal Nx version cleanup waves. They don't show up in the current `migrations.json` but their absence is meaningful — users on an old floor have no auto-bump path to the new floor.
|
||||
|
||||
Check via:
|
||||
|
||||
```sh
|
||||
git log --all --oneline -p -- packages/<plugin>/migrations.json | head -200
|
||||
git log --all --diff-filter=D --name-only -- packages/<plugin>/migrations.json
|
||||
```
|
||||
|
||||
When raising a floor by N+ majors, decide whether to:
|
||||
|
||||
1. Add a `packageJsonUpdates` entry bridging sub-floor → floor (the user gets auto-bumped on `nx migrate`).
|
||||
2. Leave the gap (the user sees the floor-assert error and has to bump manually).
|
||||
|
||||
The Cypress v12 → v13 gap was left intentionally — users get the assert error and bump manually. Don't add a bridge entry without explicit agreement.
|
||||
|
||||
## Pre-floor `packageJsonUpdates` entries are intentionally retained
|
||||
|
||||
Distinct from the pruned-history case above: a plugin may carry `packageJsonUpdates` entries targeting source majors **below** the current support floor. Example: `@nx/react-native`'s entries `20.3.0` and `21.4.0` target RN versions below the current ~0.79.3 floor. These are intentionally retained for users on older Nx versions that supported older RN.
|
||||
|
||||
Don't _add_ a bridge entry without explicit decision. Don't _remove_ a legitimately-pre-floor entry as part of a compliance pass. The W1/W4 audit window only covers entries that target source majors **inside** the current support window.
|
||||
|
||||
## `subFloorVersion` must satisfy `lt(clean(it), floor)`
|
||||
|
||||
For the parameterized floor spec, pick a value that's actually below the floor after `clean()`. Examples:
|
||||
|
||||
| Floor | Valid `subFloorVersion` | Invalid |
|
||||
| -------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `19.0.0` | `~18.2.0`, `^18.0.0`, `18.2.0` | `~19.0.0-beta.0` (clean strips the pre-release; in some cases this still satisfies `lt`, but it's confusing — avoid pre-release) |
|
||||
| `13.0.0` | `~12.17.0`, `^12.0.0` | `^13.0.0-rc.0` |
|
||||
| `1.36.0` | `~1.35.0`, `^1.35.0` | `1.36.0-beta.5` |
|
||||
|
||||
Use a stable minor-or-patch range below floor. Don't use pre-release identifiers.
|
||||
|
||||
## Declared floor vs. effective floor
|
||||
|
||||
The declared floor (peer dep + `minSupported<Pkg>Version` + `versionMap` lowest entry) is what the plugin advertises. The **effective floor** is the lowest major where every third-party API the plugin's code actually calls is available. When they diverge, the declared floor is lying.
|
||||
|
||||
How this happens: someone bumps the plugin to use a new API (e.g., `getRelevantTestSpecifications` introduced in vitest v3) without raising the floor. The plugin compiles, generators pass tests against the latest install lane, but workspaces on sub-effective-floor versions crash at runtime with `... is not a function`.
|
||||
|
||||
How to detect: in the audit's runtime/executor inventory step, every `import` / `require` from the third-party package goes into a list. Cross-reference each named export against the third-party's release notes / API docs. The effective floor is the highest "introduced in" version across that list.
|
||||
|
||||
How to fix: raise the declared floor to match the effective floor. Drop the now-unsupported entries from `versionMap`, peer, and any per-major aliases. The parameterized floor spec's `subFloorVersion` shifts up accordingly.
|
||||
|
||||
Reference: open PR `#35671` (`@nx/vitest`) — proposed v2 floor initially; raised to v3 in a follow-up commit after spotting `getRelevantTestSpecifications` usage. See `anti-patterns.md` §16.
|
||||
|
||||
## `versions()` fall-through above ceiling, not throw
|
||||
|
||||
Before `#35670`, cypress's `versions()` had a `switch + throw default:`. This is wrong for two reasons:
|
||||
|
||||
1. New majors that don't yet have a `versionMap` entry should silently use `latestVersions` — the plugin hasn't been updated to know about them, but the user should still be able to use them.
|
||||
2. Below-floor is already caught by the generator-level assert. The `versions()` throw is redundant for the in-range/sub-floor case, and wrong for the above-ceiling case.
|
||||
|
||||
The pattern is always:
|
||||
|
||||
```ts
|
||||
return versionMap[major as CompatVersions] ?? latestVersions;
|
||||
```
|
||||
|
||||
## Tier-1 chaining in `packageJsonUpdates`
|
||||
|
||||
Within a single `packageJsonUpdates` entry (single block), if entry A bumps package X and entry B has `requires: { X: ">=N" }` that depends on the post-bump value of X, B's gate evaluates against the post-bump state. This is **deliberate design**, not a bug.
|
||||
|
||||
Concrete example: Storybook's `21.2.0-migrate-storybook-v9` migration is gated on `storybook >=9.0.0` even though the prior state was v8 — the sibling `packageJsonUpdates` `21.1.0` bumps Storybook to v9 first, so the v9 gate evaluates against post-bump state.
|
||||
|
||||
This means you can have one block bump X then chain a sibling bump gated on X's new version, without splitting into separate `packageJsonUpdates` keys.
|
||||
|
||||
## Cross-plugin coordination of shared third-party windows
|
||||
|
||||
Some third-party packages are managed by multiple Nx plugins. Concrete example:
|
||||
|
||||
- `@nx/cypress` pins `vite` v5 (for cypress v13) and v6 (for cypress v14+).
|
||||
- `@nx/vite` supports `vite` v5–v8.
|
||||
|
||||
If `@nx/vite` drops v5 from its supported window, `@nx/cypress`'s v5 pin becomes an orphaned install lane — workspaces using both plugins are now in conflict.
|
||||
|
||||
When raising / lowering a third-party's support window in one plugin, check every other plugin that manages the same package. The Linear milestone tasks call this out per-plugin (e.g., NXC-4384 cypress flags vite coordination with NXC-4407 vite).
|
||||
|
||||
### Sibling declaration consistency
|
||||
|
||||
When the same third-party package appears in multiple plugins, the declaration _kind_ (peerDependencies vs dependencies vs devDependencies) should be consistent unless the plugins genuinely have different roles for the package. Concrete inconsistency on master at time of writing: `@module-federation/enhanced ^2.3.3` is in `dependencies` in `@nx/module-federation` but `peerDependencies` in `@nx/rspack`. Pick one rule per package across the plugin family and document the exception when one plugin must differ.
|
||||
|
||||
## Plugin must own its primary third-party's pin
|
||||
|
||||
A plugin's install constants for its primary third-party must live in the plugin's own `packages/<plugin>/src/utils/versions.ts` — not in another plugin. Cross-plugin imports of install constants create governance drift (the owning plugin can't change the pin without breaking the borrower).
|
||||
|
||||
Example anti-pattern: `@nx/esbuild`'s `esbuild` install constant living in `@nx/js`. Flagged in NXC-4386.
|
||||
|
||||
## Schema-level deprecated-option stubs with runtime throws
|
||||
|
||||
Established Angular pattern (also called out in NXC-4391 jest, NXC-4395 next, NXC-4408 vitest): when an option is deprecated/removed in a newer third-party major but the plugin still supports an older major where it's valid, **retain the option in the schema with a description-notice and throw at runtime when inapplicable to the installed major**.
|
||||
|
||||
This keeps the schema accepting the union of options across the support window. Runtime branches on installed version and throws a clear message if the user passes an option that's only valid on a major they're not running.
|
||||
|
||||
Reference: search the angular generators for `removed in Angular vN` style schema descriptions paired with `assertSupportedAngularVersion`-aware option handling.
|
||||
|
||||
## Known-incomplete plugins
|
||||
|
||||
These were touched by a compliance PR but the work is incomplete. Useful for review and for future PRs.
|
||||
|
||||
- **`@nx/angular` init `keepExistingVersions`**: `packages/angular/src/generators/init/schema.json` has `default: false` and `packages/angular/src/generators/init/init.ts` passes `options.keepExistingVersions` directly (no `?? true`). PR `#35587` fixed `add-linting` but NOT the init generator. Flag in non-angular PRs as a reference to the pattern; fix in passing in any future angular PR. (Verify state on current master before citing.)
|
||||
- **`@nx/jest` peer-dep block missing entirely.** When adopting the floor assert, add `peerDependencies` first declaring `jest` / `ts-jest` / `@types/jest` ranges. Without the peer block, `getDependencyVersionFromPackageJson` for `jest` may return `undefined` on installed workspaces because pnpm catalog refs and certain other patterns rely on the peer being declared.
|
||||
- **Cypress v12→v13 migration gap**: when `#35670` raised the floor to v13, prior v12-cleanup `packageJsonUpdates` entries were already pruned. Decision was to leave it — v12 workspaces see the assert error and bump manually. Reference for the "raise floor, no bridge" pattern.
|
||||
- **`getInstalled<Pkg>Version` consolidation deferred**: each plugin still has its own near-identical helper (the FS-side has been migrated to the shared helper in some plugins, but a full unification across cypress/playwright/vitest/next/expo/angular is pending). Don't bundle that refactor into a compliance PR.
|
||||
|
||||
## `migrate-to-cypress-11` and other intentional sub-floor migrators
|
||||
|
||||
A generator whose purpose is to lift sub-floor workspaces onto a supported version must run on sub-floor workspaces. If it had the floor assert, it could never run.
|
||||
|
||||
For these generators:
|
||||
|
||||
- Do NOT add `assertSupportedXVersion(tree)` to them.
|
||||
- Keep their existing version checks (e.g., `assertMinimumCypressVersion(8)` in `migrate-to-cypress-11`).
|
||||
- Add them to `excludeGenerators` in `all-generators-enforce-floor.spec.ts` with a code comment explaining why.
|
||||
|
||||
There are usually 0 or 1 of these per plugin. Greater than 1 is suspicious — review carefully.
|
||||
|
||||
## `getInstalledPackageVersion` vs. `require('<pkg>/package.json')`
|
||||
|
||||
Bare `require('<pkg>/package.json')` resolves from the plugin's own install location, which in pnpm strict mode or nested installs may not match the workspace's resolved version. `readModulePackageJson` (used by `getInstalledPackageVersion`) goes through `getNxRequirePaths()` for correct workspace-rooted resolution.
|
||||
|
||||
Anywhere you read an installed version at runtime: prefer `getInstalledPackageVersion('<pkg>')`. Don't `require('<pkg>/package.json')`.
|
||||
|
||||
## "Above ceiling" is NOT in the task spec
|
||||
|
||||
Repeating because this gets re-introduced: above-ceiling handling is explicitly out of scope for these compliance tasks. If you find yourself adding it, you've drifted from the spec.
|
||||
|
||||
The behavior we want above the highest known major: silent fall-through to `latestVersions`. The plugin will be updated to add a `versionMap` entry for the new major in a future PR. Until then, the user gets the latest install constants and may run into incompatibilities, which is the existing pre-compliance behavior. We are NOT trying to detect future majors and warn — that's a different feature.
|
||||
|
||||
## Decisions you cannot make alone
|
||||
|
||||
Pause and ask when:
|
||||
|
||||
- **Peer-range drop:** dropping a major from the peer might be a regression if tests pass on that version. Verify whether the absence of an install lane reflects "we never supported it" (legitimate drop) or "we shipped support and quietly broke it" (regression — investigate before dropping).
|
||||
- **Floor raise without a bridging migration:** raising the floor by N+ majors means users on the lowest sub-floor major see the assert error and must manually bump. Confirm with the user: acceptable, or add a `packageJsonUpdates` bridge?
|
||||
- **`requires` removal on a borderline migration:** the diff says the migration is Nx-only (no third-party config touched), but it reads a config file that only exists at certain third-party versions. The third-party dependency is indirect but real. Don't remove the gate without verifying.
|
||||
- **Peer floor and fresh-install constant diverge** (playwright pattern — peer `^1.36.0`, fresh-install `^1.37.0`). Confirm the gap is justified by feature surface (1.37 introduced the blob reporter + merge-reports CLI) and not an oversight.
|
||||
- **Ecosystem-locked vs. independent sibling classification:** before adding or removing a sibling's `requires` entry, read its `peerDependencies` block at the version range being bumped from. `@angular-devkit/build-angular` is the gotcha — only peer-locked to `@angular/core` from v20+.
|
||||
- **Pruned migration gap:** the lowest sub-floor major has no auto-bump path because prior `packageJsonUpdates` entries were removed during cleanup waves. Decide: add a bridge entry, or accept the manual bump? `git log --diff-filter=D -- packages/<plugin>/migrations.json` reveals the gap.
|
||||
- **New plugin doesn't fit the canonical shape** (manages multiple primary packages with different floors, runs partially as a Nx-internal-only plugin, etc.). Ask before improvising — see `canonical-shape.md` §"Plugins managing multiple primary packages" for the established multi-primary pattern.
|
||||
- **Test fails on `latest`/`next` despite the assert being a no-op.** The no-op behavior is intentional, but if the generator downstream of the assert can't handle the unresolved range, that's a real bug — not something to paper over by tightening the assert.
|
||||
|
||||
## Per-plugin decision log
|
||||
|
||||
These were decided once for the reference PRs (#35587, #35642, #35670) — apply them as defaults unless explicitly contradicted by the user for a new plugin:
|
||||
|
||||
- **Executors do NOT enforce the plugin floor.** Generator-only. Executors gate per-feature, not per-floor.
|
||||
- **Above-ceiling: silent fall-through to `latestVersions`.** No warn, no throw, no branch.
|
||||
- **Init generators preserve user pins** via `keepExistingVersions: true` (schema default) and the `?? true` safety net at the call site.
|
||||
- **Skip writing the install constant when the package is already detected** (cypress + angular pattern — preserves the user's installed minor/patch).
|
||||
- **Shared helpers stay in `@nx/devkit/internal`** — not part of the public devkit surface. (The W2 ticket originally proposed adding `throwForUnsupportedVersion` to the public devkit API; the implementation landed under `/internal` instead, matching how other version-related helpers ship.)
|
||||
- **Consolidation of per-plugin `getInstalled<Pkg>Version` helpers is deferred** — don't bundle that refactor into a compliance PR.
|
||||
|
||||
Plugin-specific decisions that may be pending or have settled differently (check the live PR state via `gh pr list --repo nrwl/nx --search "multi-version compliance"`):
|
||||
|
||||
- `@nx/jest` — needs a `peerDependencies` block for `jest`/`ts-jest`/`@types/jest` before the floor assert can rely on `getDependencyVersionFromPackageJson`.
|
||||
- `@nx/eslint` — historically gated on an ESLint v8 EOL decision. If you're touching it, confirm the decision is settled.
|
||||
- `@nx/eslint-plugin` — historically coupled to the eslint v8 decision (typescript-eslint v6/v7 only support eslint v8). Confirm before proceeding.
|
||||
- `@nx/rspack` / `@nx/rsbuild` — there is an open PR (`#35676` at time of writing). Inspect for the local-helper-duplication anti-pattern (`anti-patterns.md` §1).
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
name: nx-docs-style-check
|
||||
description: Check modified Nx documentation pages against the astro-docs style guide. Auto-trigger after writing or editing docs content in the nx repo. Also trigger on "check style", "style guide", "docs review", "validate docs". Should run as a final step whenever docs files are modified. IMPORTANT: anytime astro-docs/**/*.mdoc files are modified, this should always run automatically without being asked.
|
||||
allowed-tools: Read, Glob, Grep
|
||||
---
|
||||
|
||||
# Nx docs style check
|
||||
|
||||
You are a documentation editor for Nx. Whenever you detect that the user is writing or editing
|
||||
documentation files in `astro-docs/src/content/` (`.mdoc`, `.mdx`, `.md`), automatically run this
|
||||
check and fix any issues. Do not wait to be asked.
|
||||
|
||||
## Phase 1: Information architecture audit
|
||||
|
||||
Read `astro-docs/STYLE_GUIDE.md` (the "Information architecture" section) and
|
||||
`astro-docs/sidebar.mts` to understand where the page lives in the sidebar hierarchy.
|
||||
|
||||
For every new or moved page, evaluate against ALL FIVE principles. These are non-negotiable:
|
||||
|
||||
### 1. Progressive disclosure ("journey" rule)
|
||||
|
||||
- Is this for the first 30 minutes (Getting Started), first 30 days (Features), or forever (Reference)?
|
||||
- Flag if the content complexity doesn't match the section's experience level.
|
||||
|
||||
### 2. Category homogeneity ("scan" rule)
|
||||
|
||||
- Look at sibling pages in the same sidebar section.
|
||||
- Do they all share the same content type (concepts, tasks, or products)?
|
||||
- Flag if this page mixes types that siblings don't.
|
||||
|
||||
### 3. Type-based navigation ("intent" rule)
|
||||
|
||||
- Is this a learning page (narrative/guide) or a lookup page (reference/API)?
|
||||
- Flag if it's in the wrong category (e.g., a reference page in a guides section).
|
||||
|
||||
### 4. Pen and paper test ("theory" rule)
|
||||
|
||||
- Can the page be explained using only pen and paper (no terminal needed)?
|
||||
- YES = belongs in "How Nx Works" (architecture/concepts)
|
||||
- NO (needs terminal/code examples) = belongs in "Platform Features" or "Technologies"
|
||||
- Flag if a concept page has terminal output, CLI commands, or code-heavy examples.
|
||||
|
||||
### 5. Universal vs. specific ("placement" rule)
|
||||
|
||||
- Does this feature apply to every Nx user?
|
||||
- YES = "Platform Features"
|
||||
- NO (only React/Angular/etc. users) = "Technologies"
|
||||
- Flag if a technology-specific page is in Platform Features or vice versa.
|
||||
|
||||
## Phase 2: Style validation
|
||||
|
||||
### Step 1: Run Vale and fix errors
|
||||
|
||||
Run `nx run astro-docs:vale` to check the modified files.
|
||||
|
||||
- **errors** — fix these automatically. Edit the file to resolve the violation.
|
||||
- **warnings** — fix these automatically when the fix is unambiguous (e.g., sentence case headings).
|
||||
For ambiguous cases, suggest the fix and ask.
|
||||
- **suggestions** — mention them to the user but do not auto-fix.
|
||||
|
||||
### Step 2: Fix issues Vale doesn't catch
|
||||
|
||||
Read `astro-docs/STYLE_GUIDE.md` and check for that things that Vale may have missed.
|
||||
|
||||
### Handling false positives
|
||||
|
||||
Use inline Vale comments to suppress legitimate exceptions:
|
||||
|
||||
```markdown
|
||||
<!-- vale Nx.Headings = NO -->
|
||||
|
||||
## extractLicenses
|
||||
|
||||
<!-- vale Nx.Headings = YES -->
|
||||
```
|
||||
|
||||
Common cases where suppression is appropriate:
|
||||
|
||||
- **CLI option headings** (e.g., `## extractLicenses`) — camelCase by design.
|
||||
Prefer wrapping in backticks first (`## \`extractLicenses\``).
|
||||
- **Product possessives in historical/migration context** (e.g., "Angular's original schematic system")
|
||||
- **Terminology in migration docs** (e.g., explaining what "schematics" were before being renamed)
|
||||
|
||||
Do NOT suppress rules just to avoid fixing real violations.
|
||||
|
||||
## Output summary
|
||||
|
||||
After fixing, report what you did:
|
||||
|
||||
```
|
||||
## Style check results
|
||||
|
||||
### Information architecture: [PASS/FAIL]
|
||||
[List any violations or confirm all five principles pass]
|
||||
|
||||
### Vale: [X errors fixed, Y warnings fixed, Z suggestions noted]
|
||||
[Summary of changes made]
|
||||
|
||||
### Manual fixes: [list of additional fixes applied]
|
||||
```
|
||||
@@ -0,0 +1,151 @@
|
||||
---
|
||||
name: nx-gradle-plugin-version-bump
|
||||
description: Bump the dev.nx.gradle.project-graph plugin version. Use when updating the Gradle project graph plugin version across the codebase, creating the migration files, and updating migrations.json.
|
||||
allowed-tools: Bash, Read, Write, Edit, Glob, Grep
|
||||
---
|
||||
|
||||
# Gradle Plugin Version Bump
|
||||
|
||||
Bumps the `dev.nx.gradle.project-graph` plugin to a new version. This is a recurring task that touches 5 files in an identical pattern every time.
|
||||
|
||||
## Required Inputs
|
||||
|
||||
Collect these values from the master branch before starting:
|
||||
|
||||
1. `NEW_VERSION` - the version we want to bump to
|
||||
Example: OLD_VERSION: 0.1.15 => NEW_VERSION: 0.1.16
|
||||
You can find this value by looking at the `OLD_VERSION` specified in `packages/gradle/project-graph/build.gradle.kts` in the `version` field.
|
||||
The NEW_VERSION will be the `OLD_VERSION` + 1.
|
||||
|
||||
2. `NX_MIGRATION_VERSION` - the version of Nx that will trigger our version bump migration
|
||||
Example: OLD_VERSION: 22.7.0-beta.0 => NEW_VERSION: 22.7.0-beta.1
|
||||
You can find this value by looking at the `nx` version in `package.json` under `devDependencies`. The NEW_VERSION will be the `OLD_VERSION` + 1.
|
||||
|
||||
3. `MIGRATION_FOLDER` - the folder name under `packages/gradle/src/migrations/` that will contain our migration files
|
||||
Example: NEW_VERSION: 22.7.0-beta.1 => MIGRATION_FOLDER: 22-7-0
|
||||
Take the version and replace all the dots with hyphens and remove the `beta` or `rc` suffix.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Update the version constant
|
||||
|
||||
**File:** `packages/gradle/src/utils/versions.ts`
|
||||
|
||||
Change `gradleProjectGraphVersion` to the new version:
|
||||
|
||||
```ts
|
||||
export const gradleProjectGraphVersion = 'NEW_VERSION';
|
||||
```
|
||||
|
||||
### 2. Update build.gradle.kts
|
||||
|
||||
**File:** `packages/gradle/project-graph/build.gradle.kts`
|
||||
|
||||
Update the `version` on line 13:
|
||||
|
||||
```kotlin
|
||||
version = "NEW_VERSION"
|
||||
```
|
||||
|
||||
### 3. Create migration TypeScript file
|
||||
|
||||
**File:** `packages/gradle/src/migrations/MIGRATION_FOLDER/change-plugin-version-NEW_VERSION.ts`
|
||||
|
||||
Determine the previous version by reading the current `gradleProjectGraphVersion` from `packages/gradle/src/utils/versions.ts` before modifying it.
|
||||
|
||||
Template:
|
||||
|
||||
```ts
|
||||
import { Tree, readNxJson } from '@nx/devkit';
|
||||
import { hasGradlePlugin } from '../../utils/has-gradle-plugin';
|
||||
import { addNxProjectGraphPlugin } from '../../generators/init/gradle-project-graph-plugin-utils';
|
||||
import { updateNxPluginVersionInCatalogsAst } from '../../utils/version-catalog-ast-utils';
|
||||
|
||||
/* Change the plugin version to NEW_VERSION
|
||||
*/
|
||||
export default async function update(tree: Tree) {
|
||||
const nxJson = readNxJson(tree);
|
||||
if (!nxJson) {
|
||||
return;
|
||||
}
|
||||
if (!hasGradlePlugin(tree)) {
|
||||
return;
|
||||
}
|
||||
|
||||
const gradlePluginVersionToUpdate = 'NEW_VERSION';
|
||||
|
||||
// Update version in version catalogs using AST-based approach to preserve formatting
|
||||
await updateNxPluginVersionInCatalogsAst(tree, gradlePluginVersionToUpdate);
|
||||
|
||||
// Then update in build.gradle(.kts) files
|
||||
await addNxProjectGraphPlugin(tree, gradlePluginVersionToUpdate);
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Create migration documentation file
|
||||
|
||||
**File:** `packages/gradle/src/migrations/MIGRATION_FOLDER/change-plugin-version-NEW_VERSION.md`
|
||||
|
||||
Replace `PREV_VERSION` with the version that was current before this bump.
|
||||
|
||||
Template:
|
||||
|
||||
````md
|
||||
#### Change dev.nx.gradle.project-graph to version NEW_VERSION
|
||||
|
||||
Change dev.nx.gradle.project-graph to version NEW_VERSION in build file
|
||||
|
||||
#### Sample Code Changes
|
||||
|
||||
##### Before
|
||||
|
||||
\```text title="build.gradle"
|
||||
plugins {
|
||||
id "dev.nx.gradle.project-graph" version "PREV_VERSION"
|
||||
}
|
||||
\```
|
||||
|
||||
##### After
|
||||
|
||||
\```text title="build.gradle"
|
||||
plugins {
|
||||
id "dev.nx.gradle.project-graph" version "NEW_VERSION"
|
||||
}
|
||||
\```
|
||||
````
|
||||
|
||||
### 5. Add migration entry to migrations.json
|
||||
|
||||
**File:** `packages/gradle/migrations.json`
|
||||
|
||||
Add a new entry at the end of the `generators` object (before the closing `}`), following the existing pattern:
|
||||
|
||||
```json
|
||||
"change-plugin-version-NEW_VERSION": {
|
||||
"version": "NX_MIGRATION_VERSION",
|
||||
"cli": "nx",
|
||||
"description": "Change dev.nx.gradle.project-graph to version NEW_VERSION in build file",
|
||||
"factory": "./src/migrations/MIGRATION_FOLDER/change-plugin-version-NEW_VERSION"
|
||||
}
|
||||
```
|
||||
|
||||
The migration key uses the version with hyphens replacing dots (e.g., `0-1-16`).
|
||||
|
||||
## Verification
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
nx run-many -t test,build,lint -p gradle
|
||||
```
|
||||
|
||||
## Commit Convention
|
||||
|
||||
```
|
||||
chore(gradle): bump gradle project graph plugin version to NEW_VERSION
|
||||
```
|
||||
|
||||
## Final Verification
|
||||
|
||||
Take a look at the most recent Gradle version bump PR and compare your changes to that. You should not be touching more or less files than
|
||||
the most recent version bump PR. If you do, ask for more information and stop all changes.
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
name: nx-multi-repo-migrate
|
||||
description: Migrate several repos to a target nx version (e.g. 23.0.0-beta.25) in one coordinated pass — delegates `nx migrate` + migrations to a Polygraph child agent per repo, then pushes branches and opens linked draft PRs. Use when asked to upgrade/migrate multiple repos to a specific nx version, or when working a Polygraph session whose goal is an nx version bump across repos.
|
||||
allowed-tools: Bash(npm view *), Read, Write(tmp/notes/**), Grep, Glob, Agent, Skill(polygraph:polygraph), mcp__plugin_polygraph_polygraph-mcp__show_session, mcp__plugin_polygraph_polygraph-mcp__spawn_agent, mcp__plugin_polygraph_polygraph-mcp__show_agent, mcp__plugin_polygraph_polygraph-mcp__push_branch, mcp__plugin_polygraph_polygraph-mcp__create_pr
|
||||
---
|
||||
|
||||
# Nx Multi-Repo Migrate
|
||||
|
||||
Migrate a set of repos to one target nx version, then open linked draft PRs. Think of it like a pharmacist filling the same prescription for several patients: same drug (target version), but each patient (repo) has different allergies (package manager quirks) — get those wrong and the dose silently fails.
|
||||
|
||||
## Input
|
||||
|
||||
- **Target version** — e.g. `23.0.0-beta.25`. Verify it exists: `npm view nx@<version> version`.
|
||||
- **Repos** — an explicit list, or the repos already in a Polygraph session. When none is given, the **default set** is `nx`, `ocean`, `nx-labs`, `nx-examples`, `nx-console` (all in the `nrwl` org).
|
||||
|
||||
## Procedure
|
||||
|
||||
### 1. Set up the session
|
||||
|
||||
Use the `polygraph` skill to discover repos, select the org, and start (or join) the session. It owns auth and session lifecycle — don't reimplement any of that here.
|
||||
|
||||
### 2. Delegate the migration to a child agent per repo
|
||||
|
||||
This is the Polygraph way: each repo's work runs in its own child agent (`spawn_agent`), not in the parent. Delegate to every repo in the session — in parallel — and poll with `show_agent` until each is terminal. Hand each child the migration instruction below (substitute the target version).
|
||||
|
||||
> Migrate this repository to nx `<VERSION>`.
|
||||
>
|
||||
> 1. **Branch from the current default branch, not the clone's checkout.** Fetch first so you don't inherit a stale clone or an in-place working-dir branch, then create the branch from `origin/<base>` (`master` or `main`): `git fetch origin <base> && git checkout -B migrate-nx-<VERSION> origin/<base>`.
|
||||
> 2. Detect the package manager from the lockfile (`package-lock.json`=npm, `yarn.lock`=Yarn Berry, `pnpm-lock.yaml`=pnpm, `bun.lock`/`bun.lockb`=bun).
|
||||
> 3. **Install first, so `node_modules` is at the repo's _current_ (pre-migrate) nx version.** `nx migrate` reads the "from" version from `node_modules`, not `package.json` — if `node_modules` is already at the target, it finds **zero migrations** and silently skips them. Verify with `node -p "require('./node_modules/nx/package.json').version"`.
|
||||
> 4. Run `nx migrate <VERSION>` (updates `package.json`, writes `migrations.json`).
|
||||
> 5. Install again — **mutable**. Do NOT set `CI=true` (it makes Yarn Berry immutable / pnpm frozen, so the install and migrations fail silently). pnpm needs `--config.confirm-modules-purge=false`; Yarn Berry needs `YARN_ENABLE_IMMUTABLE_INSTALLS=false`.
|
||||
> 6. **Commit the version bump first** (before running migrations, so it stays isolated from the migration edits): stage `package.json` + the lockfile — NOT `migrations.json` — and commit `chore(repo): migrate to nx <VERSION>` (never mention AI/Claude).
|
||||
> 7. **Run migrations — do NOT use `--create-commits`.** nx shells its `--commit-prefix="chore(repo): [nx migration] "` through `/bin/sh` unescaped, and the `(` crashes it (`Syntax error: "(" unexpected`), which silently drops migrations. Instead run **one** `nx migrate --run-migrations` pass (apply the whole list, not a subset), then commit each migration's edits by hand, e.g. `chore(repo): [nx migration] <name>` (`git commit -m` handles the parens fine).
|
||||
> 8. **Apply the AI migrations yourself — you are the agent nx defers them to.** `--run-migrations` applies the deterministic codemods (importantly `remove-removed-typescript-eslint-extension-rules`, which strips typescript-eslint v8-removed rules like `@typescript-eslint/no-extra-semi`; leaving one in a flat config **crashes ESLint's loader** → nx "Failed to process project graph" → red CI) AND writes prompt-only migrations to `tools/ai-migrations/**/*.md`, printing _"Next steps for the AI agent driving this run: apply the deferred prompts."_ That is addressed to **you (the child)** — read each prompt and make the described changes; do NOT leave them for a human. Honor each prompt's "passing baseline": keep lint/typecheck passing, never disable a rule the user explicitly configured, and disable a newly _preset_-enabled rule with a short comment rather than editing source to satisfy it. (nx auto-skipping its _nested_ agentic flow inside an agent is the review skipping — NOT permission to skip the migrations.)
|
||||
> 9. **Verify before declaring done:** `nx run-many -t lint --skip-nx-cache` must **resolve the project graph** and pass (the removed-rule crash only shows at graph-processing time), plus typecheck/build affected projects where feasible. Fix migration-introduced breaks; surface genuine framework-major incompatibilities (Angular/React/TS majors) for a human rather than hacking around them.
|
||||
> 10. Delete `tools/ai-migrations/` and `migrations.json`; if migrations changed deps, re-install and commit the lockfile update.
|
||||
> 11. Report: old→new version, packages bumped, deterministic migrations run (+ commits), **each AI prompt and how you applied it** (or why N/A), final lint/typecheck/build status, and any unresolved failures — type/name collisions, framework-major breaks. **Leave true blockers for a human; do not invent workarounds.**
|
||||
|
||||
**Completing a partial / already-at-target run.** If `node_modules` is already at the target, `nx migrate <VERSION>` finds **zero** migrations. To (re)apply migrations that a prior run skipped — the deterministic `remove-removed-*` codemod or the AI prompts — regenerate the full list with an explicit `--from`: `nx migrate <VERSION> --from=nx@<original-version>`. Migrations detect already-applied state and no-op, so this safely re-runs only what's missing, then finish with steps 7–11 above.
|
||||
|
||||
**Package-manager cheat sheet:**
|
||||
|
||||
| Lockfile | PM | run nx | install (mutable) |
|
||||
| ----------------------------- | ---------- | -------------------------- | ------------------------------------------------------------------------ |
|
||||
| `package-lock.json` | npm | `npx nx` | `npm install` |
|
||||
| `yarn.lock` (+ `.yarnrc.yml`) | Yarn Berry | `yarn nx` | `yarn install` (with `YARN_ENABLE_IMMUTABLE_INSTALLS=false`) |
|
||||
| `bun.lock`/`bun.lockb` | bun | `bun nx` | `bun install` |
|
||||
| `pnpm-lock.yaml` | pnpm | `pnpm nx` / `pnpm exec nx` | `pnpm install --no-frozen-lockfile --config.confirm-modules-purge=false` |
|
||||
|
||||
**Migrations can rewrite source:** a multi-beta jump (e.g. beta.23→beta.25) pulls migrations from every intervening version, so it may rewrite real code (e.g. `CreateNodesContextV2`→`CreateNodesContext`). The child should review the non-dep diff before committing. A single-beta jump on an already-current repo often legitimately has none.
|
||||
|
||||
### 3. Push + open a PR per repo, as each child finishes
|
||||
|
||||
Don't barrier on the slowest repo. The moment a child reports success, `push_branch` that repo (branch `migrate-nx-<VERSION>`) and `create_pr` for **that repo alone** — so its CI starts immediately and one slow repo (e.g. one stuck fighting the sandbox) doesn't gate the others:
|
||||
|
||||
```
|
||||
for each repo, as its child reaches terminal success (not in a barrier):
|
||||
push_branch(repo) → create_pr([repo])
|
||||
```
|
||||
|
||||
The PRs stay **linked** because they all join the same Polygraph session — the link is the session, not the single batched call. Commit-message scope `repo` passes nx's commitlint. Print the Polygraph session URL once all are open.
|
||||
|
||||
> **Verify once:** a single batched `create_pr` writes every PR body with its sibling cross-references at creation time; with incremental creation, confirm Polygraph **back-fills** the earlier PRs' bodies with links to the later ones (vs. each PR only linking to the session). If it doesn't back-fill and you need the in-body cross-links, fall back to one batched `create_pr` after all children finish.
|
||||
|
||||
## Verification checklist (per repo, before opening PRs)
|
||||
|
||||
- [ ] `package.json` nx + `@nx/*` at the **exact target version** (not silently downgraded to `latest` by an age gate)
|
||||
- [ ] Migrations **ran** (not skipped because `node_modules` was already at target), **including** the deterministic `remove-removed-*` codemods
|
||||
- [ ] AI-migration prompts **applied by the child** (not just written); `tools/ai-migrations/` and `migrations.json` deleted
|
||||
- [ ] `nx run-many -t lint --skip-nx-cache` **resolves the project graph** and passes; typecheck/build checked where feasible
|
||||
- [ ] Version-bump commit (`chore(repo): migrate to nx <VERSION>`) plus one `chore(repo): [nx migration] …` commit per applied migration/prompt on `migrate-nx-<VERSION>`
|
||||
- [ ] Any collision / compile / framework-major errors surfaced in the child's report for a human to resolve
|
||||
|
||||
## Gotchas from real runs
|
||||
|
||||
These each cost real time on a live 5-repo run. Plan for them up front.
|
||||
|
||||
**Fresh betas/canaries are hidden by release-age gates → silent downgrade to `latest`.** A `<24h`-old target is filtered out by supply-chain age gates in up to three places on an nx-dev box: `~/.npmrc` `min-release-age=1` (npm/bun), `~/.config/pnpm/rc` `minimum-release-age=1440` (pnpm), and a `~/.yarnrc.yml` registry pointed at a local age-gating proxy (`http://localhost:7190`) that is often **down** (→ `ECONNREFUSED`). When the target is filtered, `nx migrate` does **not** error — it silently resolves the whole `@nx/*` group to the newest _visible_ version (e.g. `latest` `23.0.1` instead of `23.1.0-beta.5`), so the repo "migrates" to the wrong version. Bypass per-command (do NOT edit global config): `npm_config_min_release_age=0 npm_config_minimum_release_age=0` (npm/pnpm/bun), plus for Yarn Berry `YARN_NPM_REGISTRY_SERVER=https://registry.npmjs.org/ YARN_NPM_MINIMAL_AGE_GATE=0`. pnpm's nx-migrate temp-dir `pnpm add` also needs `PNPM_CONFIG_STRICT_DEP_BUILDS=false` (else `ERR_PNPM_IGNORED_BUILDS` aborts it). **Always verify each repo landed on the exact target version, not `latest`.** (Note: pnpm ignores the npm-style `min-release-age` key but honors its own `minimum-release-age`; that's why a pnpm repo may resolve the beta while a yarn/npm sibling silently downgrades.)
|
||||
|
||||
**pnpm dies under the Bash sandbox; bun/yarn don't.** As of Claude Code 2.1.172 the Bash tool sandboxes by default. pnpm's content-addressed store + `clonefile()` reflink + `node_modules` purge trip macOS rules — `com.apple.provenance` xattr removal, creating `.vscode`/`.idea` dirs in the virtual store — plus outbound TLS, so pnpm `install` fails with `ERR_PNPM_EPERM` / reflink / `Operation not permitted`, while bun and yarn install cleanly. **Polygraph children carry their _own_ sandbox** (`~/.polygraph/config.json` → `agentOptions.claude.sandbox`), separate from `~/.claude/settings.json` → `sandbox.enabled`; either one only reaches already-spawned processes after a **restart**. If a pnpm child stops on a sandbox/EPERM error, do **not** let it invent workarounds (xattr stripping, TLS shims, store redirection). Instead, disable the sandbox + restart, or migrate that repo from the **unsandboxed parent**: the initiator repo is in-place, and clones live at `~/.polygraph/sessions/<id>/repos/<org>/<repo>` — run the same install→migrate→install steps there with the sandbox off, then push.
|
||||
|
||||
**The base can move after you start.** Step 1 (branch from `origin/<base>`) handles the _initial_ state, but the default branch can still advance **mid-run** — e.g. a separate version-bump PR merges underneath you, as happened when ocean's `main` jumped beta.23→beta.25 below an open migrate PR and turned it **conflicting**. Detect it with the behind-count (`git rev-list --count migrate-nx-<V>..origin/<base>`) and watch for open bump PRs; when the base moves, **redo the branch onto the fresh base** — only the repos whose base actually advanced need it. Redoing onto a newer base can also _shrink_ the diff: a beta.25→rc.0 redo is dep-only, whereas the old beta.23→rc.0 ran 16 migrations and rewrote source.
|
||||
|
||||
**The initiator repo runs in-place** in your working dir, so migrating it switches branches and churns `node_modules`. Restore it afterward — or run its migration in a throwaway worktree off the real base (`git worktree add -B migrate-nx-<V> /tmp/wt origin/<base>`) so the working copy is never touched. But a **fresh full install in the worktree duplicates the huge `node_modules`** and can `ERR_PNPM_ENOSPC` (inode/disk pressure on top of the other clones' installs). Avoid it: run the `nx migrate` planning step in the **main checkout** (reuse its already-installed `node_modules` so migrate can bump the whole `@nx/*` group — without `node_modules` it only bumps `nx` itself), copy `package.json`+`migrations.json` onto the worktree branch, restore the main checkout; when there are **no** migrations to run, just `pnpm install --lockfile-only` in the worktree instead of a full install. Clean up the worktree with `git worktree remove` after pushing (the branch ref persists).
|
||||
|
||||
**A concrete source collision.** The `CreateNodesContextV2`→`CreateNodesContext` rename migration collided with a vendored local `interface CreateNodesContext extends CreateNodesContextV2`, producing a self-referential `extends CreateNodesContext` (TS2310). Surface it for a human; the minimal fix is aliasing the import: `import { CreateNodesContext as NxCreateNodesContext } from '@nx/devkit'`. (That rewrite is a _beta.24_ migration — starting from beta.25 skips it entirely.)
|
||||
|
||||
**Push/auth pitfalls.** (1) The SSH agent can drop mid-run (`communication with agent failed`) — SSH `git push` then fails; retry, or have the user re-`ssh-add`. (2) A read-only `GH_TOKEN` env var can shadow a write-capable keychain login: every write (push, `pr edit`, `pr merge --auto`) returns `Resource not accessible by personal access token`. Prefix gh writes with `env -u GH_TOKEN` to fall back to keychain auth. (3) Polygraph `push_branch` does an internal `pull --rebase`, so it **cannot force-update a rebased branch** — use a direct `git push --force` (SSH/HTTPS) for those. (4) Polygraph `create_pr` intermittently 401s (`Bad credentials`) on **nrwl/nx specifically** while succeeding on sibling nrwl repos in the same batch — just **retry** the failed repo; it usually goes through on the 2nd–3rd attempt. (5) The personal `GH_TOKEN` can **push** to nrwl/nx but is **denied** (403) on some other nrwl repos (e.g. nrwl/nx-examples) and cannot **create PRs** on nrwl/nx — so for those, use Polygraph `push_branch`/`create_pr` (backend auth), and since `push_branch` is fast-forward-only, prefer **adding a new commit over amending** when you need to update an already-pushed branch. nrwl/nx PR creation may still need the pushed-branch + pre-filled compare-URL fallback if `create_pr` keeps failing.
|
||||
@@ -0,0 +1,499 @@
|
||||
---
|
||||
name: review-pr
|
||||
description: Deep code review of a single open PR in nrwl/nx. Sets up an isolated worktree, runs the pr-review-toolkit review agents, the reproduce-verifier agent (grounds the review in the linked issues and, when runnable locally, executes the repro on master vs PR), and the alternative-approach agent (independently designs competing solutions and contrasts them with the PR's choice), surfaces only critical and important findings (plus strengths; nice-to-have suggestions are dropped), and saves a GitHub-flavored draft to ~/.nx-pr-reviews/<NUMBER>.md for the reviewer to read (nothing is posted). Use when you want a thorough review of one PR.
|
||||
allowed-tools: Bash(gh pr view *), Bash(gh pr list *), Bash(gh issue view *), Bash(gh auth status*), Bash(git -C *), Bash(git worktree *), Bash(git rev-parse *), Bash(mkdir -p *), Bash(ls *), Bash(printf *), Bash(date *), Bash(cd *), Bash(test *), Bash(echo *), Bash(head *), Bash(tail *), Bash(cat *), Bash(jq *), Bash(grep *), Bash(wc *), Bash(sed *), Write(~/.nx-pr-reviews/**), Write(/tmp/**), Edit(~/.nx-pr-reviews/**), Edit(/tmp/**), Read, Grep, Glob, Skill, Agent
|
||||
argument-hint: '<PR_NUMBER> [--verify-repros]'
|
||||
---
|
||||
|
||||
# Deep PR Review (review-pr)
|
||||
|
||||
Wraps `/pr-review-toolkit:review-pr` for a remote PR in `nrwl/nx`. The toolkit reviews local changes, so this skill prepares an isolated worktree of the PR, invokes the toolkit, then collects the output into a draft suitable for posting on GitHub.
|
||||
|
||||
**Drafts only.** This skill never posts to GitHub. The draft is reading material for the reviewer; if they want any of it on the PR, they post it themselves (or ask in the session, e.g. via `gh pr review --body-file`).
|
||||
|
||||
## Inputs
|
||||
|
||||
- `<NUMBER>` — the PR number in `nrwl/nx`. Required.
|
||||
|
||||
## Configuration (env-overridable)
|
||||
|
||||
- `NX_REPO_PATH` — path to a local clone of nrwl/nx. Default: the repo you're in — `git rev-parse --show-toplevel` (this skill ships inside nrwl/nx)
|
||||
- `WORKTREE_BASE` — where to put the temporary worktree. Default: `~/.nx-pr-reviews/worktrees`
|
||||
- `TRIAGE_DIR` — where drafts live. Default: `~/.nx-pr-reviews` (drafts and worktrees share one parent, outside the repo — so `git clean` never touches drafts and re-review history survives — and outside `~/.claude`, so the skill never writes into Claude Code's own config dir)
|
||||
|
||||
## Step 1: Pre-flight
|
||||
|
||||
```bash
|
||||
gh auth status
|
||||
git -C "$NX_REPO_PATH" rev-parse --git-dir # nrwl/nx clone exists? (works for worktree-based clones too)
|
||||
mkdir -p "$WORKTREE_BASE" "$TRIAGE_DIR"
|
||||
```
|
||||
|
||||
If `gh` isn't authed or the nx clone is missing, fail fast with a clear message.
|
||||
|
||||
## Step 2: Fetch the PR metadata
|
||||
|
||||
```bash
|
||||
gh pr view <NUMBER> \
|
||||
--repo nrwl/nx \
|
||||
--json number,title,author,headRefOid,headRefName,baseRefName,url,isDraft,additions,deletions,changedFiles \
|
||||
> /tmp/pr-<NUMBER>.json
|
||||
```
|
||||
|
||||
Parse out:
|
||||
|
||||
- `title`, `author.login`, `headRefOid` (the head SHA), `headRefName`, `baseRefName`, `url`
|
||||
- `isDraft` — if true, exit early (don't review drafts)
|
||||
- **Local dedup:** if `$TRIAGE_DIR/<NUMBER>.md` exists, its frontmatter `head_sha` equals `headRefOid`, and its `verdict` is not `failed`, this PR was already reviewed at this commit — exit with no draft change; log "ALREADY_REVIEWED". A `failed` draft never blocks a retry. To deliberately re-review an unchanged PR (e.g. after the review criteria changed), delete the draft file or just say so in the session.
|
||||
|
||||
## Step 3: Set up an isolated worktree
|
||||
|
||||
```bash
|
||||
git -C "$NX_REPO_PATH" worktree prune # self-heal if a prior worktree dir was deleted out from under git
|
||||
git -C "$NX_REPO_PATH" fetch origin pull/<NUMBER>/head:pr-<NUMBER>
|
||||
git -C "$NX_REPO_PATH" worktree add "$WORKTREE_BASE/pr-<NUMBER>" "pr-<NUMBER>"
|
||||
```
|
||||
|
||||
Worktrees keep the main checkout untouched. The branch name `pr-<NUMBER>` makes the worktree easy to identify and clean up later.
|
||||
|
||||
## Step 4: Gather incremental-review context (only if a prior review exists)
|
||||
|
||||
If `$TRIAGE_DIR/<NUMBER>.md` already exists and its `verdict` is not `failed`, this is a **re-review** triggered by new commits. Build context for the toolkit so it can be conversational instead of starting fresh.
|
||||
|
||||
(If the existing draft's `verdict` is `failed`, the prior attempt produced no usable review — skip this step and review fresh. The file's history is still preserved by Step 8.)
|
||||
|
||||
1. Read the existing triage file. Extract:
|
||||
- The frontmatter `head_sha` (call it `$PRIOR_SHA`).
|
||||
- The `## Review draft` section (the most recent review). This becomes "the prior review."
|
||||
- The full `## Prior reviews` section (older reviews, if any). All of them — no cap on history.
|
||||
|
||||
2. Fetch `$PRIOR_SHA` so we can diff against it:
|
||||
|
||||
```bash
|
||||
git -C "$NX_REPO_PATH" fetch origin "$PRIOR_SHA"
|
||||
```
|
||||
|
||||
(If `$PRIOR_SHA` no longer exists on the remote — author force-pushed and orphaned it — skip this step and treat as a fresh review.)
|
||||
|
||||
3. Compute the incremental diff inside the worktree:
|
||||
|
||||
```bash
|
||||
git -C "$WORKTREE_BASE/pr-<NUMBER>" diff "$PRIOR_SHA".."<HEAD_REF_OID>" > /tmp/pr-<NUMBER>-incremental.diff
|
||||
```
|
||||
|
||||
4. Write a context file at `$WORKTREE_BASE/pr-<NUMBER>/.review-context.md`:
|
||||
|
||||
```markdown
|
||||
# Re-review context
|
||||
|
||||
This PR has been reviewed before. The prior review's verdict was: <PRIOR_VERDICT>.
|
||||
|
||||
## Most recent prior review (head_sha=$PRIOR_SHA)
|
||||
|
||||
<PASTE THE PRIOR REVIEW DRAFT VERBATIM>
|
||||
|
||||
## All earlier reviews (oldest first)
|
||||
|
||||
<PASTE THE FULL ## Prior reviews SECTION VERBATIM>
|
||||
|
||||
## Diff since last review (`$PRIOR_SHA..<HEAD>`)
|
||||
|
||||
See /tmp/pr-<NUMBER>-incremental.diff for the new code added since the prior review.
|
||||
|
||||
## Review focus
|
||||
|
||||
Focus on the diff since the last review. For unchanged code, only verify
|
||||
whether the prior findings above still hold — do not re-analyze it from scratch.
|
||||
```
|
||||
|
||||
## Step 4.5: Close-without-merge check
|
||||
|
||||
Before running the toolkit, do a cheap pass to answer: **"Should this PR be closed without merging?"** Two flavors:
|
||||
|
||||
- **Superseded** — master or another PR already addressed the goal.
|
||||
- **Unnecessary** — the change shouldn't be merged at all (no real bug, abandoned, out of scope, duplicate of rejected work).
|
||||
|
||||
Both save the toolkit's effort on PRs that won't merge anyway. Signals 1–4 detect supersession; signals 6–8 detect unnecessary; signal 5 detects an unconfirmed bug (it can push to `blocked`, never to a close). Run the gh-only signals here. Signal 5 depends on the reproduce-verifier and is finalized after Step 5a.5.
|
||||
|
||||
These signals close other people's work, so bias every judgment call toward the contributor: when a signal is ambiguous, treat it as not fired.
|
||||
|
||||
### Supersession signals (gh-only, run now)
|
||||
|
||||
**1. Mergeability.** If master moved in the same files, the PR is stale.
|
||||
|
||||
```bash
|
||||
gh pr view <NUMBER> --repo nrwl/nx --json mergeable,mergeStateStatus
|
||||
```
|
||||
|
||||
Flag if `mergeable == "CONFLICTING"` or `mergeStateStatus == "DIRTY"`.
|
||||
|
||||
**2. Cross-references on linked issues.** Has another _merged_ PR referenced the same issue?
|
||||
Parse `closingIssuesReferences` from the PR body + `gh pr view` (look for `Fixes #N`, `Closes #N`, `Resolves #N`). For each linked issue:
|
||||
|
||||
```bash
|
||||
gh issue view <ISSUE> --repo nrwl/nx --json timelineItems --jq '.timelineItems[] | select(.__typename == "CrossReferencedEvent") | select(.source.__typename == "PullRequest") | {pr: .source.number, state: .source.state, merged: .source.merged, mergedAt: .source.mergedAt, title: .source.title}'
|
||||
```
|
||||
|
||||
Flag any other PR with `merged: true` — that PR may have fixed the same issue.
|
||||
|
||||
**3. Same-file merged PRs since this PR opened.** Identify possibly-competing work.
|
||||
Get the PR's `createdAt` and `files[].path`, then:
|
||||
|
||||
```bash
|
||||
gh pr list --repo nrwl/nx --state merged --search "<FILE_PATH> merged:><PR_CREATED_AT>" --json number,title,mergedAt --limit 5
|
||||
```
|
||||
|
||||
Pick the 2-3 most-touched _distinctive_ files — skip monorepo hot files (`package.json`, lockfiles, `migrations.json`, `versions.ts`) that unrelated PRs touch constantly. Only flag a hit when the merged PR's title suggests the same goal as this one; same-file overlap alone is not competing work.
|
||||
|
||||
**4. Target-state check.** For small PRs (< 50 lines changed OR touches only `package.json` / `versions.ts` / `migrations.json`), peek at master to see if the target state is already there.
|
||||
|
||||
Read each changed file on master (`git -C $NX_REPO_PATH show origin/master:<path>`) and compare key lines against what the PR is trying to set. Example: if the PR changes `"@foo/bar": "^1.0.0"` → `"^2.0.0"` but master already has `"^2.3.3"`, flag it.
|
||||
|
||||
For larger PRs, skip this — the toolkit will catch subtler issues.
|
||||
|
||||
### Unnecessary signals
|
||||
|
||||
**5. Bug not confirmable.** Finalized after Step 5a.5. If the reproduce-verifier returns `BUG_NOT_REPRODUCED_ON_BASELINE`, treat that as _inconclusive_, not proof of a non-bug — many nx bugs are environment-specific (package manager, OS, node version), so a local non-repro proves little. Look for corroboration in the linked issue instead:
|
||||
|
||||
```bash
|
||||
# Has a maintainer engaged with the issue?
|
||||
gh issue view <ISSUE> --repo nrwl/nx --json comments --jq '[.comments[].author.login]'
|
||||
```
|
||||
|
||||
If no nrwl-org member has confirmed the bug AND the PR body offers no rationale of its own (no root-cause explanation, no design-doc link), the right outcome is a question, not a closure: flag it, push the verdict toward `blocked`, and have the draft ask the author for a runnable reproduction. This signal never forces `unnecessary`.
|
||||
|
||||
**6. Stale + abandoned + conflicted.** All three together:
|
||||
|
||||
- Last commit on the PR branch > 90 days ago: parse `commits[-1].committedDate` from `gh pr view ... --json commits`.
|
||||
- Has merge conflicts (signal 1 fired).
|
||||
- Has unanswered reviewer questions: most recent non-author comment is unanswered. Check via `gh pr view <NUMBER> --json comments --jq '.comments | map({author: .author.login, at: .createdAt}) | last'` — if the last commenter is not the author and the timestamp is > 30 days old, it's unanswered.
|
||||
|
||||
If all three fire, the PR is abandoned and unlikely to land. Any sign of recent author engagement (a comment within the last 30 days, even without new commits) resets this signal — prefer the stale-branch advisory instead.
|
||||
|
||||
**7. Duplicate of recently-closed-without-merge PR.** Search closed-but-not-merged PRs touching the same primary file in the last 6 months:
|
||||
|
||||
```bash
|
||||
gh pr list --repo nrwl/nx --state closed --search "<MAIN_FILE_PATH> closed:>$(date -d '6 months ago' +%Y-%m-%d 2>/dev/null || date -v-6m +%Y-%m-%d)" --json number,title,closedAt,state,mergedAt --limit 10
|
||||
```
|
||||
|
||||
Filter to entries where `mergedAt` is null (closed without merging). Only flag when a closed PR has a clearly similar title or approach — not merely the same file — and note that the prior close may have been for fixable reasons (stale, author gave up), which weakens the signal.
|
||||
|
||||
**8. No linked issue + speculative scope.** All of:
|
||||
|
||||
- No `Fixes #N` / `Closes #N` / `Resolves #N` reference in body or commits.
|
||||
- The PR body doesn't explain _why_ the change is needed — no motivation, no linked discussion. Judge the substance, not the length.
|
||||
- PR modifies > 100 lines OR touches public-API surface (`packages/*/src/index.ts`, files matching `*.public.ts`, anything under `packages/*/index.ts`).
|
||||
|
||||
Speculative refactors without a stated reason are usually closed. Advisory-strength signal — flag in the section, but don't on its own force a verdict.
|
||||
|
||||
### Emit
|
||||
|
||||
If any signal fires, prepend a `### Close-without-merge check` section to `$REVIEW_BODY` (above `### Reproduction verification`):
|
||||
|
||||
```markdown
|
||||
### Close-without-merge check
|
||||
|
||||
<pick the strongest line — only one verdict-line, but multiple advisory lines OK:>
|
||||
|
||||
- 🛑 **Likely superseded.** <reason, with linked PR numbers / file evidence>
|
||||
- 🛑 **Likely unnecessary.** <reason — name the signal(s) that fired: abandoned, duplicate of #N, etc.>
|
||||
- ⚠️ **Bug unconfirmed.** Couldn't reproduce the linked issue on master and found no maintainer confirmation — the draft should ask the author for a runnable repro.
|
||||
- ⚠️ **Stale branch.** Merge conflicts with master on <N> files; author should rebase before review lands.
|
||||
- ⚠️ **Speculative scope.** No linked issue and no stated motivation for a large change.
|
||||
- ✅ No close signals — PR is current and well-scoped.
|
||||
```
|
||||
|
||||
**Verdict influence (Step 7):**
|
||||
|
||||
- **Superseded (strong)** → verdict `superseded`. "Strong" means ANY of: signal 2 fires (another merged PR closes the same issue), OR signals 3+4 both fire (same-file merged PR AND master already at/past the PR's target state). The section should include the specific superseding PR number(s) so whoever closes the PR has a concrete pointer to cite.
|
||||
- **Unnecessary (strong)** → verdict `unnecessary`. "Strong" means ANY of: signal 6 fires (stale + abandoned + conflicted, no recent author engagement), OR signal 7 fires (duplicate of declined work with clearly matching scope). Signal 5 is never part of this — an unconfirmed bug pushes toward `blocked` with an ask-the-author question, not toward a close.
|
||||
- **Both fire** → supersession wins (more specific framing, gives the author a concrete pointer).
|
||||
- **Stale branch alone** (only signal 1) → advisory; still run the toolkit, still pick a verdict normally.
|
||||
- **Speculative scope alone** (only signal 8) → advisory; note it in the review body, don't force a verdict.
|
||||
- **Clean** → no section emitted.
|
||||
|
||||
If all signals are cheap-negative, skip emitting the section entirely (no noise on healthy PRs).
|
||||
|
||||
### Early exit on a strong close signal
|
||||
|
||||
If **superseded (strong)** or **unnecessary (strong)** fired, skip Steps 5 through 5b entirely (toolkit, alternative-approach, reproduce-verifier, reconciliation). The verdict precedence in Step 7 already decides the outcome, so agent findings can't change it — and nobody acts on code feedback for a PR that won't merge. Set `$REVIEW_BODY` to just the `### Close-without-merge check` section and continue with Steps 6-10 as normal.
|
||||
|
||||
## Step 5: Run the review toolkit
|
||||
|
||||
First, write a review charter at `$WORKTREE_BASE/pr-<NUMBER>/.review-charter.md` so the agents self-filter up front instead of generating findings that get trimmed later:
|
||||
|
||||
```markdown
|
||||
# Review charter
|
||||
|
||||
Report only **critical** and **important** findings, plus **strengths**. Do not
|
||||
produce a suggestions / nice-to-have section — polish-level feedback will be
|
||||
discarded unread.
|
||||
|
||||
Apply the following standing maintainer calibrations; a finding matching one of
|
||||
these is advisory at most and not worth writing up:
|
||||
|
||||
<COPY THE FULL "Nx-specific calibration" LIST FROM THIS SKILL, VERBATIM>
|
||||
```
|
||||
|
||||
Then `cd` into the worktree and invoke the toolkit:
|
||||
|
||||
```
|
||||
Skill(skill="pr-review-toolkit:review-pr", args="code errors tests comments types")
|
||||
```
|
||||
|
||||
The `simplify` aspect is deliberately omitted — code-simplifier's output is nice-to-have polish by definition, all of which the trim below would discard. The toolkit dispatches the applicable review agents (code-reviewer, comment-analyzer, pr-test-analyzer, silent-failure-hunter, type-design-analyzer) and aggregates results into Critical / Important / Strengths.
|
||||
|
||||
Instruct the toolkit to read `.review-charter.md` first — and `.review-context.md` too if it exists (from Step 4), so its agents are aware of the prior review and focus on what's new.
|
||||
|
||||
Capture the toolkit's full output as `$RAW_REVIEW_BODY`.
|
||||
|
||||
### Trim to critical + important
|
||||
|
||||
**Only critical and important findings are kept.** The charter tells the agents not to produce suggestions; this trim is the backstop for when they do anyway. After capturing `$RAW_REVIEW_BODY`, drop any **Suggestions** / nice-to-have section — discard those findings, do not downgrade or relocate them. Keep **Critical**, **Important**, and **Strengths**. The trimmed text is what flows into the steps below (reconciliation in Step 5b, formatting in Step 6).
|
||||
|
||||
### Nx-specific calibration
|
||||
|
||||
These standing maintainer calibrations encode this repo's review culture. The charter (Step 5) hands them to the agents up front; re-check the surviving findings against them here — anything that slipped through gets downgraded now. A finding matching one of these is at most a compact one-line advisory note in the draft and **never drives the verdict**:
|
||||
|
||||
1. **Test-coverage gaps are advisory.** Untested branches or missing edge-case fixtures never push needs-changes on their own; only code defects, silently-wrong behavior, and inaccurate comments/docs block a PR. Exception: false coverage — a test that asserts the wrong behavior or cannot fail — is a correctness defect, keep it.
|
||||
2. **No test demands for deprecation warnings, legacy branches, or telemetry wiring.** Untested deprecation warnings, un-mirrored legacy branches, never-throw wrapper contracts, and event-emission wiring at call sites are non-findings. Unit-testable logic inside such modules (e.g. PII redaction, classification helpers) is still fair game.
|
||||
3. **Silent migrations are fine.** Missing `logger.warn`/`logger.info` in migration files (`packages/*/src/migrations/**`) is not a concern — migration-time silence is by design. Silent _correctness_ failures still count.
|
||||
4. **Migrations never remove dependencies.** Don't flag a migration for leaving a now-redundant dep in the user's package.json; the user may import it directly. Removal is a judgment call that stays with the user.
|
||||
5. **Migration metadata is inside the trust boundary.** `nx migrate` already runs migrations as arbitrary code, so `migrations.json` content flowing into prompts, paths, or logs is not a prompt-injection or path-traversal finding. Only flag sanitization when input crosses a _new_ trust boundary (HTTP endpoints, runtime user input).
|
||||
6. **Intentionally-kept temp dirs.** The `nx migrate` install dir and `nx release` scratch dirs are deliberately left on disk as a post-mortem debugging aid. Not a leak; don't ask for cleanup.
|
||||
7. **Pre-existing behavior isn't Important.** Before rating a finding Important, verify it's net-new in the diff: does unchanged sibling code follow the same pattern? Did the behavior exist before the PR (check the base, look for tests pinning it)? If either is yes, it's advisory at most.
|
||||
8. **Deliberate, tested, documented design decisions aren't blockers.** A behavior change pinned by new tests and documented in JSDoc or the PR body is intentional — the right ask is a callout in the PR description, not a change request.
|
||||
9. **Don't demand defensive guards.** The repo prefers fixing an invariant at its source with one descriptive error at the true failure point over scattered guards, warnings, and version checks. Absence of extra defensive coding is not a finding.
|
||||
|
||||
## Step 5a: Run the alternative-approach agent
|
||||
|
||||
In parallel with Step 5, dispatch the `alternative-approach` agent — the toolkit answers "is this code correct?", this agent answers "is this the right solution at all?":
|
||||
|
||||
```
|
||||
Agent(
|
||||
subagent_type="alternative-approach",
|
||||
description="Contrast PR <NUMBER> approach with alternatives",
|
||||
prompt="""
|
||||
Evaluate whether PR <NUMBER> in nrwl/nx takes the right approach to the problem it solves.
|
||||
|
||||
Inputs:
|
||||
- PR_NUMBER: <NUMBER>
|
||||
- WORKTREE_PATH: <WORKTREE_BASE>/pr-<NUMBER>
|
||||
- BASE_REF: <BASE_REF_NAME>
|
||||
|
||||
Read .review-charter.md in the worktree first. Follow your standard workflow and return the structured report.
|
||||
"""
|
||||
)
|
||||
```
|
||||
|
||||
Capture the output as `$APPROACH_REPORT` and fold it into the review body as `### Approach analysis`, below `### Reproduction verification` and above the findings. Verdict influence (Step 7):
|
||||
|
||||
- `APPROACH_INSUFFICIENT` — counts as a critical finding (the fix provably misses cases).
|
||||
- `BETTER_ALTERNATIVE_EXISTS` — counts as an important finding, with the sketch as the ask.
|
||||
- `APPROACH_SOUND` — fold the endorsement into **Strengths** as a one-liner; no finding.
|
||||
|
||||
## Step 5a.5: Run the reproduce-verifier agent
|
||||
|
||||
In parallel with Step 5, dispatch the `reproduce-verifier` agent to ground the review in the reported bug.
|
||||
|
||||
The verifier flips the checkout between base and HEAD for its Level 1 baseline runs, so it gets its **own** worktree — the review agents keep reading `pr-<NUMBER>` undisturbed:
|
||||
|
||||
```bash
|
||||
git -C "$NX_REPO_PATH" worktree add --detach "$WORKTREE_BASE/pr-<NUMBER>-verify" <HEAD_REF_OID>
|
||||
```
|
||||
|
||||
(Detached on purpose: the `pr-<NUMBER>` branch is already checked out by the review worktree, and the verifier only ever checks out SHAs.)
|
||||
|
||||
Decide whether to opt in to Level 2 (expensive verdaccio-based external-repo reproduction, ~10-15 min per PR). Default is **off** — Level 2 only runs when:
|
||||
|
||||
- The caller of this skill explicitly requested deep verification (e.g. invoked with the `--verify-external-repros` flag, or a manual `/review-pr <N> --verify-repros` pattern), OR
|
||||
- `$NX_REVIEW_LEVEL_2=1` is set in the environment.
|
||||
|
||||
Level 2 is for deep-dive passes where you want end-user-level proof — each run takes ~10-15 minutes and ~0.5-1 GB of disk, so opt in deliberately.
|
||||
|
||||
```
|
||||
Agent(
|
||||
subagent_type="reproduce-verifier",
|
||||
description="Verify PR <NUMBER> fixes linked issues",
|
||||
prompt="""
|
||||
Verify that PR <NUMBER> in nrwl/nx actually fixes the issues it claims to close.
|
||||
|
||||
Inputs:
|
||||
- PR_NUMBER: <NUMBER>
|
||||
- WORKTREE_PATH: <WORKTREE_BASE>/pr-<NUMBER>-verify
|
||||
- HEAD_SHA: <HEAD_REF_OID>
|
||||
- BASE_REF: <BASE_REF_NAME>
|
||||
- RUN_LEVEL_2: <true|false — see gate above>
|
||||
|
||||
Follow your standard workflow (Level 0 always, Level 1 when applicable, Level 2 only when RUN_LEVEL_2=true AND classification is EXTERNAL_REPO or GENERATED_WORKSPACE). Return the structured report.
|
||||
"""
|
||||
)
|
||||
```
|
||||
|
||||
Capture the agent's output as `$REPRO_REPORT`. Fold it into the final review body under a dedicated `### Reproduction verification` section, positioned above `### Critical` so readers see the grounding before the code findings. The agent's Level 1 / Level 2 verdicts feed into the overall verdict (Step 7):
|
||||
|
||||
**Level 1 verdicts:**
|
||||
|
||||
- `FIX_CONFIRMED` — evidence towards `lgtm`
|
||||
- `FIX_DID_NOT_WORK` / `FIX_CHANGED_BEHAVIOR_BUT_NOT_RESOLVED` — strong push towards `needs-changes` regardless of toolkit findings
|
||||
- `BUG_NOT_REPRODUCED_ON_BASELINE` — push towards `blocked` pending human check (could mean stale issue, wrong command, or the PR is unnecessary)
|
||||
- `NOT_ATTEMPTED` — no effect on verdict; note it in the summary
|
||||
|
||||
**Level 2 verdicts (only present when opted in):**
|
||||
|
||||
- `PR_REPRO_PASSES` — strong evidence towards `lgtm` (PR verified against actual repro)
|
||||
- `PR_REPRO_FAILS` / `PR_REPRO_FAILS_DIFFERENT` — strong push towards `needs-changes`
|
||||
- `PR_REPRO_INCONCLUSIVE` / `SETUP_FAILED` — flag in summary; do not use for verdict
|
||||
|
||||
## Step 5b: Reconcile against prior reviews (only on re-review)
|
||||
|
||||
If a prior review exists, do a second pass _yourself_ (don't dispatch another agent — you already have all the context). Work only from the trimmed findings (critical / important — Suggestions were already dropped in Step 5). For each finding:
|
||||
|
||||
- Was the same concern raised in a prior review and now appears resolved? → move it under **Addressed since last review**.
|
||||
- Was the same concern raised in a prior review and still present? → move it under **Still concerning** with a note like "raised in <date>".
|
||||
- Is it a new finding (not in any prior review)? → keep under **New concerns**.
|
||||
|
||||
Reorganize the toolkit output into this structure:
|
||||
|
||||
```markdown
|
||||
## Addressed since last review
|
||||
|
||||
- <findings the author has fixed since the prior review>
|
||||
|
||||
## Still concerning
|
||||
|
||||
- <findings raised before that haven't been addressed>
|
||||
|
||||
## New concerns
|
||||
|
||||
- <findings about code added since the prior review>
|
||||
|
||||
## Strengths
|
||||
|
||||
- <positive observations>
|
||||
```
|
||||
|
||||
If this is the first review (no triage file existed), skip this step entirely — just use the toolkit output verbatim.
|
||||
|
||||
The reconciled (or fresh) text becomes `$REVIEW_BODY`.
|
||||
|
||||
## Step 6: Format for GitHub
|
||||
|
||||
`$REVIEW_BODY` is posted as-is — no header, footer, or tool attribution. It should read like a review a maintainer wrote. The review metadata (commit, date, attempt) lives in the triage file's frontmatter, not in the posted body.
|
||||
|
||||
## Step 7: Determine verdict
|
||||
|
||||
Check in this order (first match wins):
|
||||
|
||||
- Close-without-merge check emitted "Likely superseded" with strong evidence (see Step 4.5) → `verdict: superseded`
|
||||
- Close-without-merge check emitted "Likely unnecessary" with strong evidence (see Step 4.5) → `verdict: unnecessary`
|
||||
- Has any **Still concerning** or **New concerns** items rated critical → `verdict: needs-changes`
|
||||
- Has 3+ items across Still concerning + New concerns → `verdict: needs-changes`
|
||||
- Couldn't reach a clear conclusion → `verdict: blocked`
|
||||
- Otherwise → `verdict: lgtm`
|
||||
|
||||
(For first reviews with no prior context, fall back to the toolkit's Critical/Important categories.)
|
||||
|
||||
**Verdict values:** `lgtm | needs-changes | blocked | superseded | unnecessary | failed`.
|
||||
|
||||
- `superseded` — the PR shouldn't merge because other work already landed; the draft carries a pointer to the superseding PR for whoever closes it.
|
||||
- `unnecessary` — the PR shouldn't merge at all (no confirmed bug, abandoned, or duplicate of rejected work); the draft carries the reason from the close-without-merge check.
|
||||
|
||||
## Step 8: Write the triage file (preserving full history)
|
||||
|
||||
Write `$TRIAGE_DIR/<NUMBER>.md`. **If the file already exists** (re-review):
|
||||
|
||||
1. Read the existing file.
|
||||
2. Move the existing `## Review draft` content into a new entry at the top of `## Prior reviews`, prefixed with a header like `### attempt <N-1> — head_sha=<PRIOR_SHA> — <PRIOR_DATE>`.
|
||||
3. Preserve the `## Posted` and `## Failures` sections verbatim.
|
||||
4. Replace `## Review draft` with the new `$REVIEW_BODY` (formatted in Step 6).
|
||||
5. Update frontmatter: `head_sha`, `last_reviewed_at`, `verdict`, increment `attempt`. Preserve `posted_at` / `posted_url` (the user fills those in).
|
||||
|
||||
**No cap on history** — every prior review accumulates under `## Prior reviews`, oldest at the bottom, newest at the top.
|
||||
|
||||
Format:
|
||||
|
||||
```markdown
|
||||
---
|
||||
pr: <NUMBER>
|
||||
title: <TITLE>
|
||||
author: <AUTHOR>
|
||||
url: <URL>
|
||||
head_sha: <HEAD_REF_OID>
|
||||
last_reviewed_at: <ISO_8601>
|
||||
verdict: <lgtm|needs-changes|blocked|superseded|unnecessary|failed>
|
||||
attempt: <N>
|
||||
posted_at:
|
||||
posted_url:
|
||||
---
|
||||
|
||||
# PR #<NUMBER>: <TITLE>
|
||||
|
||||
<AUTHOR> · <ADDITIONS>+/<DELETIONS>- across <CHANGED_FILES> files
|
||||
HEAD: `<HEAD_SHA_SHORT>` · base: `<BASE_REF>`
|
||||
|
||||
## Review draft
|
||||
|
||||
<FORMATTED_BODY_FROM_STEP_6>
|
||||
|
||||
## Prior reviews
|
||||
|
||||
### attempt <N-1> — head_sha=<PRIOR_SHA> — <PRIOR_DATE>
|
||||
|
||||
<the previous Review draft, verbatim>
|
||||
|
||||
### attempt <N-2> — head_sha=<EVEN_PRIOR_SHA> — <DATE>
|
||||
|
||||
<and so on — oldest at the bottom>
|
||||
|
||||
## Posted
|
||||
|
||||
(none yet, or whatever was already there)
|
||||
|
||||
## Failures
|
||||
|
||||
(none, or whatever was already there)
|
||||
```
|
||||
|
||||
## Step 9: Cleanup
|
||||
|
||||
Always remove both worktrees, even on failure (the `-verify` one may not exist on early-exit runs — ignore that error):
|
||||
|
||||
```bash
|
||||
git -C "$NX_REPO_PATH" worktree remove --force "$WORKTREE_BASE/pr-<NUMBER>" 2>/dev/null
|
||||
git -C "$NX_REPO_PATH" worktree remove --force "$WORKTREE_BASE/pr-<NUMBER>-verify" 2>/dev/null
|
||||
git -C "$NX_REPO_PATH" branch -D "pr-<NUMBER>" 2>/dev/null
|
||||
```
|
||||
|
||||
## Step 10: Commit the draft (only for durable triage dirs)
|
||||
|
||||
Some maintainers point `TRIAGE_DIR` at a synced git repo (e.g. dotfiles) to keep draft history. Commit only when the draft is actually trackable there — i.e. `git -C "$TRIAGE_DIR" rev-parse --is-inside-work-tree` succeeds AND `git -C "$TRIAGE_DIR" check-ignore -q <NUMBER>.md` does NOT match:
|
||||
|
||||
```bash
|
||||
git -C "$TRIAGE_DIR" add <NUMBER>.md
|
||||
git -C "$TRIAGE_DIR" commit -m "review: drafted review for PR #<NUMBER> (attempt <N>)"
|
||||
```
|
||||
|
||||
This makes the draft history visible (`git -C "$TRIAGE_DIR" log --oneline`) and gives a per-attempt audit trail.
|
||||
|
||||
Otherwise skip this step silently — the file on disk is the record. (The default `~/.nx-pr-reviews` is typically not a git repo, so this step is a no-op unless you've made it one.)
|
||||
|
||||
## On failure
|
||||
|
||||
If anything in Steps 3-7 errors:
|
||||
|
||||
1. Still write/update the triage file with `verdict: failed` and a `## Failures` entry containing the error.
|
||||
2. Still preserve any prior `## Review draft` content into `## Prior reviews` so history isn't lost.
|
||||
3. Still clean up the worktree (Step 9).
|
||||
4. Commit with a `failed` message instead (same guard as Step 10).
|
||||
5. Return non-zero so the caller can tell the review failed.
|
||||
|
||||
## Returning the draft
|
||||
|
||||
Print to stdout the path to the saved triage file:
|
||||
|
||||
```
|
||||
$TRIAGE_DIR/<NUMBER>.md verdict=<VERDICT>
|
||||
```
|
||||
|
||||
The caller can grep this to know what happened without re-reading the file.
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
name: run-nx-generator
|
||||
description: Run Nx generators with prioritization for workspace-plugin generators. Use this when generating code, scaffolding new features, or automating repetitive tasks in the monorepo.
|
||||
allowed-tools: Bash, Read, Glob, Grep, mcp__nx-mcp__nx_generators, mcp__nx-mcp__nx_generator_schema
|
||||
---
|
||||
|
||||
# Run Nx Generator
|
||||
|
||||
This skill helps you execute Nx generators efficiently, with special focus on workspace-plugin generators from your internal tooling.
|
||||
|
||||
## Generator Priority List
|
||||
|
||||
Use the `mcp__nx-mcp__nx_generator_schema` tool to get more information about how to use the generator
|
||||
|
||||
Choose which generators to run in this priority order:
|
||||
|
||||
### 🔥 Workspace-Plugin Generators (High Priority)
|
||||
|
||||
These are your custom internal tools in `tools/workspace-plugin/`
|
||||
|
||||
### 📦 Core Nx Generators (Standard)
|
||||
|
||||
Only use these if workspace-plugin generators don't fit:
|
||||
|
||||
- `nx generate @nx/devkit:...` - DevKit utilities
|
||||
- `nx generate @nx/node:...` - Node.js libraries
|
||||
- `nx generate @nx/react:...` - React components and apps
|
||||
- Framework-specific generators
|
||||
|
||||
## How to Run Generators
|
||||
|
||||
1. **List available generators**:
|
||||
|
||||
2. **Get generator schema** (to see available options):
|
||||
Use the `mcp__nx-mcp__nx_generator_schema` tool to get more information about how to use the generator
|
||||
|
||||
3. **Run the generator**:
|
||||
|
||||
```bash
|
||||
nx generate [generator-path] [options]
|
||||
```
|
||||
|
||||
4. **Verify the changes**:
|
||||
- Review generated files
|
||||
- Run tests: `nx affected -t test`
|
||||
- Format code: `npx prettier --write [files]`
|
||||
|
||||
## Best Practices
|
||||
|
||||
- ✅ Always check workspace-plugin first - it has your custom solutions
|
||||
- ✅ Use `--dry-run` flag to preview changes before applying
|
||||
- ✅ Format generated code immediately with Prettier
|
||||
- ✅ Test affected projects after generation
|
||||
- ✅ Commit generator changes separately from manual edits
|
||||
|
||||
## Examples
|
||||
|
||||
### Bumping Maven Version
|
||||
|
||||
When updating the Maven plugin version, use the workspace-plugin generator:
|
||||
|
||||
```bash
|
||||
nx generate @nx/workspace-plugin:bump-maven-version \
|
||||
--newVersion 0.0.10 \
|
||||
--nxVersion 22.1.0-beta.7
|
||||
```
|
||||
|
||||
This automates all the version bumping instead of manual file edits.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when you need to:
|
||||
|
||||
- Generate new code or projects
|
||||
- Scaffold new features or libraries
|
||||
- Automate repetitive setup tasks
|
||||
- Update internal tools and configurations
|
||||
- Create migrations or version updates
|
||||
@@ -0,0 +1,480 @@
|
||||
---
|
||||
name: ci-watcher
|
||||
description: Polls Nx Cloud CI pipeline and self-healing status. Returns structured state when actionable. Spawned by /nx-cloud-ci-monitor command to monitor CI Attempt status.
|
||||
model: fast
|
||||
---
|
||||
|
||||
# CI Watcher Subagent
|
||||
|
||||
You are a CI monitoring subagent responsible for polling Nx Cloud CI Attempt status and self-healing state. You report status back to the main agent - you do NOT make apply/reject decisions.
|
||||
|
||||
## Your Responsibilities
|
||||
|
||||
1. Poll CI status using the `ci_information` MCP tool
|
||||
2. Implement exponential backoff between polls
|
||||
3. Return structured state when an actionable condition is reached
|
||||
4. Track iteration count and elapsed time
|
||||
5. Output status updates based on verbosity level
|
||||
|
||||
## Input Parameters (from Main Agent)
|
||||
|
||||
The main agent may provide these optional parameters in the prompt:
|
||||
|
||||
| Parameter | Description |
|
||||
| ------------------- | -------------------------------------------------------- |
|
||||
| `branch` | Branch to monitor (auto-detected if not provided) |
|
||||
| `expectedCommitSha` | Commit SHA that should trigger a new CI Attempt |
|
||||
| `previousCipeUrl` | CI Attempt URL before the action (to detect change) |
|
||||
| `subagentTimeout` | Polling timeout in minutes (default: 60) |
|
||||
| `verbosity` | Output level: minimal, medium, verbose (default: medium) |
|
||||
|
||||
When `expectedCommitSha` or `previousCipeUrl` is provided, you must detect whether a new CI Attempt has spawned.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
### `ci_information`
|
||||
|
||||
**Input:**
|
||||
|
||||
```json
|
||||
{
|
||||
"branch": "string (optional, defaults to current git branch)",
|
||||
"select": "string (optional, comma-separated field names)",
|
||||
"pageToken": "number (optional, 0-based pagination for long strings)"
|
||||
}
|
||||
```
|
||||
|
||||
**Output:**
|
||||
|
||||
```json
|
||||
{
|
||||
"cipeStatus": "NOT_STARTED | IN_PROGRESS | SUCCEEDED | FAILED | CANCELED | TIMED_OUT",
|
||||
"cipeUrl": "string",
|
||||
"branch": "string",
|
||||
"commitSha": "string | null",
|
||||
"failedTaskIds": "string[]",
|
||||
"verifiedTaskIds": "string[]",
|
||||
"selfHealingEnabled": "boolean",
|
||||
"selfHealingStatus": "NOT_STARTED | IN_PROGRESS | COMPLETED | FAILED | NOT_EXECUTABLE | null",
|
||||
"verificationStatus": "NOT_STARTED | IN_PROGRESS | COMPLETED | FAILED | NOT_EXECUTABLE | null",
|
||||
"userAction": "NONE | APPLIED | REJECTED | APPLIED_LOCALLY | APPLIED_AUTOMATICALLY | null",
|
||||
"failureClassification": "string | null",
|
||||
"taskOutputSummary": "string | null",
|
||||
"suggestedFixReasoning": "string | null",
|
||||
"suggestedFixDescription": "string | null",
|
||||
"suggestedFix": "string | null",
|
||||
"shortLink": "string | null",
|
||||
"couldAutoApplyTasks": "boolean | null",
|
||||
"confidence": "number | null",
|
||||
"confidenceReasoning": "string | null"
|
||||
}
|
||||
```
|
||||
|
||||
**Select Parameter:**
|
||||
|
||||
| Usage | Returns |
|
||||
| --------------- | ----------------------------------------------------------- |
|
||||
| No `select` | Formatted overview (truncated, not recommended for polling) |
|
||||
| Single field | Raw value with pagination for long strings |
|
||||
| Multiple fields | Object with requested field values |
|
||||
|
||||
**Field Sets for Efficient Polling:**
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS:
|
||||
'cipeUrl,commitSha,cipeStatus'
|
||||
# Minimal fields for detecting new CI Attempt
|
||||
|
||||
LIGHT_FIELDS:
|
||||
'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,shortLink,confidence,confidenceReasoning'
|
||||
# Status fields for determining actionable state
|
||||
|
||||
HEAVY_FIELDS:
|
||||
'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
# Large content fields - fetch only when returning to main agent
|
||||
```
|
||||
|
||||
## Initial Wait
|
||||
|
||||
Before first poll, wait based on context:
|
||||
|
||||
- **Fresh start (no expected CIPE):** Wait 60 seconds to allow CI to start
|
||||
- **Expecting new CIPE:** Wait 30 seconds (action already triggered)
|
||||
|
||||
**IMPORTANT:** Always run sleep in foreground, NOT as background command.
|
||||
|
||||
```bash
|
||||
sleep 60 # or 30 if expecting new CIPE (FOREGROUND, not background)
|
||||
```
|
||||
|
||||
## Two-Phase Operation
|
||||
|
||||
The subagent operates in one of two modes depending on input:
|
||||
|
||||
### Mode 1: Fresh Start (no `expectedCommitSha` or `previousCipeUrl`)
|
||||
|
||||
Normal polling - process whatever CIPE is returned by `ci_information`.
|
||||
|
||||
### Mode 2: Wait-for-New-CIPE (when `expectedCommitSha` or `previousCipeUrl` provided)
|
||||
|
||||
**CRITICAL**: When expecting a new CIPE, the subagent must **completely ignore** the old/stale CIPE. Do NOT process its status, do NOT return actionable states based on it.
|
||||
|
||||
#### Phase A: Wait Mode
|
||||
|
||||
1. Start a **new-CIPE timeout** timer (default: 30 minutes)
|
||||
2. On each poll of `ci_information`:
|
||||
- Check if CIPE is NEW:
|
||||
- `cipeUrl` differs from `previousCipeUrl` → **new CIPE detected**
|
||||
- `commitSha` matches `expectedCommitSha` → **correct CIPE detected**
|
||||
- If still OLD CIPE: **ignore all status fields**, just wait and poll again
|
||||
- Do NOT return `fix_available`, `ci_success`, etc. based on old CIPE!
|
||||
3. Output wait status (see below)
|
||||
4. If timeout (30 min) reached → return `no_new_cipe`
|
||||
|
||||
#### Phase B: Normal Polling (after new CIPE detected)
|
||||
|
||||
Once new CIPE is detected:
|
||||
|
||||
1. Clear the new-CIPE timeout
|
||||
2. Switch to normal polling mode
|
||||
3. Process the NEW CIPE's status normally
|
||||
4. Return when actionable state reached
|
||||
|
||||
### Wait Mode Output
|
||||
|
||||
While in wait mode, output clearly that you're waiting (not processing):
|
||||
|
||||
```
|
||||
[CI Monitor] ═══════════════════════════════════════════════════════
|
||||
[CI Monitor] WAIT MODE - Expecting new CI Attempt
|
||||
[CI Monitor] Expected SHA: <expectedCommitSha>
|
||||
[CI Monitor] Previous CI Attempt: <previousCipeUrl>
|
||||
[CI Monitor] ═══════════════════════════════════════════════════════
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 0m 30s)
|
||||
[CI Monitor] Still seeing previous CI Attempt (ignoring): <oldCipeUrl>
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 1m 30s)
|
||||
[CI Monitor] Still seeing previous CI Attempt (ignoring): <oldCipeUrl>
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 2m 30s)
|
||||
[CI Monitor] ✓ New CI Attempt detected! URL: <newCipeUrl>, SHA: <newCommitSha>
|
||||
[CI Monitor] Switching to normal polling mode...
|
||||
```
|
||||
|
||||
### Why This Matters (Context Preservation)
|
||||
|
||||
**The problem**: Stale CIPE data can be very large:
|
||||
|
||||
- `taskOutputSummary`: potentially thousands of characters of build/test output
|
||||
- `suggestedFix`: entire patch files
|
||||
- `suggestedFixReasoning`: detailed explanation
|
||||
|
||||
If subagent returns stale CIPE data to main agent, it **pollutes main agent's context** with useless information (we already processed that CIPE). This wastes valuable context window.
|
||||
|
||||
**Without wait mode:**
|
||||
|
||||
1. Poll `ci_information` → get old CIPE with huge data
|
||||
2. Return to main agent with all that stale data
|
||||
3. Main agent's context gets polluted with useless info
|
||||
4. Main agent has to process/ignore it anyway
|
||||
|
||||
**With wait mode:**
|
||||
|
||||
1. Poll `ci_information` → get old CIPE → **ignore it, don't return**
|
||||
2. Keep waiting internally (stale data stays in subagent)
|
||||
3. New CIPE appears → switch to normal mode
|
||||
4. Return to main agent with only the NEW, relevant CIPE data
|
||||
|
||||
## Polling Loop
|
||||
|
||||
### Subagent State Management
|
||||
|
||||
Maintain internal accumulated state across polls:
|
||||
|
||||
```
|
||||
accumulated_state = {}
|
||||
```
|
||||
|
||||
### Call `ci_information` MCP Tool
|
||||
|
||||
**Wait Mode (expecting new CI Attempt):**
|
||||
|
||||
```
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "cipeUrl,commitSha,cipeStatus"
|
||||
})
|
||||
```
|
||||
|
||||
Only fetch minimal fields needed to detect CI Attempt change. Do NOT fetch heavy fields - stale data wastes context.
|
||||
|
||||
**Normal Mode (processing CI Attempt):**
|
||||
|
||||
```
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,shortLink,confidence,confidenceReasoning"
|
||||
})
|
||||
```
|
||||
|
||||
Merge response into `accumulated_state` after each poll.
|
||||
|
||||
### Analyze Response
|
||||
|
||||
**If in Wait Mode** (expecting new CIPE):
|
||||
|
||||
1. Check if CIPE is new (see Two-Phase Operation above)
|
||||
2. If old CIPE → **ignore status**, output wait message, poll again
|
||||
3. If new CIPE → switch to normal mode, continue below
|
||||
|
||||
**If in Normal Mode**:
|
||||
Based on the response, decide whether to **keep polling** or **return to main agent**.
|
||||
|
||||
### Keep Polling When
|
||||
|
||||
Continue polling (with backoff) if ANY of these conditions are true:
|
||||
|
||||
| Condition | Reason |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| `cipeStatus == 'IN_PROGRESS'` | CI still running |
|
||||
| `cipeStatus == 'NOT_STARTED'` | CI hasn't started yet |
|
||||
| `selfHealingStatus == 'IN_PROGRESS'` | Self-healing agent working |
|
||||
| `selfHealingStatus == 'NOT_STARTED'` | Self-healing not started yet |
|
||||
| `failureClassification == 'FLAKY_TASK'` | Auto-rerun in progress |
|
||||
| `userAction == 'APPLIED_AUTOMATICALLY'` | New CI Attempt spawning after auto-apply |
|
||||
|
||||
When `couldAutoApplyTasks == true`:
|
||||
|
||||
- `verificationStatus` = `NOT_STARTED`, `IN_PROGRESS` → keep polling (verification still in progress)
|
||||
- `verificationStatus` = `COMPLETED` → return `fix_auto_applying` (auto-apply will happen, main agent spawns wait mode subagent)
|
||||
- `verificationStatus` = `FAILED`, `NOT_EXECUTABLE` → return `fix_available` (auto-apply won't happen, needs manual action)
|
||||
|
||||
### Exponential Backoff
|
||||
|
||||
Between polls, wait with exponential backoff:
|
||||
|
||||
| Poll Attempt | Wait Time |
|
||||
| ------------ | ----------------- |
|
||||
| 1st | 60 seconds |
|
||||
| 2nd | 90 seconds |
|
||||
| 3rd+ | 120 seconds (cap) |
|
||||
|
||||
Reset to 60 seconds when state changes significantly.
|
||||
|
||||
**IMPORTANT:** Run sleep in foreground (NOT as background command). Background sleep causes "What should Claude do?" prompts when completed.
|
||||
|
||||
```bash
|
||||
# Example backoff - run in FOREGROUND
|
||||
sleep 60 # First wait
|
||||
sleep 90 # Second wait
|
||||
sleep 120 # Third and subsequent waits (capped)
|
||||
```
|
||||
|
||||
### Fetch Heavy Fields on Actionable State
|
||||
|
||||
Before returning to main agent, fetch heavy fields if the status requires them:
|
||||
|
||||
| Status | Heavy Fields Needed |
|
||||
| ------------------- | ------------------------------------------------------------------------------ |
|
||||
| `ci_success` | None |
|
||||
| `fix_auto_applying` | None |
|
||||
| `fix_available` | `taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription` |
|
||||
| `fix_failed` | `taskOutputSummary` |
|
||||
| `no_fix` | `taskOutputSummary` |
|
||||
| `environment_issue` | None |
|
||||
| `no_new_cipe` | None |
|
||||
| `polling_timeout` | None |
|
||||
| `cipe_canceled` | None |
|
||||
| `cipe_timed_out` | None |
|
||||
|
||||
```
|
||||
# Example: fetching heavy fields for fix_available
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription"
|
||||
})
|
||||
```
|
||||
|
||||
Merge response into `accumulated_state`, then return merged state to main agent.
|
||||
|
||||
**Pagination:** Heavy string fields return first page only. If `hasMore` indicated, include in return format so main agent knows more content available.
|
||||
|
||||
### Return to Main Agent When
|
||||
|
||||
Return immediately with structured state if ANY of these conditions are true:
|
||||
|
||||
| Status | Condition |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | `cipeStatus == 'SUCCEEDED'` |
|
||||
| `fix_auto_applying` | `selfHealingStatus == 'COMPLETED'` AND `couldAutoApplyTasks == true` AND `verificationStatus == 'COMPLETED'` |
|
||||
| `fix_available` | `selfHealingStatus == 'COMPLETED'` AND `suggestedFix != null` AND (`couldAutoApplyTasks != true` OR `verificationStatus` in (`FAILED`, `NOT_EXECUTABLE`)) |
|
||||
| `fix_failed` | `selfHealingStatus == 'FAILED'` |
|
||||
| `environment_issue` | `failureClassification == 'ENVIRONMENT_STATE'` |
|
||||
| `no_fix` | `cipeStatus == 'FAILED'` AND (`selfHealingEnabled == false` OR `selfHealingStatus == 'NOT_EXECUTABLE'`) |
|
||||
| `no_new_cipe` | `expectedCommitSha` or `previousCipeUrl` provided, but no new CI Attempt detected after 30 min |
|
||||
| `polling_timeout` | Subagent has been polling for > configured timeout (default 60 min) |
|
||||
| `cipe_canceled` | `cipeStatus == 'CANCELED'` |
|
||||
| `cipe_timed_out` | `cipeStatus == 'TIMED_OUT'` |
|
||||
|
||||
## Subagent Timeout
|
||||
|
||||
Track elapsed time. If you have been polling for more than **60 minutes** (configurable via main agent), return with `status: polling_timeout`.
|
||||
|
||||
## Return Format
|
||||
|
||||
When returning to the main agent, provide a structured response with accumulated state:
|
||||
|
||||
```
|
||||
## CI Monitor Result
|
||||
|
||||
**Status:** <status>
|
||||
**Iterations:** <count>
|
||||
**Elapsed:** <minutes>m <seconds>s
|
||||
|
||||
### CI Attempt Details
|
||||
- **Status:** <cipeStatus>
|
||||
- **URL:** <cipeUrl>
|
||||
- **Branch:** <branch>
|
||||
- **Commit:** <commitSha>
|
||||
- **Failed Tasks:** <failedTaskIds>
|
||||
- **Verified Tasks:** <verifiedTaskIds>
|
||||
|
||||
### Self-Healing Details
|
||||
- **Enabled:** <selfHealingEnabled>
|
||||
- **Status:** <selfHealingStatus>
|
||||
- **Verification:** <verificationStatus>
|
||||
- **User Action:** <userAction>
|
||||
- **Classification:** <failureClassification>
|
||||
- **Confidence:** <confidence>
|
||||
- **Confidence Reasoning:** <confidenceReasoning>
|
||||
|
||||
### Fix Information (if available)
|
||||
- **Short Link:** <shortLink>
|
||||
- **Description:** <suggestedFixDescription>
|
||||
- **Reasoning:** <suggestedFixReasoning>
|
||||
|
||||
### Task Output Summary (first page)
|
||||
<taskOutputSummary>
|
||||
[MORE_CONTENT_AVAILABLE: taskOutputSummary, pageToken: 1]
|
||||
|
||||
### Suggested Fix (first page)
|
||||
<suggestedFix>
|
||||
[MORE_CONTENT_AVAILABLE: suggestedFix, pageToken: 1]
|
||||
```
|
||||
|
||||
### Pagination Indicators
|
||||
|
||||
When a heavy field has more content available, append indicator:
|
||||
|
||||
```
|
||||
[MORE_CONTENT_AVAILABLE: <fieldName>, pageToken: <nextPage>]
|
||||
```
|
||||
|
||||
Main agent can fetch additional pages if needed using:
|
||||
|
||||
```
|
||||
ci_information({ select: "<fieldName>", pageToken: <nextPage> })
|
||||
```
|
||||
|
||||
Fields that may have pagination:
|
||||
|
||||
- `taskOutputSummary` (reverse pagination - page 0 = most recent)
|
||||
- `suggestedFix` (forward pagination - page 0 = start)
|
||||
- `suggestedFixReasoning`
|
||||
|
||||
### Return Format for `no_new_cipe`
|
||||
|
||||
When returning with `status: no_new_cipe`, include additional context:
|
||||
|
||||
```
|
||||
## CI Monitor Result
|
||||
|
||||
**Status:** no_new_cipe
|
||||
**Iterations:** <count>
|
||||
**Elapsed:** <minutes>m <seconds>s
|
||||
|
||||
### Expected CI Attempt Not Found
|
||||
- **Expected Commit SHA:** <expectedCommitSha>
|
||||
- **Previous CI Attempt URL:** <previousCipeUrl>
|
||||
- **Last Seen CI Attempt URL:** <cipeUrl>
|
||||
- **Last Seen Commit SHA:** <commitSha>
|
||||
- **New CI Attempt Timeout:** 30 minutes (exceeded)
|
||||
|
||||
### Likely Cause
|
||||
CI workflow failed before Nx tasks could run (e.g., install step, checkout, auth).
|
||||
Check your CI provider logs for the commit <expectedCommitSha>.
|
||||
|
||||
### Last Known CI Attempt State
|
||||
- **Status:** <cipeStatus>
|
||||
- **Branch:** <branch>
|
||||
```
|
||||
|
||||
## Status Reporting (Verbosity-Controlled)
|
||||
|
||||
Output is controlled by the `verbosity` parameter from the main agent:
|
||||
|
||||
| Level | What to Output |
|
||||
| --------- | ----------------------------------------------------------------- |
|
||||
| `minimal` | No intermediate output. Only return final result when actionable. |
|
||||
| `medium` | Output only on significant state changes (not every poll). |
|
||||
| `verbose` | Output detailed phase information after every poll. |
|
||||
|
||||
### Minimal Verbosity
|
||||
|
||||
No output during polling. Poll silently and return when done.
|
||||
|
||||
### Medium Verbosity (Default)
|
||||
|
||||
Output **only when state changes significantly** to save context tokens:
|
||||
|
||||
- `cipeStatus` changes (e.g., IN_PROGRESS → FAILED)
|
||||
- `selfHealingStatus` changes (e.g., IN_PROGRESS → COMPLETED)
|
||||
- New CI Attempt detected (in wait mode)
|
||||
|
||||
Format: single line, no decorators:
|
||||
|
||||
```
|
||||
[CI Monitor] CI: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 4m
|
||||
```
|
||||
|
||||
### Verbose Verbosity
|
||||
|
||||
Output detailed phase box after every poll:
|
||||
|
||||
```
|
||||
[CI Monitor] ─────────────────────────────────────────────────────
|
||||
[CI Monitor] Iteration <N> | Elapsed: <X>m <Y>s
|
||||
[CI Monitor]
|
||||
[CI Monitor] CI Status: <cipeStatus>
|
||||
[CI Monitor] Self-Healing: <selfHealingStatus>
|
||||
[CI Monitor] Verification: <verificationStatus>
|
||||
[CI Monitor] Classification: <failureClassification>
|
||||
[CI Monitor]
|
||||
[CI Monitor] → <human-readable phase description>
|
||||
[CI Monitor] ─────────────────────────────────────────────────────
|
||||
```
|
||||
|
||||
### Phase Descriptions (for verbose output)
|
||||
|
||||
| Status Combo | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||||
| `cipeStatus: IN_PROGRESS` | "CI running..." |
|
||||
| `cipeStatus: NOT_STARTED` | "Waiting for CI to start..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: NOT_STARTED` | "CI failed. Self-healing starting..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: IN_PROGRESS` | "CI failed. Self-healing generating fix..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: IN_PROGRESS` | "Fix generated! Verification running..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: COMPLETED` | "Fix ready! Verified successfully." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: FAILED` | "Fix generated but verification failed." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: FAILED` | "Self-healing could not generate a fix." |
|
||||
| `cipeStatus: SUCCEEDED` | "CI passed!" |
|
||||
|
||||
## Important Notes
|
||||
|
||||
- You do NOT make apply/reject decisions - that's the main agent's job
|
||||
- You do NOT perform git operations
|
||||
- You only poll and report state
|
||||
- Respect the `verbosity` parameter for output (default: medium)
|
||||
- If `ci_information` returns an error, wait and retry (count as failed poll)
|
||||
- Track consecutive failures - if 5 consecutive failures, return with `status: error`
|
||||
- When expecting new CI Attempt, track the 30-minute new-CI-Attempt timeout separately from the main polling timeout
|
||||
@@ -0,0 +1,428 @@
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \| Elapsed: Xm \| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```
|
||||
@@ -0,0 +1,437 @@
|
||||
---
|
||||
name: ci-monitor
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes automatically. Checks for Nx Cloud connection before starting.
|
||||
---
|
||||
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `$ARGUMENTS` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \| Elapsed: Xm \| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```
|
||||
@@ -0,0 +1,228 @@
|
||||
---
|
||||
name: nx-generate
|
||||
description: Generate code using nx generators. USE WHEN scaffolding code or transforming existing code - for example creating libraries or applications, or anything else that is boilerplate code or automates repetitive tasks. ALWAYS use this first when generating code with Nx instead of calling MCP tools or running nx generate immediately.
|
||||
---
|
||||
|
||||
# Run Nx Generator
|
||||
|
||||
Nx generators are powerful tools that scaffold projects, make automated code migrations or automate repetitive tasks in a monorepo. They ensure consistency across the codebase and reduce boilerplate work.
|
||||
|
||||
This skill applies when the user wants to:
|
||||
|
||||
- Create new projects like libraries or applications
|
||||
- Scaffold features or boilerplate code
|
||||
- Run workspace-specific or custom generators
|
||||
- Do anything else that an nx generator exists for
|
||||
|
||||
## Generator Discovery Flow
|
||||
|
||||
### Step 1: List Available Generators
|
||||
|
||||
Use the Nx CLI to discover available generators:
|
||||
|
||||
- List all generators for a plugin: `npx nx list @nx/react`
|
||||
- View available plugins: `npx nx list`
|
||||
|
||||
This includes:
|
||||
|
||||
- Plugin generators (e.g., `@nx/react:library`, `@nx/js:library`)
|
||||
- Local workspace generators (defined in the repo's own plugins)
|
||||
|
||||
### Step 2: Match Generator to User Request
|
||||
|
||||
Based on the user's request, identify which generator(s) could fulfill their needs. Consider:
|
||||
|
||||
- What artifact type they want to create (library, application, etc.)
|
||||
- Which framework or technology stack is relevant
|
||||
- Whether they mentioned specific generator names
|
||||
|
||||
**IMPORTANT**: When both a local workspace generator and an external plugin generator could satisfy the request, **always prefer the local workspace generator**. Local generators are customized for the specific repo's patterns and conventions.
|
||||
|
||||
It's possible that the user request is something that no Nx generator exists for whatsoever. In this case, you can stop using this skill and try to help the user another way. HOWEVER, the burden of proof for this is high. Before aborting, carefully consider each and every generator that's available. Look into details for any that could be related in any way before making this decision.
|
||||
|
||||
## Pre-Execution Checklist
|
||||
|
||||
Before running any generator, complete these steps:
|
||||
|
||||
### 1. Fetch Generator Schema
|
||||
|
||||
Use the `--help` flag to understand all available options:
|
||||
|
||||
```bash
|
||||
npx nx g @nx/react:library --help
|
||||
```
|
||||
|
||||
Pay attention to:
|
||||
|
||||
- Required options that must be provided
|
||||
- Optional options that may be relevant to the user's request
|
||||
- Default values that might need to be overridden
|
||||
|
||||
### 2. Read Generator Source Code
|
||||
|
||||
Understanding what the generator actually does helps you:
|
||||
|
||||
- Know what files will be created/modified
|
||||
- Understand any side effects (updating configs, installing deps, etc.)
|
||||
- Identify options that might not be obvious from the schema
|
||||
|
||||
To find generator source code:
|
||||
|
||||
- For plugin generators: Use `node -e "console.log(require.resolve('@nx/<plugin>/generators.json'));"` to find the generators.json, then locate the source from there
|
||||
- If that fails, read directly from `node_modules/<plugin>/generators.json`
|
||||
- For local generators: They are typically in `tools/generators/` or a local plugin directory. You can search the repo for the generator name to find it.
|
||||
|
||||
### 2.5 Reevaluate if the generator is right
|
||||
|
||||
Once you have built up an understanding of what the selected generator does, reconsider: Is this the right generator to service the user request?
|
||||
If not, it's okay to go back to the Generator Discovery Flow and select a different generator before proceeding. If you do, make sure to go through the entire pre-execution checklist once more.
|
||||
|
||||
### 3. Understand Repo Context
|
||||
|
||||
Before generating, examine the target area of the codebase:
|
||||
|
||||
- Look at similar existing artifacts (other libraries, applications, etc.)
|
||||
- Identify patterns and conventions used in the repo
|
||||
- Note naming conventions, file structures, and configuration patterns
|
||||
- Try to match these patterns when configuring the generator
|
||||
|
||||
For example, if similar libraries are using a specific test runner, build tool or linter, try to match that if possible.
|
||||
If projects or other artifacts are organized with a specific naming convention, try to match it.
|
||||
|
||||
### 4. Validate Required Options
|
||||
|
||||
Ensure all required options have values:
|
||||
|
||||
- Map the user's request to generator options
|
||||
- Infer values from context where possible
|
||||
- Ask the user for any critical missing information
|
||||
|
||||
## Execution
|
||||
|
||||
Keep in mind that you might have to prefix things with npx/pnpx/yarn if the user doesn't have nx installed globally.
|
||||
Many generators will behave differently based on where they are executed. For example, first-party nx library generators use the cwd to determine the directory that the library should be placed in. This is highly important.
|
||||
|
||||
### Consider Dry-Run (Optional)
|
||||
|
||||
Running with `--dry-run` first is strongly encouraged but not mandatory. Use your judgment:
|
||||
|
||||
- For complex generators or unfamiliar territory: do a dry-run first
|
||||
- For simple, well-understood generators: may proceed directly
|
||||
- Dry-run shows file names and created/deleted/modified markers, but not content
|
||||
- There are cases where a generator does not support dry-run (for example if it had to install an npm package) - in that case --dry-run might fail. Don't be discouraged but simply move on to running the generator for real and iterating from there.
|
||||
|
||||
### Running the Generator
|
||||
|
||||
Execute the generator with:
|
||||
|
||||
```bash
|
||||
nx generate <generator-name> <options> --no-interactive
|
||||
```
|
||||
|
||||
**CRITICAL**: Always include `--no-interactive` to prevent prompts that would hang the execution.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
nx generate @nx/react:library --name=my-utils --no-interactive
|
||||
```
|
||||
|
||||
### Handling Generator Failures
|
||||
|
||||
If the generator fails:
|
||||
|
||||
1. **Diagnose the error** - Read the error message carefully
|
||||
2. **Identify the cause** - Missing options, invalid values, conflicts, etc.
|
||||
3. **Attempt automatic fix** - Adjust options or resolve conflicts
|
||||
4. **Retry** - Run the generator again with corrected options
|
||||
|
||||
Common failure reasons:
|
||||
|
||||
- Missing required options
|
||||
- Invalid option values
|
||||
- Conflicting with existing files
|
||||
- Missing dependencies
|
||||
- Generator doesn't support certain flag combinations
|
||||
|
||||
## Post-Generation
|
||||
|
||||
### 1. Modify Generated Code (If Needed)
|
||||
|
||||
Generators provide a starting point, but the output may need adjustment to match the user's specific requirements:
|
||||
|
||||
- Add or modify functionality as requested
|
||||
- Adjust imports, exports, or configurations
|
||||
- Integrate with existing code patterns in the repo
|
||||
|
||||
### 2. Format Code
|
||||
|
||||
Run formatting on all generated/modified files:
|
||||
|
||||
```bash
|
||||
nx format --fix
|
||||
```
|
||||
|
||||
Languages other than javascript/typescript might need other formatting invocations too.
|
||||
|
||||
### 3. Run Verification
|
||||
|
||||
Verify that the generated code works correctly. What this looks like will vary depending on the type of generator and the targets available.
|
||||
If the generator created a new project, run its targets directly
|
||||
Use your best judgement to determine what needs to be verified.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
nx lint <new-project>
|
||||
nx test <new-project>
|
||||
nx build <new-project>
|
||||
```
|
||||
|
||||
### 4. Handle Verification Failures
|
||||
|
||||
When verification fails:
|
||||
|
||||
**If scope is manageable** (a few lint errors, minor type issues):
|
||||
|
||||
- Fix the issues
|
||||
- Re-run verification to confirm
|
||||
|
||||
**If issues are extensive** (many errors, complex problems):
|
||||
|
||||
- Attempt simple, obvious fixes first
|
||||
- If still failing, escalate to the user with:
|
||||
- Description of what was generated
|
||||
- What verification is failing
|
||||
- What you've attempted to fix
|
||||
- Remaining issues that need user input
|
||||
|
||||
## Error Handling
|
||||
|
||||
### Generator Failures
|
||||
|
||||
- Check the error message for specific causes
|
||||
- Verify all required options are provided
|
||||
- Check for conflicts with existing files
|
||||
- Ensure the generator name and options are correct
|
||||
|
||||
### Missing Options
|
||||
|
||||
- Consult the generator schema for required fields
|
||||
- Infer values from context when reasonable
|
||||
- Ask the user for values that cannot be inferred
|
||||
|
||||
## Key Principles
|
||||
|
||||
1. **Local generators first** - Always prefer workspace/local generators over external plugin generators when both could work
|
||||
|
||||
2. **Understand before running** - Read both the schema AND the source code to fully understand what will happen
|
||||
|
||||
3. **No prompts** - Always use `--no-interactive` to prevent hanging
|
||||
|
||||
4. **Generators are starting points** - Modify the output as needed to fully satisfy the user's requirements
|
||||
|
||||
5. **Verify changes work** - Don't just generate; ensure the code builds, lints, and tests pass
|
||||
|
||||
6. **Be proactive about fixes** - Don't just report errors; attempt to resolve them automatically when possible
|
||||
|
||||
7. **Match repo patterns** - Study existing similar code in the repo and match its conventions
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
name: nx-plugins
|
||||
description: Find and add Nx plugins. USE WHEN user wants to discover available plugins, install a new plugin, or add support for a specific framework or technology to the workspace.
|
||||
---
|
||||
|
||||
## Finding and Installing new plugins
|
||||
|
||||
- List plugins: `pnpm nx list`
|
||||
- Install plugins `pnpm nx add <plugin>`. Example: `pnpm nx add @nx/react`.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: nx-run-tasks
|
||||
description: Helps with running tasks in an Nx workspace. USE WHEN the user wants to execute build, test, lint, serve, or run any other tasks defined in the workspace.
|
||||
---
|
||||
|
||||
You can run tasks with Nx in the following way.
|
||||
|
||||
Keep in mind that you might have to prefix things with npx/pnpx/yarn if the user doesn't have nx installed globally. Look at the package.json or lockfile to determine which package manager is in use.
|
||||
|
||||
For more details on any command, run it with `--help` (e.g. `nx run-many --help`, `nx affected --help`).
|
||||
|
||||
## Understand which tasks can be run
|
||||
|
||||
You can check those via `nx show project <projectname> --json`, for example `nx show project myapp --json`. It contains a `targets` section which has information about targets that can be run. You can also just look at the `package.json` scripts or `project.json` targets, but you might miss out on inferred tasks by Nx plugins.
|
||||
|
||||
## Run a single task
|
||||
|
||||
```
|
||||
nx run <project>:<task>
|
||||
```
|
||||
|
||||
where `project` is the project name defined in `package.json` or `project.json` (if present).
|
||||
|
||||
## Run multiple tasks
|
||||
|
||||
```
|
||||
nx run-many -t build test lint typecheck
|
||||
```
|
||||
|
||||
You can pass a `-p` flag to filter to specific projects, otherwise it runs on all projects. You can also use `--exclude` to exclude projects, and `--parallel` to control the number of parallel processes (default is 3).
|
||||
|
||||
Examples:
|
||||
|
||||
- `nx run-many -t test -p proj1 proj2` — test specific projects
|
||||
- `nx run-many -t test --projects=*-app --exclude=excluded-app` — test projects matching a pattern
|
||||
- `nx run-many -t test --projects=tag:api-*` — test projects by tag
|
||||
|
||||
## Run tasks for affected projects
|
||||
|
||||
Use `nx affected` to only run tasks on projects that have been changed and projects that depend on changed projects. This is especially useful in CI and for large workspaces.
|
||||
|
||||
```
|
||||
nx affected -t build test lint
|
||||
```
|
||||
|
||||
By default it compares against the base branch. You can customize this:
|
||||
|
||||
- `nx affected -t test --base=main --head=HEAD` — compare against a specific base and head
|
||||
- `nx affected -t test --files=libs/mylib/src/index.ts` — specify changed files directly
|
||||
|
||||
## Useful flags
|
||||
|
||||
These flags work with `run`, `run-many`, and `affected`:
|
||||
|
||||
- `--skipNxCache` — rerun tasks even when results are cached
|
||||
- `--verbose` — print additional information such as stack traces
|
||||
- `--nxBail` — stop execution after the first failed task
|
||||
- `--configuration=<name>` — use a specific configuration (e.g. `production`)
|
||||
@@ -0,0 +1,186 @@
|
||||
---
|
||||
name: nx-workspace
|
||||
description: "Explore and understand Nx workspaces. USE WHEN answering any questions about the nx workspace, the projects in it or tasks to run. EXAMPLES: 'What projects are in this workspace?', 'How is project X configured?', 'What targets can I run?', 'What's affected by my changes?', 'Which projects depend on library Y?', or any questions about Nx workspace structure, project configuration, or available tasks."
|
||||
---
|
||||
|
||||
# Nx Workspace Exploration
|
||||
|
||||
This skill provides read-only exploration of Nx workspaces. Use it to understand workspace structure, project configuration, available targets, and dependencies.
|
||||
|
||||
Keep in mind that you might have to prefix commands with `npx`/`pnpx`/`yarn` if nx isn't installed globally. Check the lockfile to determine the package manager in use.
|
||||
|
||||
## Listing Projects
|
||||
|
||||
Use `nx show projects` to list projects in the workspace.
|
||||
|
||||
```bash
|
||||
# List all projects
|
||||
nx show projects
|
||||
|
||||
# Filter by pattern (glob)
|
||||
nx show projects --projects "apps/*"
|
||||
nx show projects --projects "shared-*"
|
||||
|
||||
# Filter by project type
|
||||
nx show projects --type app
|
||||
nx show projects --type lib
|
||||
nx show projects --type e2e
|
||||
|
||||
# Filter by target (projects that have a specific target)
|
||||
nx show projects --withTarget build
|
||||
nx show projects --withTarget e2e
|
||||
|
||||
# Find affected projects (changed since base branch)
|
||||
nx show projects --affected
|
||||
nx show projects --affected --base=main
|
||||
nx show projects --affected --type app
|
||||
|
||||
# Combine filters
|
||||
nx show projects --type lib --withTarget test
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
|
||||
# Output as JSON
|
||||
nx show projects --json
|
||||
```
|
||||
|
||||
## Project Configuration
|
||||
|
||||
Use `nx show project <name> --json` to get the full resolved configuration for a project.
|
||||
|
||||
**Important**: Do NOT read `project.json` directly - it only contains partial configuration. The `nx show project` command returns the full resolved config including inferred targets from plugins.
|
||||
|
||||
You can read the full project schema at `node_modules/nx/schemas/project-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Get full project configuration
|
||||
nx show project my-app --json
|
||||
|
||||
# Extract specific parts from the JSON
|
||||
nx show project my-app --json | jq '.targets'
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
|
||||
# Check project metadata
|
||||
nx show project my-app --json | jq '{name, root, sourceRoot, projectType, tags}'
|
||||
```
|
||||
|
||||
## Target Information
|
||||
|
||||
Targets define what tasks can be run on a project.
|
||||
|
||||
```bash
|
||||
# List all targets for a project
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Get full target configuration
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
|
||||
# Check target executor/command
|
||||
nx show project my-app --json | jq '.targets.build.executor'
|
||||
nx show project my-app --json | jq '.targets.build.command'
|
||||
|
||||
# View target options
|
||||
nx show project my-app --json | jq '.targets.build.options'
|
||||
|
||||
# Check target inputs/outputs (for caching)
|
||||
nx show project my-app --json | jq '.targets.build.inputs'
|
||||
nx show project my-app --json | jq '.targets.build.outputs'
|
||||
|
||||
# Find projects with a specific target
|
||||
nx show projects --withTarget serve
|
||||
nx show projects --withTarget e2e
|
||||
```
|
||||
|
||||
## Workspace Configuration
|
||||
|
||||
Read `nx.json` directly for workspace-level configuration.
|
||||
You can read the full project schema at `node_modules/nx/schemas/nx-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Read the full nx.json
|
||||
cat nx.json
|
||||
|
||||
# Or use jq for specific sections
|
||||
cat nx.json | jq '.targetDefaults'
|
||||
cat nx.json | jq '.namedInputs'
|
||||
cat nx.json | jq '.plugins'
|
||||
cat nx.json | jq '.generators'
|
||||
```
|
||||
|
||||
Key nx.json sections:
|
||||
|
||||
- `targetDefaults` - Default configuration applied to all targets of a given name
|
||||
- `namedInputs` - Reusable input definitions for caching
|
||||
- `plugins` - Nx plugins and their configuration
|
||||
- ...and much more, read the schema or nx.json for details
|
||||
|
||||
## Affected Projects
|
||||
|
||||
Find projects affected by changes in the current branch.
|
||||
|
||||
```bash
|
||||
# Affected since base branch (auto-detected)
|
||||
nx show projects --affected
|
||||
|
||||
# Affected with explicit base
|
||||
nx show projects --affected --base=main
|
||||
nx show projects --affected --base=origin/main
|
||||
|
||||
# Affected between two commits
|
||||
nx show projects --affected --base=abc123 --head=def456
|
||||
|
||||
# Affected apps only
|
||||
nx show projects --affected --type app
|
||||
|
||||
# Affected excluding e2e projects
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
|
||||
# Affected by uncommitted changes
|
||||
nx show projects --affected --uncommitted
|
||||
|
||||
# Affected by untracked files
|
||||
nx show projects --affected --untracked
|
||||
```
|
||||
|
||||
## Common Exploration Patterns
|
||||
|
||||
### "What's in this workspace?"
|
||||
|
||||
```bash
|
||||
nx show projects
|
||||
nx show projects --type app
|
||||
nx show projects --type lib
|
||||
```
|
||||
|
||||
### "How do I build/test/lint project X?"
|
||||
|
||||
```bash
|
||||
nx show project X --json | jq '.targets | keys'
|
||||
nx show project X --json | jq '.targets.build'
|
||||
```
|
||||
|
||||
### "What depends on library Y?"
|
||||
|
||||
```bash
|
||||
# Find projects that may depend on Y by searching for imports
|
||||
# (Nx doesn't have a direct "dependents" command via CLI)
|
||||
grep -r "from '@myorg/Y'" --include="*.ts" --include="*.tsx" apps/ libs/
|
||||
```
|
||||
|
||||
### "What configuration options are available?"
|
||||
|
||||
```bash
|
||||
cat node_modules/nx/schemas/nx-schema.json | jq '.properties | keys'
|
||||
cat node_modules/nx/schemas/project-schema.json | jq '.properties | keys'
|
||||
```
|
||||
|
||||
### "Why is project X affected?"
|
||||
|
||||
```bash
|
||||
# Check what files changed
|
||||
git diff --name-only main
|
||||
|
||||
# See which project owns those files
|
||||
nx show project X --json | jq '.root'
|
||||
```
|
||||
@@ -0,0 +1,48 @@
|
||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
||||
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
|
||||
{
|
||||
"name": "NxDevContainer",
|
||||
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
|
||||
|
||||
// Starting from a base image that already contains GLIBC v2.33 or higher (required by Nx)
|
||||
// Try a more recent distribution, if your are having build issues related to GLIBC version
|
||||
// Here we use 'bookworm', which is based on `Debian-12`, which comes with `GLIBC v2.36`
|
||||
// (Nx tools currenlty requires `GLIBC v2.33` or higher)
|
||||
// Note: Using base debian image instead of typescript-node since mise will manage all tools
|
||||
"image": "mcr.microsoft.com/devcontainers/base:bookworm",
|
||||
|
||||
// All tools (Node, Java, Rust, Dotnet) are managed by mise via mise.toml
|
||||
"features": {},
|
||||
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
// 4211 = nx graph port
|
||||
// 4873 = verdaccio (local npm registry) port
|
||||
"forwardPorts": [4211, 4873],
|
||||
|
||||
// Use 'postCreateCommand' to run commands after the container is created.
|
||||
"postCreateCommand": "./.devcontainer/postCreateCommand.sh",
|
||||
|
||||
// Configure tool-specific properties.
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"nrwl.angular-console",
|
||||
"firsttris.vscode-jest-runner",
|
||||
"eamodio.gitlens",
|
||||
"mhutchie.git-graph",
|
||||
"mutantdino.resourcemonitor" // to monitor cpu, memory usage from the dev container
|
||||
],
|
||||
"settings": {
|
||||
"debug.javascript.autoAttachFilter": "disabled" // workaround for that issue: https://github.com/microsoft/vscode-js-debug/issues/374#issuecomment-622239998
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
// To improve disk performances when installing node modules
|
||||
// See https://code.visualstudio.com/remote/advancedcontainers/improve-performance
|
||||
"mounts": [
|
||||
"source=${localWorkspaceFolderBasename}-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
|
||||
],
|
||||
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
|
||||
"remoteUser": "root"
|
||||
}
|
||||
Executable
+41
@@ -0,0 +1,41 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Update the underlying (Debian) OS, to make sure we have the latest security patches and libraries like 'GLIBC'
|
||||
echo "⚙️ Updating the underlying OS..."
|
||||
sudo apt-get update && sudo apt-get -y upgrade
|
||||
|
||||
# Install mise for managing development tools (Node, Java, Rust, Dotnet)
|
||||
echo "⚙️ Installing mise..."
|
||||
curl https://mise.run | sh
|
||||
|
||||
# Add mise to PATH
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
|
||||
# Trust the mise.toml configuration file
|
||||
echo "⚙️ Trusting mise.toml configuration..."
|
||||
mise trust
|
||||
|
||||
# Install all tools from mise.toml (node, java, rust, dotnet)
|
||||
echo "⚙️ Installing tools via mise (node, java, rust, dotnet)..."
|
||||
mise install
|
||||
|
||||
# Activate mise to make tools available in current shell
|
||||
eval "$(mise activate bash)"
|
||||
|
||||
# Add mise activation to bashrc for future shell sessions
|
||||
echo "⚙️ Configuring mise activation in shell..."
|
||||
echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc
|
||||
|
||||
# Prevent corepack from prompting user before downloading PNPM
|
||||
export COREPACK_ENABLE_DOWNLOAD_PROMPT=0
|
||||
|
||||
# Enable corepack
|
||||
corepack enable
|
||||
|
||||
# Install the PNPM version defined in the root package.json
|
||||
echo "⚙️ Installing required PNPM version..."
|
||||
corepack prepare --activate
|
||||
|
||||
# Install NPM dependencies
|
||||
echo "⚙️ Installing NPM dependencies..."
|
||||
pnpm install --frozen-lockfile
|
||||
@@ -0,0 +1,18 @@
|
||||
# EditorConfig is awesome: https://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style newlines with a newline ending every file
|
||||
[*]
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
|
||||
# 4 space indentation
|
||||
[*.{kts,kt,js,ts,jsx,tsx}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[package.json]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
@@ -0,0 +1,438 @@
|
||||
description = "Monitor Nx Cloud CI pipeline and handle self-healing fixes automatically. Checks for Nx Cloud connection before starting."
|
||||
prompt = """
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
{{args}}
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `{{args}}` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \\| Elapsed: Xm \\| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```"""
|
||||
@@ -0,0 +1,298 @@
|
||||
description = "Monitor Nx Cloud CI pipeline and handle self-healing fixes. USE WHEN user says \"monitor ci\", \"watch ci\", \"ci monitor\", \"watch ci for this branch\", \"track ci\", \"check ci status\", wants to track CI status, or needs help with self-healing CI fixes. Prefer this skill over native CI provider tools (gh, glab, etc.) for CI monitoring — it integrates with Nx Cloud self-healing which those tools cannot access."
|
||||
prompt = """
|
||||
# Monitor CI Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn subagents to interact with Nx Cloud, run deterministic decision scripts, and take action based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
{{args}}
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum **agent-initiated** CI Attempt cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CI-Attempt failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CI Attempt after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `{{args}}` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
Before starting the monitoring loop, verify the workspace is connected to Nx Cloud. Without this connection, no CI data is available and the entire skill is inoperable.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
|
||||
```
|
||||
Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
1. **This skill (orchestrator)**: spawns subagents, runs scripts, prints status, does local coding work
|
||||
2. **ci-monitor-subagent (haiku)**: calls one MCP tool (ci_information or update_self_healing_fix), returns structured result, exits
|
||||
3. **ci-poll-decide.mjs (deterministic script)**: takes ci_information result + state, returns action + status message
|
||||
4. **ci-state-update.mjs (deterministic script)**: manages budget gates, post-action state transitions, and cycle classification
|
||||
|
||||
## Status Reporting
|
||||
|
||||
The decision script handles message formatting based on verbosity. When printing messages to the user:
|
||||
|
||||
- Prepend `[monitor-ci]` to every message from the script's `message` field
|
||||
- For your own action messages (e.g. "Applying fix via MCP..."), also prepend `[monitor-ci]`
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
These behaviors cause real problems — racing with self-healing, losing CI progress, or wasting context:
|
||||
|
||||
| Anti-Pattern | Why It's Bad |
|
||||
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| Using CI provider CLIs with `--watch` flags (e.g., `gh pr checks --watch`, `glab ci status -w`) | Bypasses Nx Cloud self-healing entirely |
|
||||
| Writing custom CI polling scripts | Unreliable, pollutes context, no self-healing |
|
||||
| Cancelling CI workflows/pipelines | Destructive, loses CI progress |
|
||||
| Running CI checks on main agent | Wastes main agent context tokens |
|
||||
| Independently analyzing/fixing CI failures while polling | Races with self-healing, causes duplicate fixes and confused state |
|
||||
|
||||
**If this skill fails to activate**, the fallback is:
|
||||
|
||||
1. Use CI provider CLI for a one-time, read-only status check (single call, no watch/polling flags)
|
||||
2. Immediately delegate to this skill with gathered context
|
||||
3. Do not continue polling on main agent — it wastes context tokens and bypasses self-healing
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
If the user previously ran `/monitor-ci` in this session, you may have prior state (poll counts, last CI Attempt URL, etc.). Resume from that state unless `--fresh` is set, in which case discard it and start from Step 1.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
Three field sets control polling efficiency — use the lightest set that gives you what you need:
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS: 'cipeUrl,commitSha,cipeStatus'
|
||||
LIGHT_FIELDS: 'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,autoApplySkipped,autoApplySkipReason,shortLink,confidence,confidenceReasoning,hints,selfHealingSkippedReason,selfHealingSkipMessage'
|
||||
HEAVY_FIELDS: 'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
```
|
||||
|
||||
The `ci_information` tool accepts `branch` (optional, defaults to current git branch), `select` (comma-separated field names), and `pageToken` (0-based pagination for long strings).
|
||||
|
||||
The `update_self_healing_fix` tool accepts a `shortLink` and an action: `APPLY`, `REJECT`, or `RERUN_ENVIRONMENT_STATE`.
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The decision script returns one of the following statuses. This table defines the **default behavior** for each. User instructions can override any of these.
|
||||
|
||||
**Simple exits** — just report and exit:
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success |
|
||||
| `cipe_canceled` | Exit, CI was canceled |
|
||||
| `cipe_timed_out` | Exit, CI timed out |
|
||||
| `polling_timeout` | Exit, polling timeout reached |
|
||||
| `circuit_breaker` | Exit, no progress after 13 consecutive polls |
|
||||
| `environment_rerun_cap` | Exit, environment reruns exhausted |
|
||||
| `fix_auto_applying` | Self-healing is handling it — just record `last_cipe_url`, enter wait mode. No MCP call or local git ops needed. |
|
||||
| `error` | Wait 60s and loop |
|
||||
|
||||
**Statuses requiring action** — when handling these in Step 3, read `references/fix-flows.md` for the detailed flow:
|
||||
|
||||
| Status | Summary |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------- |
|
||||
| `fix_auto_apply_skipped` | Fix verified but auto-apply skipped (e.g., loop prevention). Inform user, offer manual apply. |
|
||||
| `fix_apply_ready` | Fix verified (all tasks or e2e-only). Apply via MCP. |
|
||||
| `fix_needs_local_verify` | Fix has unverified non-e2e tasks. Run locally, then apply or enhance. |
|
||||
| `fix_needs_review` | Fix verification failed/not attempted. Analyze and decide. |
|
||||
| `fix_failed` | Self-healing failed. Fetch heavy data, attempt local fix (gate check first). |
|
||||
| `no_fix` | No fix available. Fetch heavy data, attempt local fix (gate check first) or exit. |
|
||||
| `environment_issue` | Request environment rerun via MCP (gate check first). |
|
||||
| `self_healing_throttled` | Reject old fixes, attempt local fix. |
|
||||
| `no_new_cipe` | CI Attempt never spawned. Auto-fix workflow or exit with guidance. |
|
||||
| `cipe_no_tasks` | CI failed with no tasks. Retry once with empty commit. |
|
||||
|
||||
**Key rules (always apply):**
|
||||
|
||||
- **Git safety**: Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
- **Environment failures** (OOM, command not found, permission denied): bail immediately. These aren't code bugs, so spending local-fix budget on them is wasteful
|
||||
- **Gate check**: Run `ci-state-update.mjs gate` before local fix attempts — if budget exhausted, print message and exit
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0 # Only incremented for agent-initiated cycles (counted against --max-cycles)
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
env_rerun_count = 0
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
agent_triggered = false # Set true after monitor takes an action that triggers new CI Attempt
|
||||
poll_count = 0
|
||||
wait_mode = false
|
||||
prev_status = null
|
||||
prev_cipe_status = null
|
||||
prev_sh_status = null
|
||||
prev_verification_status = null
|
||||
prev_failure_classification = null
|
||||
```
|
||||
|
||||
### Step 2: Polling Loop
|
||||
|
||||
Repeat until done:
|
||||
|
||||
#### 2a. Spawn subagent (FETCH_STATUS)
|
||||
|
||||
Determine select fields based on mode:
|
||||
|
||||
- **Wait mode**: use WAIT_FIELDS (`cipeUrl,commitSha,cipeStatus`)
|
||||
- **Normal mode (first poll or after newCipeDetected)**: use LIGHT_FIELDS
|
||||
|
||||
Call the `ci_information` tool with the determined `select` fields for the current branch. Wait for the result before proceeding.
|
||||
|
||||
#### 2b. Run decision script
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-poll-decide.mjs '<subagent_result_json>' <poll_count> <verbosity> \\
|
||||
[--wait-mode] \\
|
||||
[--prev-cipe-url <last_cipe_url>] \\
|
||||
[--expected-sha <expected_commit_sha>] \\
|
||||
[--prev-status <prev_status>] \\
|
||||
[--timeout <timeout_seconds>] \\
|
||||
[--new-cipe-timeout <new_cipe_timeout_seconds>] \\
|
||||
[--env-rerun-count <env_rerun_count>] \\
|
||||
[--no-progress-count <no_progress_count>] \\
|
||||
[--prev-cipe-status <prev_cipe_status>] \\
|
||||
[--prev-sh-status <prev_sh_status>] \\
|
||||
[--prev-verification-status <prev_verification_status>] \\
|
||||
[--prev-failure-classification <prev_failure_classification>]
|
||||
```
|
||||
|
||||
The script outputs a single JSON line: `{ action, code, message, delay?, noProgressCount, envRerunCount, fields?, newCipeDetected?, verifiableTaskIds? }`
|
||||
|
||||
#### 2c. Process script output
|
||||
|
||||
Parse the JSON output and update tracking state:
|
||||
|
||||
- `no_progress_count = output.noProgressCount`
|
||||
- `env_rerun_count = output.envRerunCount`
|
||||
- `prev_cipe_status = subagent_result.cipeStatus`
|
||||
- `prev_sh_status = subagent_result.selfHealingStatus`
|
||||
- `prev_verification_status = subagent_result.verificationStatus`
|
||||
- `prev_failure_classification = subagent_result.failureClassification`
|
||||
- `prev_status = output.action + ":" + (output.code || subagent_result.cipeStatus)`
|
||||
- `poll_count++`
|
||||
|
||||
Based on `action`:
|
||||
|
||||
- **`action == "poll"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- If `output.newCipeDetected`: clear wait mode, reset `wait_mode = false`
|
||||
- **`action == "wait"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- **`action == "done"`**: Proceed to Step 3 with `output.code`
|
||||
|
||||
### Step 3: Handle Actionable Status
|
||||
|
||||
When decision script returns `action == "done"`:
|
||||
|
||||
1. Run cycle-check (Step 4) **before** handling the code
|
||||
2. Check the returned `code`
|
||||
3. Look up default behavior in the table above
|
||||
4. Check if user instructions override the default
|
||||
5. Execute the appropriate action
|
||||
6. **If action expects new CI Attempt**, update tracking (see Step 3a)
|
||||
7. If action results in looping, go to Step 2
|
||||
|
||||
#### Tool calls for actions
|
||||
|
||||
Several statuses require fetching additional data or calling tools:
|
||||
|
||||
- **fix_apply_ready**: Call `update_self_healing_fix` with action `APPLY`
|
||||
- **fix_needs_local_verify**: Call `ci_information` with HEAVY_FIELDS for fix details before local verification
|
||||
- **fix_needs_review**: Call `ci_information` with HEAVY_FIELDS → get `suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`
|
||||
- **fix_failed / no_fix**: Call `ci_information` with HEAVY_FIELDS → get `taskFailureSummaries` for local fix context
|
||||
- **environment_issue**: Call `update_self_healing_fix` with action `RERUN_ENVIRONMENT_STATE`
|
||||
- **self_healing_throttled**: Call `ci_information` with HEAVY_FIELDS → get `selfHealingSkipMessage`; then call `update_self_healing_fix` for each old fix
|
||||
|
||||
### Step 3a: Track State for New-CI-Attempt Detection
|
||||
|
||||
After actions that should trigger a new CI Attempt, run:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs post-action \\
|
||||
--action <type> \\
|
||||
--cipe-url <current_cipe_url> \\
|
||||
--commit-sha <git_rev_parse_HEAD>
|
||||
```
|
||||
|
||||
Action types: `fix-auto-applying`, `apply-mcp`, `apply-local-push`, `reject-fix-push`, `local-fix-push`, `env-rerun`, `auto-fix-push`, `empty-commit-push`
|
||||
|
||||
The script returns `{ waitMode, pollCount, lastCipeUrl, expectedCommitSha, agentTriggered }`. Update all tracking state from the output, then go to Step 2.
|
||||
|
||||
### Step 4: Cycle Classification and Progress Tracking
|
||||
|
||||
When the decision script returns `action == "done"`, run cycle-check **before** handling the code:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs cycle-check \\
|
||||
--code <code> \\
|
||||
[--agent-triggered] \\
|
||||
--cycle-count <cycle_count> --max-cycles <max_cycles> \\
|
||||
--env-rerun-count <env_rerun_count>
|
||||
```
|
||||
|
||||
The script returns `{ cycleCount, agentTriggered, envRerunCount, approachingLimit, message }`. Update tracking state from the output.
|
||||
|
||||
- If `approachingLimit` → ask user whether to continue (with 5 or 10 more cycles) or stop monitoring
|
||||
- If previous cycle was NOT agent-triggered (human pushed), log that human-initiated push was detected
|
||||
|
||||
#### Progress Tracking
|
||||
|
||||
- `no_progress_count`, circuit breaker (5 polls), and backoff reset are handled by ci-poll-decide.mjs (progress = any change in cipeStatus, selfHealingStatus, verificationStatus, or failureClassification)
|
||||
- `env_rerun_count` reset on non-environment status is handled by ci-state-update.mjs cycle-check
|
||||
- On new CI Attempt detected (poll script returns `newCipeDetected`) → reset `local_verify_count = 0`, `env_rerun_count = 0`
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx-cloud apply-locally` fails | Reject fix via MCP (`action: "REJECT"`), then attempt manual patch (Reject + Fix From Scratch Flow) or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| Decision script error | Treat as `error` status, increment `no_progress_count` |
|
||||
| No new CI Attempt detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CI-Attempt failures |
|
||||
| "wait 45 min for new CI Attempt" | Override new-CI-Attempt timeout (default: 10 min) |"""
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"nx-mcp": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["nx", "mcp"]
|
||||
}
|
||||
},
|
||||
"contextFileName": "AGENTS.md"
|
||||
}
|
||||
@@ -0,0 +1,437 @@
|
||||
---
|
||||
name: ci-monitor
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes automatically. Checks for Nx Cloud connection before starting.
|
||||
---
|
||||
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `$ARGUMENTS` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \| Elapsed: Xm \| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
#
|
||||
# https://help.github.com/articles/dealing-with-line-endings/
|
||||
#
|
||||
# Linux start script should use lf
|
||||
/gradlew text eol=lf
|
||||
# These are Windows script files and should use crlf
|
||||
*.bat text eol=crlf
|
||||
# Exclude files from Graphite reviews
|
||||
docs/generated/* linguist-generated=true
|
||||
*.pdf,*.gif,*.mp4,*.webp,*.avif,*.png,*.jpeg,*.jpg,*.tiff filter=lfs diff=lfs merge=lfs -text
|
||||
@@ -0,0 +1,83 @@
|
||||
name: 🐞 Bug Report
|
||||
description: This form is to report unexpected behavior in Nx.
|
||||
labels: ["type: bug"]
|
||||
type: Bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for taking your precious time to file an issue! 🙏 We are sorry for the inconvenience this issue has caused you and want to resolve it as soon as possible.
|
||||
|
||||
Help us help you! We know that your time is precious and hate to ask for any more of it, but the first step in fixing this issue is to understand the issue. Taking some extra time to ensure that we are able to reproduce the issue will help us significantly in resolving the issue.
|
||||
- type: textarea
|
||||
id: current-behavior
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: What is the behavior that currently you experience?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: What is the behavior that you expect to happen?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: repo
|
||||
attributes:
|
||||
label: GitHub Repo
|
||||
description: |
|
||||
This is extremely important! If this issue is reproduce-able on https://github.com/nrwl/nx-examples, you may use that as the repo.
|
||||
If not, please do take a few minutes of your time to create a repo to help us reproduce the issue.
|
||||
This is the best way to help us reproduce the issue and fix it as soon as possible.
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Please provide some instructions to reproduce the issue in the repo provided above. Be as detailed as possible.
|
||||
value: |
|
||||
1.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: nx-report
|
||||
attributes:
|
||||
label: Nx Report
|
||||
description: Please paste the contents shown by `nx report`. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Failure Logs
|
||||
description: Please include any relevant log snippets or files here. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: input
|
||||
id: pm
|
||||
attributes:
|
||||
label: Package Manager Version
|
||||
description: |
|
||||
If `nx report` doesn't work, please provide the name and the version of your package manager.
|
||||
You can get version information by running `PACKAGE_MANAGER --version`, where PACKAGE_MANAGER is any of `yarn`, `pnpm`, `bun` or `npm`, depending on the package manager used.
|
||||
- type: checkboxes
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating System
|
||||
description: What Operating System are you using?
|
||||
options:
|
||||
- label: macOS
|
||||
- label: Linux
|
||||
- label: Windows
|
||||
- label: Other (Please specify)
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Is there any additional information that you can provide?
|
||||
- type: markdown
|
||||
id: disclaimer
|
||||
attributes:
|
||||
value: |
|
||||
> If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce. Please do your best to fill out all of the sections above.
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
name: "📖 Documentation issue"
|
||||
about: Help improve our docs.
|
||||
labels: "type: docs"
|
||||
---
|
||||
### Documentation issue
|
||||
|
||||
<!-- (Update "[ ]" to "[x]" to check a box) -->
|
||||
|
||||
- [ ] Reporting a typo
|
||||
- [ ] Reporting a documentation bug
|
||||
- [ ] Documentation improvement
|
||||
- [ ] Documentation feedback
|
||||
|
||||
<!--
|
||||
If your issue is not regarding the documentation, please choose an issue type:
|
||||
https://github.com/nrwl/nx/issues/new/choose
|
||||
-->
|
||||
|
||||
### Is there a specific documentation page you are reporting?
|
||||
|
||||
Enter the URL or documentation section here.
|
||||
|
||||
### Additional context or description
|
||||
|
||||
Provide any additional details here as needed.
|
||||
@@ -0,0 +1,17 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: "\U0001F680 Feature Request"
|
||||
about: "Suggest a new feature to make Nx better"
|
||||
url: https://github.com/nrwl/nx/discussions/new?category=feature-requests
|
||||
- name: Start a Discussion
|
||||
about: "Start a discussion to share your experience with Nx"
|
||||
url: https://github.com/nrwl/nx/discussions/new/choose
|
||||
- name: Join the Discord
|
||||
url: https://go.nx.dev/community
|
||||
about: "The Nx Official Discord Server is a great place for questions to be asked and answered. Please use the #forum if you need help with your workspace!"
|
||||
- name: Are you looking for integration with a new tool?
|
||||
url: https://nx.dev/community
|
||||
about: "There are a lot of awesome Plugins for Nx provided by the community! Check here to see if there is a community plugin to integrate your tool."
|
||||
- name: Read the community guidelines
|
||||
about: "Please make sure you have read the submission guidelines before posting an issue"
|
||||
url: https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-an-issue
|
||||
@@ -0,0 +1,18 @@
|
||||
<!-- Please make sure you have read the submission guidelines before posting an PR -->
|
||||
<!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr -->
|
||||
|
||||
<!-- Please make sure that your commit message follows our format -->
|
||||
<!-- Example: `fix(nx): must begin with lowercase` -->
|
||||
|
||||
<!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. -->
|
||||
|
||||
## Current Behavior
|
||||
<!-- This is the behavior we have today -->
|
||||
|
||||
## Expected Behavior
|
||||
<!-- This is the behavior we should expect with the changes in this PR -->
|
||||
|
||||
## Related Issue(s)
|
||||
<!-- Please link the issue being fixed so it gets closed when this is merged. -->
|
||||
|
||||
Fixes #
|
||||
@@ -0,0 +1,56 @@
|
||||
<!--
|
||||
_[Please make sure you have read the submission guidelines before posting an PR](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-pr)_
|
||||
|
||||
# Community Plugin Submission
|
||||
|
||||
Thanks for submitting your Nx Plugin to our community plugins list. Make sure to follow these steps to ensure that your PR is approved in a timely manner.
|
||||
|
||||
## Plugin Requirements
|
||||
|
||||
Before you submit your plugin to be listed in our registry, it needs to meet the following requirements:
|
||||
- Run some kind of automated e2e tests in your repository
|
||||
- Include `@nx/devkit` as a `dependency` in the plugin's `package.json`
|
||||
- List a `repository.url` in the plugin's `package.json`
|
||||
|
||||
i.e.
|
||||
|
||||
```
|
||||
{
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/nrwl/nx.git",
|
||||
"directory": "packages/web"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Note: We reserve the right to remove unmaintained plugins from the registry. If the plugins become maintained again, they can be resubmitted to the registry.
|
||||
|
||||
## Steps to Submit Your Plugin
|
||||
- Use the following commit message template: `chore(core): nx plugin submission [PLUGIN_NAME]`
|
||||
- Update the `astro-docs/src/content/approved-community-plugins.json` file with a new entry for your plugin that includes `name`, `url`, `description`:
|
||||
|
||||
Example:
|
||||
|
||||
```json
|
||||
// astro-docs/src/content/approved-community-plugins.json
|
||||
|
||||
[{
|
||||
"name": "@community/plugin",
|
||||
"url": "https://github.com/community/plugin",
|
||||
"description": "This plugin provides the following capabilities."
|
||||
}]
|
||||
```
|
||||
|
||||
Once merged, your plugin will be available when running the `nx list` command, and will also be available in the Plugin Registry on [nx.dev](https://nx.dev/docs/plugin-registry)
|
||||
-->
|
||||
|
||||
# Community Plugin Submission
|
||||
|
||||
## {replace with plugin's name}
|
||||
|
||||
<!--
|
||||
Describe what your plugin is and what is its goal or issues it addresses. If you don't provide a description, we will not merge your PR.
|
||||
Is it focused on a technology, tooling or behaviour? Does the plugin provide generators, executors or graph support?
|
||||
Do you know who is already using the plugin? Mention who is the author of the plugin.
|
||||
-->
|
||||
@@ -0,0 +1,67 @@
|
||||
# Saved Responses for Nx's Issue Tracker
|
||||
|
||||
The following are canned responses that the Nx team should use to close issues on our issue tracker that fall into the listed resolution categories.
|
||||
|
||||
Since GitHub currently doesn't allow us to have a repository-wide or organization-wide list of [saved replies](https://help.github.com/articles/working-with-saved-replies/), these replies need to be maintained by individual team members. Since the responses can be modified in the future, all responses are versioned to simplify the process of keeping the responses up to date.
|
||||
|
||||
## Nx: Already Fixed
|
||||
|
||||
```
|
||||
Thanks for reporting this issue. Luckily, it has already been fixed in one of the recent releases. Please update to the most recent version to resolve the problem.
|
||||
|
||||
If the problem persists in your application after upgrading, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior. You can use `create-nx-workspace my-issue` and then `ng g app my-app` to create a new project where you reproduce the problem.
|
||||
```
|
||||
|
||||
## Nx: Don't Understand
|
||||
|
||||
```
|
||||
I'm sorry, but we don't understand the problem you are reporting.
|
||||
|
||||
Please provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior. You can use `create-nx-workspace my-issue` to create a new project where you reproduce the problem.
|
||||
```
|
||||
|
||||
## Nx: Duplicate
|
||||
|
||||
```
|
||||
Thanks for reporting this issue. However, this issue is a duplicate of #<ISSUE_NUMBER>. Please subscribe to that issue for future updates.
|
||||
```
|
||||
|
||||
## Nx: Insufficient Information Provided
|
||||
|
||||
```
|
||||
Thanks for reporting this issue. However, you didn't provide sufficient information for us to understand and reproduce the problem. Please check out [our submission guidelines](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-an-issue) to understand why we can't act on issues that are lacking important information.
|
||||
|
||||
Please ensure you provide all of the required information when filling out the issue template.
|
||||
```
|
||||
|
||||
## Nx: NPM install issue
|
||||
|
||||
```
|
||||
This seems like a problem with your node/npm and not with Nx.
|
||||
|
||||
Please have a look at the [fixing npm permissions page](https://docs.npmjs.com/getting-started/fixing-npm-permissions), [common errors page](https://docs.npmjs.com/troubleshooting/common-errors), [npm issue tracker](https://github.com/npm/npm/issues), or open a new issue if the problem you are experiencing isn't known.
|
||||
```
|
||||
|
||||
## Nx: Issue Outside of Nx
|
||||
|
||||
```
|
||||
I'm sorry, but this issue is not caused by Nx. Please contact the author(s) of the <PROJECT NAME> project or file an issue on their issue tracker.
|
||||
```
|
||||
|
||||
## Nx: Non-reproducible
|
||||
|
||||
```
|
||||
I'm sorry, but we can't reproduce the problem following the instructions you provided.
|
||||
Remember that we have a large number of issues to resolve, and have only a limited amount of time to reproduce your issue.
|
||||
Short, explicit instructions make it much more likely we'll be able to reproduce the problem so we can fix it.
|
||||
|
||||
A good way to make a minimal repro is to create a new app via `create-nx-workspace my-issue` and then `ng g app my-app` and adding the minimum possible code to show the problem. Then you can push this repository to github and link it here.
|
||||
```
|
||||
|
||||
## Nx: Obsolete
|
||||
|
||||
```
|
||||
Thanks for reporting this issue. This issue is now obsolete due to changes in the recent releases. Please update to the most recent Nx version.
|
||||
|
||||
If the problem persists after upgrading, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior.
|
||||
```
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: CI helper for /monitor-ci. Fetches CI status, retrieves fix details, or updates self-healing fixes. Executes one MCP tool call and returns the result.
|
||||
---
|
||||
|
||||
# CI Monitor Subagent
|
||||
|
||||
You are a CI helper. You call ONE MCP tool per invocation and return the result. Do not loop, poll, or sleep.
|
||||
|
||||
## Commands
|
||||
|
||||
The main agent tells you which command to run:
|
||||
|
||||
### FETCH_STATUS
|
||||
|
||||
Call `ci_information` with the provided branch and select fields. Return a JSON object with ONLY these fields:
|
||||
`{ cipeStatus, selfHealingStatus, verificationStatus, selfHealingEnabled, selfHealingSkippedReason, failureClassification, failedTaskIds, verifiedTaskIds, couldAutoApplyTasks, autoApplySkipped, autoApplySkipReason, userAction, cipeUrl, commitSha, shortLink }`
|
||||
|
||||
### FETCH_HEAVY
|
||||
|
||||
Call `ci_information` with heavy select fields. Summarize the heavy content and return:
|
||||
|
||||
```json
|
||||
{
|
||||
"shortLink": "...",
|
||||
"failedTaskIds": ["..."],
|
||||
"verifiedTaskIds": ["..."],
|
||||
"suggestedFixDescription": "...",
|
||||
"suggestedFixSummary": "...",
|
||||
"selfHealingSkipMessage": "...",
|
||||
"taskFailureSummaries": [{ "taskId": "...", "summary": "..." }]
|
||||
}
|
||||
```
|
||||
|
||||
Do NOT return raw suggestedFix diffs or raw taskOutputSummary — summarize them.
|
||||
The main agent uses these summaries to understand what failed and attempt local fixes.
|
||||
|
||||
### UPDATE_FIX
|
||||
|
||||
Call `update_self_healing_fix` with the provided shortLink and action (APPLY/REJECT/RERUN_ENVIRONMENT_STATE). Return the result message (success/failure string).
|
||||
|
||||
### FETCH_THROTTLE_INFO
|
||||
|
||||
Call `ci_information` with the provided URL. Return ONLY: `{ shortLink, cipeUrl }`
|
||||
|
||||
## Important
|
||||
|
||||
- Execute ONE command and return immediately
|
||||
- Do NOT poll, loop, sleep, or make decisions
|
||||
- Extract and return ONLY the fields specified for each command — do NOT dump the full MCP response
|
||||
@@ -0,0 +1,478 @@
|
||||
---
|
||||
description: Polls Nx Cloud CI pipeline and self-healing status. Returns structured state when actionable. Spawned by /nx-cloud-ci-monitor command to monitor CI Attempt status.
|
||||
---
|
||||
|
||||
# CI Watcher Subagent
|
||||
|
||||
You are a CI monitoring subagent responsible for polling Nx Cloud CI Attempt status and self-healing state. You report status back to the main agent - you do NOT make apply/reject decisions.
|
||||
|
||||
## Your Responsibilities
|
||||
|
||||
1. Poll CI status using the `ci_information` MCP tool
|
||||
2. Implement exponential backoff between polls
|
||||
3. Return structured state when an actionable condition is reached
|
||||
4. Track iteration count and elapsed time
|
||||
5. Output status updates based on verbosity level
|
||||
|
||||
## Input Parameters (from Main Agent)
|
||||
|
||||
The main agent may provide these optional parameters in the prompt:
|
||||
|
||||
| Parameter | Description |
|
||||
| ------------------- | -------------------------------------------------------- |
|
||||
| `branch` | Branch to monitor (auto-detected if not provided) |
|
||||
| `expectedCommitSha` | Commit SHA that should trigger a new CI Attempt |
|
||||
| `previousCipeUrl` | CI Attempt URL before the action (to detect change) |
|
||||
| `subagentTimeout` | Polling timeout in minutes (default: 60) |
|
||||
| `verbosity` | Output level: minimal, medium, verbose (default: medium) |
|
||||
|
||||
When `expectedCommitSha` or `previousCipeUrl` is provided, you must detect whether a new CI Attempt has spawned.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
### `ci_information`
|
||||
|
||||
**Input:**
|
||||
|
||||
```json
|
||||
{
|
||||
"branch": "string (optional, defaults to current git branch)",
|
||||
"select": "string (optional, comma-separated field names)",
|
||||
"pageToken": "number (optional, 0-based pagination for long strings)"
|
||||
}
|
||||
```
|
||||
|
||||
**Output:**
|
||||
|
||||
```json
|
||||
{
|
||||
"cipeStatus": "NOT_STARTED | IN_PROGRESS | SUCCEEDED | FAILED | CANCELED | TIMED_OUT",
|
||||
"cipeUrl": "string",
|
||||
"branch": "string",
|
||||
"commitSha": "string | null",
|
||||
"failedTaskIds": "string[]",
|
||||
"verifiedTaskIds": "string[]",
|
||||
"selfHealingEnabled": "boolean",
|
||||
"selfHealingStatus": "NOT_STARTED | IN_PROGRESS | COMPLETED | FAILED | NOT_EXECUTABLE | null",
|
||||
"verificationStatus": "NOT_STARTED | IN_PROGRESS | COMPLETED | FAILED | NOT_EXECUTABLE | null",
|
||||
"userAction": "NONE | APPLIED | REJECTED | APPLIED_LOCALLY | APPLIED_AUTOMATICALLY | null",
|
||||
"failureClassification": "string | null",
|
||||
"taskOutputSummary": "string | null",
|
||||
"suggestedFixReasoning": "string | null",
|
||||
"suggestedFixDescription": "string | null",
|
||||
"suggestedFix": "string | null",
|
||||
"shortLink": "string | null",
|
||||
"couldAutoApplyTasks": "boolean | null",
|
||||
"confidence": "number | null",
|
||||
"confidenceReasoning": "string | null"
|
||||
}
|
||||
```
|
||||
|
||||
**Select Parameter:**
|
||||
|
||||
| Usage | Returns |
|
||||
| --------------- | ----------------------------------------------------------- |
|
||||
| No `select` | Formatted overview (truncated, not recommended for polling) |
|
||||
| Single field | Raw value with pagination for long strings |
|
||||
| Multiple fields | Object with requested field values |
|
||||
|
||||
**Field Sets for Efficient Polling:**
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS:
|
||||
'cipeUrl,commitSha,cipeStatus'
|
||||
# Minimal fields for detecting new CI Attempt
|
||||
|
||||
LIGHT_FIELDS:
|
||||
'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,shortLink,confidence,confidenceReasoning'
|
||||
# Status fields for determining actionable state
|
||||
|
||||
HEAVY_FIELDS:
|
||||
'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
# Large content fields - fetch only when returning to main agent
|
||||
```
|
||||
|
||||
## Initial Wait
|
||||
|
||||
Before first poll, wait based on context:
|
||||
|
||||
- **Fresh start (no expected CIPE):** Wait 60 seconds to allow CI to start
|
||||
- **Expecting new CIPE:** Wait 30 seconds (action already triggered)
|
||||
|
||||
**IMPORTANT:** Always run sleep in foreground, NOT as background command.
|
||||
|
||||
```bash
|
||||
sleep 60 # or 30 if expecting new CIPE (FOREGROUND, not background)
|
||||
```
|
||||
|
||||
## Two-Phase Operation
|
||||
|
||||
The subagent operates in one of two modes depending on input:
|
||||
|
||||
### Mode 1: Fresh Start (no `expectedCommitSha` or `previousCipeUrl`)
|
||||
|
||||
Normal polling - process whatever CIPE is returned by `ci_information`.
|
||||
|
||||
### Mode 2: Wait-for-New-CIPE (when `expectedCommitSha` or `previousCipeUrl` provided)
|
||||
|
||||
**CRITICAL**: When expecting a new CIPE, the subagent must **completely ignore** the old/stale CIPE. Do NOT process its status, do NOT return actionable states based on it.
|
||||
|
||||
#### Phase A: Wait Mode
|
||||
|
||||
1. Start a **new-CIPE timeout** timer (default: 30 minutes)
|
||||
2. On each poll of `ci_information`:
|
||||
- Check if CIPE is NEW:
|
||||
- `cipeUrl` differs from `previousCipeUrl` → **new CIPE detected**
|
||||
- `commitSha` matches `expectedCommitSha` → **correct CIPE detected**
|
||||
- If still OLD CIPE: **ignore all status fields**, just wait and poll again
|
||||
- Do NOT return `fix_available`, `ci_success`, etc. based on old CIPE!
|
||||
3. Output wait status (see below)
|
||||
4. If timeout (30 min) reached → return `no_new_cipe`
|
||||
|
||||
#### Phase B: Normal Polling (after new CIPE detected)
|
||||
|
||||
Once new CIPE is detected:
|
||||
|
||||
1. Clear the new-CIPE timeout
|
||||
2. Switch to normal polling mode
|
||||
3. Process the NEW CIPE's status normally
|
||||
4. Return when actionable state reached
|
||||
|
||||
### Wait Mode Output
|
||||
|
||||
While in wait mode, output clearly that you're waiting (not processing):
|
||||
|
||||
```
|
||||
[CI Monitor] ═══════════════════════════════════════════════════════
|
||||
[CI Monitor] WAIT MODE - Expecting new CI Attempt
|
||||
[CI Monitor] Expected SHA: <expectedCommitSha>
|
||||
[CI Monitor] Previous CI Attempt: <previousCipeUrl>
|
||||
[CI Monitor] ═══════════════════════════════════════════════════════
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 0m 30s)
|
||||
[CI Monitor] Still seeing previous CI Attempt (ignoring): <oldCipeUrl>
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 1m 30s)
|
||||
[CI Monitor] Still seeing previous CI Attempt (ignoring): <oldCipeUrl>
|
||||
|
||||
[CI Monitor] Polling... (elapsed: 2m 30s)
|
||||
[CI Monitor] ✓ New CI Attempt detected! URL: <newCipeUrl>, SHA: <newCommitSha>
|
||||
[CI Monitor] Switching to normal polling mode...
|
||||
```
|
||||
|
||||
### Why This Matters (Context Preservation)
|
||||
|
||||
**The problem**: Stale CIPE data can be very large:
|
||||
|
||||
- `taskOutputSummary`: potentially thousands of characters of build/test output
|
||||
- `suggestedFix`: entire patch files
|
||||
- `suggestedFixReasoning`: detailed explanation
|
||||
|
||||
If subagent returns stale CIPE data to main agent, it **pollutes main agent's context** with useless information (we already processed that CIPE). This wastes valuable context window.
|
||||
|
||||
**Without wait mode:**
|
||||
|
||||
1. Poll `ci_information` → get old CIPE with huge data
|
||||
2. Return to main agent with all that stale data
|
||||
3. Main agent's context gets polluted with useless info
|
||||
4. Main agent has to process/ignore it anyway
|
||||
|
||||
**With wait mode:**
|
||||
|
||||
1. Poll `ci_information` → get old CIPE → **ignore it, don't return**
|
||||
2. Keep waiting internally (stale data stays in subagent)
|
||||
3. New CIPE appears → switch to normal mode
|
||||
4. Return to main agent with only the NEW, relevant CIPE data
|
||||
|
||||
## Polling Loop
|
||||
|
||||
### Subagent State Management
|
||||
|
||||
Maintain internal accumulated state across polls:
|
||||
|
||||
```
|
||||
accumulated_state = {}
|
||||
```
|
||||
|
||||
### Call `ci_information` MCP Tool
|
||||
|
||||
**Wait Mode (expecting new CI Attempt):**
|
||||
|
||||
```
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "cipeUrl,commitSha,cipeStatus"
|
||||
})
|
||||
```
|
||||
|
||||
Only fetch minimal fields needed to detect CI Attempt change. Do NOT fetch heavy fields - stale data wastes context.
|
||||
|
||||
**Normal Mode (processing CI Attempt):**
|
||||
|
||||
```
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,shortLink,confidence,confidenceReasoning"
|
||||
})
|
||||
```
|
||||
|
||||
Merge response into `accumulated_state` after each poll.
|
||||
|
||||
### Analyze Response
|
||||
|
||||
**If in Wait Mode** (expecting new CIPE):
|
||||
|
||||
1. Check if CIPE is new (see Two-Phase Operation above)
|
||||
2. If old CIPE → **ignore status**, output wait message, poll again
|
||||
3. If new CIPE → switch to normal mode, continue below
|
||||
|
||||
**If in Normal Mode**:
|
||||
Based on the response, decide whether to **keep polling** or **return to main agent**.
|
||||
|
||||
### Keep Polling When
|
||||
|
||||
Continue polling (with backoff) if ANY of these conditions are true:
|
||||
|
||||
| Condition | Reason |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| `cipeStatus == 'IN_PROGRESS'` | CI still running |
|
||||
| `cipeStatus == 'NOT_STARTED'` | CI hasn't started yet |
|
||||
| `selfHealingStatus == 'IN_PROGRESS'` | Self-healing agent working |
|
||||
| `selfHealingStatus == 'NOT_STARTED'` | Self-healing not started yet |
|
||||
| `failureClassification == 'FLAKY_TASK'` | Auto-rerun in progress |
|
||||
| `userAction == 'APPLIED_AUTOMATICALLY'` | New CI Attempt spawning after auto-apply |
|
||||
|
||||
When `couldAutoApplyTasks == true`:
|
||||
|
||||
- `verificationStatus` = `NOT_STARTED`, `IN_PROGRESS` → keep polling (verification still in progress)
|
||||
- `verificationStatus` = `COMPLETED` → return `fix_auto_applying` (auto-apply will happen, main agent spawns wait mode subagent)
|
||||
- `verificationStatus` = `FAILED`, `NOT_EXECUTABLE` → return `fix_available` (auto-apply won't happen, needs manual action)
|
||||
|
||||
### Exponential Backoff
|
||||
|
||||
Between polls, wait with exponential backoff:
|
||||
|
||||
| Poll Attempt | Wait Time |
|
||||
| ------------ | ----------------- |
|
||||
| 1st | 60 seconds |
|
||||
| 2nd | 90 seconds |
|
||||
| 3rd+ | 120 seconds (cap) |
|
||||
|
||||
Reset to 60 seconds when state changes significantly.
|
||||
|
||||
**IMPORTANT:** Run sleep in foreground (NOT as background command). Background sleep causes "What should Claude do?" prompts when completed.
|
||||
|
||||
```bash
|
||||
# Example backoff - run in FOREGROUND
|
||||
sleep 60 # First wait
|
||||
sleep 90 # Second wait
|
||||
sleep 120 # Third and subsequent waits (capped)
|
||||
```
|
||||
|
||||
### Fetch Heavy Fields on Actionable State
|
||||
|
||||
Before returning to main agent, fetch heavy fields if the status requires them:
|
||||
|
||||
| Status | Heavy Fields Needed |
|
||||
| ------------------- | ------------------------------------------------------------------------------ |
|
||||
| `ci_success` | None |
|
||||
| `fix_auto_applying` | None |
|
||||
| `fix_available` | `taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription` |
|
||||
| `fix_failed` | `taskOutputSummary` |
|
||||
| `no_fix` | `taskOutputSummary` |
|
||||
| `environment_issue` | None |
|
||||
| `no_new_cipe` | None |
|
||||
| `polling_timeout` | None |
|
||||
| `cipe_canceled` | None |
|
||||
| `cipe_timed_out` | None |
|
||||
|
||||
```
|
||||
# Example: fetching heavy fields for fix_available
|
||||
ci_information({
|
||||
branch: "<branch_name>",
|
||||
select: "taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription"
|
||||
})
|
||||
```
|
||||
|
||||
Merge response into `accumulated_state`, then return merged state to main agent.
|
||||
|
||||
**Pagination:** Heavy string fields return first page only. If `hasMore` indicated, include in return format so main agent knows more content available.
|
||||
|
||||
### Return to Main Agent When
|
||||
|
||||
Return immediately with structured state if ANY of these conditions are true:
|
||||
|
||||
| Status | Condition |
|
||||
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | `cipeStatus == 'SUCCEEDED'` |
|
||||
| `fix_auto_applying` | `selfHealingStatus == 'COMPLETED'` AND `couldAutoApplyTasks == true` AND `verificationStatus == 'COMPLETED'` |
|
||||
| `fix_available` | `selfHealingStatus == 'COMPLETED'` AND `suggestedFix != null` AND (`couldAutoApplyTasks != true` OR `verificationStatus` in (`FAILED`, `NOT_EXECUTABLE`)) |
|
||||
| `fix_failed` | `selfHealingStatus == 'FAILED'` |
|
||||
| `environment_issue` | `failureClassification == 'ENVIRONMENT_STATE'` |
|
||||
| `no_fix` | `cipeStatus == 'FAILED'` AND (`selfHealingEnabled == false` OR `selfHealingStatus == 'NOT_EXECUTABLE'`) |
|
||||
| `no_new_cipe` | `expectedCommitSha` or `previousCipeUrl` provided, but no new CI Attempt detected after 30 min |
|
||||
| `polling_timeout` | Subagent has been polling for > configured timeout (default 60 min) |
|
||||
| `cipe_canceled` | `cipeStatus == 'CANCELED'` |
|
||||
| `cipe_timed_out` | `cipeStatus == 'TIMED_OUT'` |
|
||||
|
||||
## Subagent Timeout
|
||||
|
||||
Track elapsed time. If you have been polling for more than **60 minutes** (configurable via main agent), return with `status: polling_timeout`.
|
||||
|
||||
## Return Format
|
||||
|
||||
When returning to the main agent, provide a structured response with accumulated state:
|
||||
|
||||
```
|
||||
## CI Monitor Result
|
||||
|
||||
**Status:** <status>
|
||||
**Iterations:** <count>
|
||||
**Elapsed:** <minutes>m <seconds>s
|
||||
|
||||
### CI Attempt Details
|
||||
- **Status:** <cipeStatus>
|
||||
- **URL:** <cipeUrl>
|
||||
- **Branch:** <branch>
|
||||
- **Commit:** <commitSha>
|
||||
- **Failed Tasks:** <failedTaskIds>
|
||||
- **Verified Tasks:** <verifiedTaskIds>
|
||||
|
||||
### Self-Healing Details
|
||||
- **Enabled:** <selfHealingEnabled>
|
||||
- **Status:** <selfHealingStatus>
|
||||
- **Verification:** <verificationStatus>
|
||||
- **User Action:** <userAction>
|
||||
- **Classification:** <failureClassification>
|
||||
- **Confidence:** <confidence>
|
||||
- **Confidence Reasoning:** <confidenceReasoning>
|
||||
|
||||
### Fix Information (if available)
|
||||
- **Short Link:** <shortLink>
|
||||
- **Description:** <suggestedFixDescription>
|
||||
- **Reasoning:** <suggestedFixReasoning>
|
||||
|
||||
### Task Output Summary (first page)
|
||||
<taskOutputSummary>
|
||||
[MORE_CONTENT_AVAILABLE: taskOutputSummary, pageToken: 1]
|
||||
|
||||
### Suggested Fix (first page)
|
||||
<suggestedFix>
|
||||
[MORE_CONTENT_AVAILABLE: suggestedFix, pageToken: 1]
|
||||
```
|
||||
|
||||
### Pagination Indicators
|
||||
|
||||
When a heavy field has more content available, append indicator:
|
||||
|
||||
```
|
||||
[MORE_CONTENT_AVAILABLE: <fieldName>, pageToken: <nextPage>]
|
||||
```
|
||||
|
||||
Main agent can fetch additional pages if needed using:
|
||||
|
||||
```
|
||||
ci_information({ select: "<fieldName>", pageToken: <nextPage> })
|
||||
```
|
||||
|
||||
Fields that may have pagination:
|
||||
|
||||
- `taskOutputSummary` (reverse pagination - page 0 = most recent)
|
||||
- `suggestedFix` (forward pagination - page 0 = start)
|
||||
- `suggestedFixReasoning`
|
||||
|
||||
### Return Format for `no_new_cipe`
|
||||
|
||||
When returning with `status: no_new_cipe`, include additional context:
|
||||
|
||||
```
|
||||
## CI Monitor Result
|
||||
|
||||
**Status:** no_new_cipe
|
||||
**Iterations:** <count>
|
||||
**Elapsed:** <minutes>m <seconds>s
|
||||
|
||||
### Expected CI Attempt Not Found
|
||||
- **Expected Commit SHA:** <expectedCommitSha>
|
||||
- **Previous CI Attempt URL:** <previousCipeUrl>
|
||||
- **Last Seen CI Attempt URL:** <cipeUrl>
|
||||
- **Last Seen Commit SHA:** <commitSha>
|
||||
- **New CI Attempt Timeout:** 30 minutes (exceeded)
|
||||
|
||||
### Likely Cause
|
||||
CI workflow failed before Nx tasks could run (e.g., install step, checkout, auth).
|
||||
Check your CI provider logs for the commit <expectedCommitSha>.
|
||||
|
||||
### Last Known CI Attempt State
|
||||
- **Status:** <cipeStatus>
|
||||
- **Branch:** <branch>
|
||||
```
|
||||
|
||||
## Status Reporting (Verbosity-Controlled)
|
||||
|
||||
Output is controlled by the `verbosity` parameter from the main agent:
|
||||
|
||||
| Level | What to Output |
|
||||
| --------- | ----------------------------------------------------------------- |
|
||||
| `minimal` | No intermediate output. Only return final result when actionable. |
|
||||
| `medium` | Output only on significant state changes (not every poll). |
|
||||
| `verbose` | Output detailed phase information after every poll. |
|
||||
|
||||
### Minimal Verbosity
|
||||
|
||||
No output during polling. Poll silently and return when done.
|
||||
|
||||
### Medium Verbosity (Default)
|
||||
|
||||
Output **only when state changes significantly** to save context tokens:
|
||||
|
||||
- `cipeStatus` changes (e.g., IN_PROGRESS → FAILED)
|
||||
- `selfHealingStatus` changes (e.g., IN_PROGRESS → COMPLETED)
|
||||
- New CI Attempt detected (in wait mode)
|
||||
|
||||
Format: single line, no decorators:
|
||||
|
||||
```
|
||||
[CI Monitor] CI: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 4m
|
||||
```
|
||||
|
||||
### Verbose Verbosity
|
||||
|
||||
Output detailed phase box after every poll:
|
||||
|
||||
```
|
||||
[CI Monitor] ─────────────────────────────────────────────────────
|
||||
[CI Monitor] Iteration <N> | Elapsed: <X>m <Y>s
|
||||
[CI Monitor]
|
||||
[CI Monitor] CI Status: <cipeStatus>
|
||||
[CI Monitor] Self-Healing: <selfHealingStatus>
|
||||
[CI Monitor] Verification: <verificationStatus>
|
||||
[CI Monitor] Classification: <failureClassification>
|
||||
[CI Monitor]
|
||||
[CI Monitor] → <human-readable phase description>
|
||||
[CI Monitor] ─────────────────────────────────────────────────────
|
||||
```
|
||||
|
||||
### Phase Descriptions (for verbose output)
|
||||
|
||||
| Status Combo | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||||
| `cipeStatus: IN_PROGRESS` | "CI running..." |
|
||||
| `cipeStatus: NOT_STARTED` | "Waiting for CI to start..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: NOT_STARTED` | "CI failed. Self-healing starting..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: IN_PROGRESS` | "CI failed. Self-healing generating fix..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: IN_PROGRESS` | "Fix generated! Verification running..." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: COMPLETED` | "Fix ready! Verified successfully." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: COMPLETED` + `verificationStatus: FAILED` | "Fix generated but verification failed." |
|
||||
| `cipeStatus: FAILED` + `selfHealingStatus: FAILED` | "Self-healing could not generate a fix." |
|
||||
| `cipeStatus: SUCCEEDED` | "CI passed!" |
|
||||
|
||||
## Important Notes
|
||||
|
||||
- You do NOT make apply/reject decisions - that's the main agent's job
|
||||
- You do NOT perform git operations
|
||||
- You only poll and report state
|
||||
- Respect the `verbosity` parameter for output (default: medium)
|
||||
- If `ci_information` returns an error, wait and retry (count as failed poll)
|
||||
- Track consecutive failures - if 5 consecutive failures, return with `status: error`
|
||||
- When expecting new CI Attempt, track the 30-minute new-CI-Attempt timeout separately from the main polling timeout
|
||||
@@ -0,0 +1,18 @@
|
||||
# This configuration is here to prevent false positive alerts for __fixtures__.
|
||||
# We are intentionally disabling the PR opening feature.
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: 'npm'
|
||||
directory: '/'
|
||||
schedule:
|
||||
interval: 'weekly'
|
||||
open-pull-requests-limit: 0
|
||||
exclude-paths:
|
||||
- '**/__fixtures__/**'
|
||||
|
||||
- package-ecosystem: 'github-actions'
|
||||
directory: '/'
|
||||
schedule:
|
||||
interval: 'weekly'
|
||||
open-pull-requests-limit: 0
|
||||
@@ -0,0 +1,437 @@
|
||||
---
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes automatically. Checks for Nx Cloud connection before starting.
|
||||
argument-hint: '[instructions] [--max-cycles N] [--timeout MINUTES] [--verbosity minimal|medium|verbose] [--branch BRANCH] [--fresh] [--auto-fix-workflow] [--new-cipe-timeout MINUTES]'
|
||||
---
|
||||
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
${input:args}
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `${input:args}` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \| Elapsed: Xm \| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```
|
||||
@@ -0,0 +1,301 @@
|
||||
---
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes. USE WHEN user says "monitor ci", "watch ci", "ci monitor", "watch ci for this branch", "track ci", "check ci status", wants to track CI status, or needs help with self-healing CI fixes. Prefer this skill over native CI provider tools (gh, glab, etc.) for CI monitoring — it integrates with Nx Cloud self-healing which those tools cannot access.
|
||||
argument-hint: '[instructions] [--max-cycles N] [--timeout MINUTES] [--verbosity minimal|medium|verbose] [--branch BRANCH] [--fresh] [--auto-fix-workflow] [--new-cipe-timeout MINUTES] [--local-verify-attempts N]'
|
||||
---
|
||||
|
||||
# Monitor CI Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn subagents to interact with Nx Cloud, run deterministic decision scripts, and take action based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
${input:args}
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum **agent-initiated** CI Attempt cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CI-Attempt failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CI Attempt after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `${input:args}` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
Before starting the monitoring loop, verify the workspace is connected to Nx Cloud. Without this connection, no CI data is available and the entire skill is inoperable.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
|
||||
```
|
||||
Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
1. **This skill (orchestrator)**: spawns subagents, runs scripts, prints status, does local coding work
|
||||
2. **ci-monitor-subagent (haiku)**: calls one MCP tool (ci_information or update_self_healing_fix), returns structured result, exits
|
||||
3. **ci-poll-decide.mjs (deterministic script)**: takes ci_information result + state, returns action + status message
|
||||
4. **ci-state-update.mjs (deterministic script)**: manages budget gates, post-action state transitions, and cycle classification
|
||||
|
||||
## Status Reporting
|
||||
|
||||
The decision script handles message formatting based on verbosity. When printing messages to the user:
|
||||
|
||||
- Prepend `[monitor-ci]` to every message from the script's `message` field
|
||||
- For your own action messages (e.g. "Applying fix via MCP..."), also prepend `[monitor-ci]`
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
These behaviors cause real problems — racing with self-healing, losing CI progress, or wasting context:
|
||||
|
||||
| Anti-Pattern | Why It's Bad |
|
||||
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| Using CI provider CLIs with `--watch` flags (e.g., `gh pr checks --watch`, `glab ci status -w`) | Bypasses Nx Cloud self-healing entirely |
|
||||
| Writing custom CI polling scripts | Unreliable, pollutes context, no self-healing |
|
||||
| Cancelling CI workflows/pipelines | Destructive, loses CI progress |
|
||||
| Running CI checks on main agent | Wastes main agent context tokens |
|
||||
| Independently analyzing/fixing CI failures while polling | Races with self-healing, causes duplicate fixes and confused state |
|
||||
|
||||
**If this skill fails to activate**, the fallback is:
|
||||
|
||||
1. Use CI provider CLI for a one-time, read-only status check (single call, no watch/polling flags)
|
||||
2. Immediately delegate to this skill with gathered context
|
||||
3. Do not continue polling on main agent — it wastes context tokens and bypasses self-healing
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
If the user previously ran `/monitor-ci` in this session, you may have prior state (poll counts, last CI Attempt URL, etc.). Resume from that state unless `--fresh` is set, in which case discard it and start from Step 1.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
Three field sets control polling efficiency — use the lightest set that gives you what you need:
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS: 'cipeUrl,commitSha,cipeStatus'
|
||||
LIGHT_FIELDS: 'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,autoApplySkipped,autoApplySkipReason,shortLink,confidence,confidenceReasoning,hints,selfHealingSkippedReason,selfHealingSkipMessage'
|
||||
HEAVY_FIELDS: 'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
```
|
||||
|
||||
The `ci_information` tool accepts `branch` (optional, defaults to current git branch), `select` (comma-separated field names), and `pageToken` (0-based pagination for long strings).
|
||||
|
||||
The `update_self_healing_fix` tool accepts a `shortLink` and an action: `APPLY`, `REJECT`, or `RERUN_ENVIRONMENT_STATE`.
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The decision script returns one of the following statuses. This table defines the **default behavior** for each. User instructions can override any of these.
|
||||
|
||||
**Simple exits** — just report and exit:
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success |
|
||||
| `cipe_canceled` | Exit, CI was canceled |
|
||||
| `cipe_timed_out` | Exit, CI timed out |
|
||||
| `polling_timeout` | Exit, polling timeout reached |
|
||||
| `circuit_breaker` | Exit, no progress after 13 consecutive polls |
|
||||
| `environment_rerun_cap` | Exit, environment reruns exhausted |
|
||||
| `fix_auto_applying` | Self-healing is handling it — just record `last_cipe_url`, enter wait mode. No MCP call or local git ops needed. |
|
||||
| `error` | Wait 60s and loop |
|
||||
|
||||
**Statuses requiring action** — when handling these in Step 3, read `references/fix-flows.md` for the detailed flow:
|
||||
|
||||
| Status | Summary |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------- |
|
||||
| `fix_auto_apply_skipped` | Fix verified but auto-apply skipped (e.g., loop prevention). Inform user, offer manual apply. |
|
||||
| `fix_apply_ready` | Fix verified (all tasks or e2e-only). Apply via MCP. |
|
||||
| `fix_needs_local_verify` | Fix has unverified non-e2e tasks. Run locally, then apply or enhance. |
|
||||
| `fix_needs_review` | Fix verification failed/not attempted. Analyze and decide. |
|
||||
| `fix_failed` | Self-healing failed. Fetch heavy data, attempt local fix (gate check first). |
|
||||
| `no_fix` | No fix available. Fetch heavy data, attempt local fix (gate check first) or exit. |
|
||||
| `environment_issue` | Request environment rerun via MCP (gate check first). |
|
||||
| `self_healing_throttled` | Reject old fixes, attempt local fix. |
|
||||
| `no_new_cipe` | CI Attempt never spawned. Auto-fix workflow or exit with guidance. |
|
||||
| `cipe_no_tasks` | CI failed with no tasks. Retry once with empty commit. |
|
||||
|
||||
**Key rules (always apply):**
|
||||
|
||||
- **Git safety**: Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
- **Environment failures** (OOM, command not found, permission denied): bail immediately. These aren't code bugs, so spending local-fix budget on them is wasteful
|
||||
- **Gate check**: Run `ci-state-update.mjs gate` before local fix attempts — if budget exhausted, print message and exit
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0 # Only incremented for agent-initiated cycles (counted against --max-cycles)
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
env_rerun_count = 0
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
agent_triggered = false # Set true after monitor takes an action that triggers new CI Attempt
|
||||
poll_count = 0
|
||||
wait_mode = false
|
||||
prev_status = null
|
||||
prev_cipe_status = null
|
||||
prev_sh_status = null
|
||||
prev_verification_status = null
|
||||
prev_failure_classification = null
|
||||
```
|
||||
|
||||
### Step 2: Polling Loop
|
||||
|
||||
Repeat until done:
|
||||
|
||||
#### 2a. Spawn subagent (FETCH_STATUS)
|
||||
|
||||
Determine select fields based on mode:
|
||||
|
||||
- **Wait mode**: use WAIT_FIELDS (`cipeUrl,commitSha,cipeStatus`)
|
||||
- **Normal mode (first poll or after newCipeDetected)**: use LIGHT_FIELDS
|
||||
|
||||
Call the `ci_information` tool with the determined `select` fields for the current branch. Wait for the result before proceeding.
|
||||
|
||||
#### 2b. Run decision script
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-poll-decide.mjs '<subagent_result_json>' <poll_count> <verbosity> \
|
||||
[--wait-mode] \
|
||||
[--prev-cipe-url <last_cipe_url>] \
|
||||
[--expected-sha <expected_commit_sha>] \
|
||||
[--prev-status <prev_status>] \
|
||||
[--timeout <timeout_seconds>] \
|
||||
[--new-cipe-timeout <new_cipe_timeout_seconds>] \
|
||||
[--env-rerun-count <env_rerun_count>] \
|
||||
[--no-progress-count <no_progress_count>] \
|
||||
[--prev-cipe-status <prev_cipe_status>] \
|
||||
[--prev-sh-status <prev_sh_status>] \
|
||||
[--prev-verification-status <prev_verification_status>] \
|
||||
[--prev-failure-classification <prev_failure_classification>]
|
||||
```
|
||||
|
||||
The script outputs a single JSON line: `{ action, code, message, delay?, noProgressCount, envRerunCount, fields?, newCipeDetected?, verifiableTaskIds? }`
|
||||
|
||||
#### 2c. Process script output
|
||||
|
||||
Parse the JSON output and update tracking state:
|
||||
|
||||
- `no_progress_count = output.noProgressCount`
|
||||
- `env_rerun_count = output.envRerunCount`
|
||||
- `prev_cipe_status = subagent_result.cipeStatus`
|
||||
- `prev_sh_status = subagent_result.selfHealingStatus`
|
||||
- `prev_verification_status = subagent_result.verificationStatus`
|
||||
- `prev_failure_classification = subagent_result.failureClassification`
|
||||
- `prev_status = output.action + ":" + (output.code || subagent_result.cipeStatus)`
|
||||
- `poll_count++`
|
||||
|
||||
Based on `action`:
|
||||
|
||||
- **`action == "poll"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- If `output.newCipeDetected`: clear wait mode, reset `wait_mode = false`
|
||||
- **`action == "wait"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- **`action == "done"`**: Proceed to Step 3 with `output.code`
|
||||
|
||||
### Step 3: Handle Actionable Status
|
||||
|
||||
When decision script returns `action == "done"`:
|
||||
|
||||
1. Run cycle-check (Step 4) **before** handling the code
|
||||
2. Check the returned `code`
|
||||
3. Look up default behavior in the table above
|
||||
4. Check if user instructions override the default
|
||||
5. Execute the appropriate action
|
||||
6. **If action expects new CI Attempt**, update tracking (see Step 3a)
|
||||
7. If action results in looping, go to Step 2
|
||||
|
||||
#### Tool calls for actions
|
||||
|
||||
Several statuses require fetching additional data or calling tools:
|
||||
|
||||
- **fix_apply_ready**: Call `update_self_healing_fix` with action `APPLY`
|
||||
- **fix_needs_local_verify**: Call `ci_information` with HEAVY_FIELDS for fix details before local verification
|
||||
- **fix_needs_review**: Call `ci_information` with HEAVY_FIELDS → get `suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`
|
||||
- **fix_failed / no_fix**: Call `ci_information` with HEAVY_FIELDS → get `taskFailureSummaries` for local fix context
|
||||
- **environment_issue**: Call `update_self_healing_fix` with action `RERUN_ENVIRONMENT_STATE`
|
||||
- **self_healing_throttled**: Call `ci_information` with HEAVY_FIELDS → get `selfHealingSkipMessage`; then call `update_self_healing_fix` for each old fix
|
||||
|
||||
### Step 3a: Track State for New-CI-Attempt Detection
|
||||
|
||||
After actions that should trigger a new CI Attempt, run:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs post-action \
|
||||
--action <type> \
|
||||
--cipe-url <current_cipe_url> \
|
||||
--commit-sha <git_rev_parse_HEAD>
|
||||
```
|
||||
|
||||
Action types: `fix-auto-applying`, `apply-mcp`, `apply-local-push`, `reject-fix-push`, `local-fix-push`, `env-rerun`, `auto-fix-push`, `empty-commit-push`
|
||||
|
||||
The script returns `{ waitMode, pollCount, lastCipeUrl, expectedCommitSha, agentTriggered }`. Update all tracking state from the output, then go to Step 2.
|
||||
|
||||
### Step 4: Cycle Classification and Progress Tracking
|
||||
|
||||
When the decision script returns `action == "done"`, run cycle-check **before** handling the code:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs cycle-check \
|
||||
--code <code> \
|
||||
[--agent-triggered] \
|
||||
--cycle-count <cycle_count> --max-cycles <max_cycles> \
|
||||
--env-rerun-count <env_rerun_count>
|
||||
```
|
||||
|
||||
The script returns `{ cycleCount, agentTriggered, envRerunCount, approachingLimit, message }`. Update tracking state from the output.
|
||||
|
||||
- If `approachingLimit` → ask user whether to continue (with 5 or 10 more cycles) or stop monitoring
|
||||
- If previous cycle was NOT agent-triggered (human pushed), log that human-initiated push was detected
|
||||
|
||||
#### Progress Tracking
|
||||
|
||||
- `no_progress_count`, circuit breaker (5 polls), and backoff reset are handled by ci-poll-decide.mjs (progress = any change in cipeStatus, selfHealingStatus, verificationStatus, or failureClassification)
|
||||
- `env_rerun_count` reset on non-environment status is handled by ci-state-update.mjs cycle-check
|
||||
- On new CI Attempt detected (poll script returns `newCipeDetected`) → reset `local_verify_count = 0`, `env_rerun_count = 0`
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx-cloud apply-locally` fails | Reject fix via MCP (`action: "REJECT"`), then attempt manual patch (Reject + Fix From Scratch Flow) or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| Decision script error | Treat as `error` status, increment `no_progress_count` |
|
||||
| No new CI Attempt detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CI-Attempt failures |
|
||||
| "wait 45 min for new CI Attempt" | Override new-CI-Attempt timeout (default: 10 min) |
|
||||
@@ -0,0 +1,437 @@
|
||||
---
|
||||
name: ci-monitor
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes automatically. Checks for Nx Cloud connection before starting.
|
||||
---
|
||||
|
||||
# CI Monitor Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn the `ci-watcher` subagent to poll CI status and make decisions based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum CIPE cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--subagent-timeout` | 60 | Subagent polling timeout in minutes |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CIPE failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CIPE after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `$ARGUMENTS` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
**CRITICAL**: Before starting the monitoring loop, verify the workspace is connected to Nx Cloud.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
```
|
||||
[ci-monitor] Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
**Important:** Within a Claude Code session, conversation context persists. If you Ctrl+C to interrupt the monitor and re-run `/ci-monitor`, Claude remembers the previous state and may continue from where it left off.
|
||||
|
||||
- **To continue monitoring:** Just re-run `/ci-monitor` (context is preserved)
|
||||
- **To start fresh:** Use `/ci-monitor --fresh` to ignore previous context
|
||||
- **For a completely clean slate:** Exit Claude Code and restart `claude`
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The subagent returns with one of the following statuses. This table defines the **default behavior** for each status. User instructions can override any of these.
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success. Log "CI passed successfully!" |
|
||||
| `fix_auto_applying` | Fix will be auto-applied by self-healing. Do NOT call MCP. Record `last_cipe_url`, spawn new subagent in wait mode to poll for new CIPE. |
|
||||
| `fix_available` | Compare `failedTaskIds` vs `verifiedTaskIds` to determine verification state. See **Fix Available Decision Logic** section below. |
|
||||
| `fix_failed` | Self-healing failed to generate fix. Attempt local fix based on `taskOutputSummary`. If successful → commit, push, loop. If not → exit with failure. |
|
||||
| `environment_issue` | Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`. New CIPE spawns automatically. Loop to poll for new CIPE. |
|
||||
| `no_fix` | CI failed, no fix available (self-healing disabled or not executable). Attempt local fix if possible. Otherwise exit with failure. |
|
||||
| `no_new_cipe` | Expected CIPE never spawned (CI workflow likely failed before Nx tasks). Report to user, attempt common fixes if configured, or exit with guidance. |
|
||||
| `polling_timeout` | Subagent polling timeout reached. Exit with timeout. |
|
||||
| `cipe_canceled` | CIPE was canceled. Exit with canceled status. |
|
||||
| `cipe_timed_out` | CIPE timed out. Exit with timeout status. |
|
||||
| `error` | Increment `no_progress_count`. If >= 3 → exit with circuit breaker. Otherwise wait 60s and loop. |
|
||||
|
||||
### Fix Available Decision Logic
|
||||
|
||||
When subagent returns `fix_available`, main agent compares `failedTaskIds` vs `verifiedTaskIds`:
|
||||
|
||||
#### Step 1: Categorize Tasks
|
||||
|
||||
1. **Verified tasks** = tasks in both `failedTaskIds` AND `verifiedTaskIds`
|
||||
2. **Unverified tasks** = tasks in `failedTaskIds` but NOT in `verifiedTaskIds`
|
||||
3. **E2E tasks** = unverified tasks where target contains "e2e" (task format: `<project>:<target>` or `<project>:<target>:<config>`)
|
||||
4. **Verifiable tasks** = unverified tasks that are NOT e2e
|
||||
|
||||
#### Step 2: Determine Path
|
||||
|
||||
| Condition | Path |
|
||||
| --------------------------------------- | ---------------------------------------- |
|
||||
| No unverified tasks (all verified) | Apply via MCP |
|
||||
| Unverified tasks exist, but ALL are e2e | Apply via MCP (treat as verified enough) |
|
||||
| Verifiable tasks exist | Local verification flow |
|
||||
|
||||
#### Step 3a: Apply via MCP (fully/e2e-only verified)
|
||||
|
||||
- Call `update_self_healing_fix({ shortLink, action: "APPLY" })`
|
||||
- Record `last_cipe_url`, spawn subagent in wait mode
|
||||
|
||||
#### Step 3b: Local Verification Flow
|
||||
|
||||
When verifiable (non-e2e) unverified tasks exist:
|
||||
|
||||
1. **Detect package manager:**
|
||||
- `pnpm-lock.yaml` exists → `pnpm nx`
|
||||
- `yarn.lock` exists → `yarn nx`
|
||||
- Otherwise → `npx nx`
|
||||
|
||||
2. **Run verifiable tasks in parallel:**
|
||||
- Spawn `general` subagents to run each task concurrently
|
||||
- Each subagent runs: `<pm> nx run <taskId>`
|
||||
- Collect pass/fail results from all subagents
|
||||
|
||||
3. **Evaluate results:**
|
||||
|
||||
| Result | Action |
|
||||
| ------------------------- | ---------------------------- |
|
||||
| ALL verifiable tasks pass | Apply via MCP |
|
||||
| ANY verifiable task fails | Apply-locally + enhance flow |
|
||||
|
||||
4. **Apply-locally + enhance flow:**
|
||||
- Run `nx apply-locally <shortLink>`
|
||||
- Enhance the code to fix failing tasks
|
||||
- Run failing tasks again to verify fix
|
||||
- If still failing → increment `local_verify_count`, loop back to enhance
|
||||
- If passing → commit and push, record `expected_commit_sha`, spawn subagent in wait mode
|
||||
|
||||
5. **Track attempts** (wraps step 4):
|
||||
- Increment `local_verify_count` after each enhance cycle
|
||||
- If `local_verify_count >= local_verify_attempts` (default: 3):
|
||||
- Get code in commit-able state
|
||||
- Commit and push with message indicating local verification failed
|
||||
- Report to user:
|
||||
```
|
||||
[ci-monitor] Local verification failed after <N> attempts. Pushed to CI for final validation. Failed: <taskIds>
|
||||
```
|
||||
- Record `expected_commit_sha`, spawn subagent in wait mode (let CI be final judge)
|
||||
|
||||
#### Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
|
||||
### Unverified Fix Flow (No Verification Attempted)
|
||||
|
||||
When `verificationStatus` is `FAILED`, `NOT_EXECUTABLE`, or fix has `couldAutoApplyTasks != true` with no verification:
|
||||
|
||||
- Analyze fix content (`suggestedFix`, `suggestedFixReasoning`, `taskOutputSummary`)
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → use Apply Locally + Enhance Flow above
|
||||
- If fix is wrong → reject via MCP, fix from scratch, commit, push
|
||||
|
||||
### Auto-Apply Eligibility
|
||||
|
||||
The `couldAutoApplyTasks` field indicates whether the fix is eligible for automatic application:
|
||||
|
||||
- **`true`**: Fix is eligible for auto-apply. Subagent keeps polling while verification is in progress. Returns `fix_auto_applying` when verified, or `fix_available` if verification fails.
|
||||
- **`false`** or **`null`**: Fix requires manual action (apply via MCP, apply locally, or reject)
|
||||
|
||||
**Key point**: When subagent returns `fix_auto_applying`, do NOT call MCP to apply - self-healing handles it. Just spawn a new subagent in wait mode.
|
||||
|
||||
### Apply vs Reject vs Apply Locally
|
||||
|
||||
- **Apply via MCP**: Calls `update_self_healing_fix({ shortLink, action: "APPLY" })`. Self-healing agent applies the fix in CI and a new CIPE spawns automatically. No local git operations needed.
|
||||
- **Apply Locally**: Runs `nx apply-locally <shortLink>`. Applies the patch to your local working directory and sets state to `APPLIED_LOCALLY`. Use this when you want to enhance the fix before pushing.
|
||||
- **Reject via MCP**: Calls `update_self_healing_fix({ shortLink, action: "REJECT" })`. Marks fix as rejected. Use only when the fix is completely wrong and you'll fix from scratch.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
When the fix needs enhancement (use `nx apply-locally`, NOT reject):
|
||||
|
||||
1. Apply the patch locally: `nx apply-locally <shortLink>` (this also updates state to `APPLIED_LOCALLY`)
|
||||
2. Make additional changes as needed
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
When the fix is completely wrong:
|
||||
|
||||
1. Call MCP to reject: `update_self_healing_fix({ shortLink, action: "REJECT" })`
|
||||
2. Fix the issue from scratch locally
|
||||
3. Commit and push:
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "fix: resolve <failedTaskIds>"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
4. Loop to poll for new CIPE
|
||||
|
||||
### Environment Issue Handling
|
||||
|
||||
When `failureClassification == 'ENVIRONMENT_STATE'`:
|
||||
|
||||
1. Call MCP to request rerun: `update_self_healing_fix({ shortLink, action: "RERUN_ENVIRONMENT_STATE" })`
|
||||
2. New CIPE spawns automatically (no local git operations needed)
|
||||
3. Loop to poll for new CIPE with `previousCipeUrl` set
|
||||
|
||||
### No-New-CIPE Handling
|
||||
|
||||
When `status == 'no_new_cipe'`:
|
||||
|
||||
This means the expected CIPE was never created - CI likely failed before Nx tasks could run.
|
||||
|
||||
1. **Report to user:**
|
||||
|
||||
```
|
||||
[ci-monitor] No CI attempt for <sha> after 10 min. Check CI provider for pre-Nx failures (install, checkout, auth). Last CI attempt: <previousCipeUrl>
|
||||
```
|
||||
|
||||
2. **If user configured auto-fix attempts** (e.g., `--auto-fix-workflow`):
|
||||
- Detect package manager: check for `pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`
|
||||
- Run install to update lockfile:
|
||||
```bash
|
||||
pnpm install # or npm install / yarn install
|
||||
```
|
||||
- If lockfile changed:
|
||||
```bash
|
||||
git add pnpm-lock.yaml # or appropriate lockfile
|
||||
git commit -m "chore: update lockfile"
|
||||
git push origin $(git branch --show-current)
|
||||
```
|
||||
- Record new commit SHA, loop to poll with `expectedCommitSha`
|
||||
|
||||
3. **Otherwise:** Exit with `no_new_cipe` status, providing guidance for user to investigate
|
||||
|
||||
## Exit Conditions
|
||||
|
||||
Exit the monitoring loop when ANY of these conditions are met:
|
||||
|
||||
| Condition | Exit Type |
|
||||
| ------------------------------------------- | ---------------- |
|
||||
| CI passes (`cipeStatus == 'SUCCEEDED'`) | Success |
|
||||
| Max CIPE cycles reached | Timeout |
|
||||
| Max duration reached | Timeout |
|
||||
| 3 consecutive no-progress iterations | Circuit breaker |
|
||||
| No fix available and local fix not possible | Failure |
|
||||
| No new CIPE and auto-fix not configured | Pre-CIPE failure |
|
||||
| User cancels | Cancelled |
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
last_state = null
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
```
|
||||
|
||||
### Step 2: Spawn Subagent
|
||||
|
||||
Spawn the `ci-watcher` subagent to poll CI status:
|
||||
|
||||
**Fresh start (first spawn, no expected CIPE):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>."
|
||||
)
|
||||
```
|
||||
|
||||
**After action that triggers new CIPE (wait mode):**
|
||||
|
||||
```
|
||||
Task(
|
||||
agent: "ci-watcher",
|
||||
prompt: "Monitor CI for branch '<branch>'.
|
||||
Subagent timeout: <subagent-timeout> minutes.
|
||||
New-CIPE timeout: <new-cipe-timeout> minutes.
|
||||
Verbosity: <verbosity>.
|
||||
|
||||
WAIT MODE: A new CIPE should spawn. Ignore old CIPE until new one appears.
|
||||
Expected commit SHA: <expected_commit_sha>
|
||||
Previous CIPE URL: <last_cipe_url>"
|
||||
)
|
||||
```
|
||||
|
||||
### Step 3: Handle Subagent Response
|
||||
|
||||
When subagent returns:
|
||||
|
||||
1. Check the returned status
|
||||
2. Look up default behavior in the table above
|
||||
3. Check if user instructions override the default
|
||||
4. Execute the appropriate action
|
||||
5. **If action expects new CIPE**, update tracking (see Step 3a)
|
||||
6. If action results in looping, go to Step 2
|
||||
|
||||
### Step 3a: Track State for New-CIPE Detection
|
||||
|
||||
After actions that should trigger a new CIPE, record state before looping:
|
||||
|
||||
| Action | What to Track | Subagent Mode |
|
||||
| ----------------------------- | --------------------------------------------- | ------------- |
|
||||
| Fix auto-applying | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply via MCP | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| Apply locally + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Reject + fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Fix failed + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| No fix + local fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
| Environment rerun | `last_cipe_url = current cipeUrl` | Wait mode |
|
||||
| No-new-CIPE + auto-fix + push | `expected_commit_sha = $(git rev-parse HEAD)` | Wait mode |
|
||||
|
||||
**CRITICAL**: When passing `expectedCommitSha` or `last_cipe_url` to the subagent, it enters **wait mode**:
|
||||
|
||||
- Subagent will **completely ignore** the old/stale CIPE
|
||||
- Subagent will only wait for new CIPE to appear
|
||||
- Subagent will NOT return to main agent with stale CIPE data
|
||||
- Once new CIPE detected, subagent switches to normal polling
|
||||
|
||||
**Why wait mode matters for context preservation**: Stale CIPE data can be very large (task output summaries, suggested fix patches, reasoning). If subagent returns this to main agent, it pollutes main agent's context with useless data since we already processed that CIPE. Wait mode keeps stale data in the subagent, never sending it to main agent.
|
||||
|
||||
### Step 4: Progress Tracking
|
||||
|
||||
After each action:
|
||||
|
||||
- If state changed significantly → reset `no_progress_count = 0`
|
||||
- If state unchanged → `no_progress_count++`
|
||||
- On new CI attempt detected → reset `local_verify_count = 0`
|
||||
|
||||
## Status Reporting
|
||||
|
||||
Based on verbosity level:
|
||||
|
||||
| Level | What to Report |
|
||||
| --------- | -------------------------------------------------------------------------- |
|
||||
| `minimal` | Only final result (success/failure/timeout) |
|
||||
| `medium` | State changes + periodic updates ("Cycle N \| Elapsed: Xm \| Status: ...") |
|
||||
| `verbose` | All of medium + full subagent responses, git outputs, MCP responses |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CIPE failures |
|
||||
| "wait 45 min for new CIPE" | Override new-CIPE timeout (default: 10 min) |
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx apply-locally` fails | Report to user, attempt manual patch or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| No new CIPE detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## Example Session
|
||||
|
||||
### Example 1: Normal Flow with Self-Healing (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-auth'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, verbosity=medium
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: IN_PROGRESS | Self-Healing: NOT_STARTED | Elapsed: 1m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: IN_PROGRESS | Elapsed: 3m
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 5m
|
||||
|
||||
[ci-monitor] Fix available! Verification: COMPLETED
|
||||
[ci-monitor] Applying fix via MCP...
|
||||
[ci-monitor] Fix applied in CI. Waiting for new CI attempt...
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 8m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 2
|
||||
- Total time: 12m 34s
|
||||
- Fixes applied: 1
|
||||
- Result: SUCCESS
|
||||
```
|
||||
|
||||
### Example 2: Pre-CI Failure (medium verbosity)
|
||||
|
||||
```
|
||||
[ci-monitor] Starting CI monitor for branch 'feature/add-products'
|
||||
[ci-monitor] Config: max-cycles=5, timeout=120m, auto-fix-workflow=true
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] CI attempt: FAILED | Self-Healing: COMPLETED | Elapsed: 2m
|
||||
|
||||
[ci-monitor] Applying fix locally, enhancing, and pushing...
|
||||
[ci-monitor] Committed: abc1234
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] Waiting for new CI attempt... (expected SHA: abc1234)
|
||||
[CI Monitor] ⚠️ CI attempt timeout (10 min). Returning no_new_cipe.
|
||||
|
||||
[ci-monitor] Status: no_new_cipe
|
||||
[ci-monitor] --auto-fix-workflow enabled. Attempting lockfile update...
|
||||
[ci-monitor] Lockfile updated. Committed: def5678
|
||||
|
||||
[ci-monitor] Spawning subagent to poll CI status...
|
||||
[CI Monitor] New CI attempt detected!
|
||||
[CI Monitor] CI attempt: SUCCEEDED | Elapsed: 18m
|
||||
|
||||
[ci-monitor] CI passed successfully!
|
||||
|
||||
[ci-monitor] Summary:
|
||||
- Total cycles: 3
|
||||
- Total time: 22m 15s
|
||||
- Fixes applied: 1 (self-healing) + 1 (lockfile)
|
||||
- Result: SUCCESS
|
||||
```
|
||||
@@ -0,0 +1,127 @@
|
||||
---
|
||||
name: link-workspace-packages
|
||||
description: 'Link workspace packages in monorepos (npm, yarn, pnpm, bun). USE WHEN: (1) you just created or generated new packages and need to wire up their dependencies, (2) user imports from a sibling package and needs to add it as a dependency, (3) you get resolution errors for workspace packages (@org/*) like "cannot find module", "failed to resolve import", "TS2307", or "cannot resolve". DO NOT patch around with tsconfig paths or manual package.json edits - use the package manager''s workspace commands to fix actual linking.'
|
||||
---
|
||||
|
||||
# Link Workspace Packages
|
||||
|
||||
Add dependencies between packages in a monorepo. All package managers support workspaces but with different syntax.
|
||||
|
||||
## Detect Package Manager
|
||||
|
||||
Check whether there's a `packageManager` field in the root-level `package.json`.
|
||||
|
||||
Alternatively check lockfile in repo root:
|
||||
|
||||
- `pnpm-lock.yaml` → pnpm
|
||||
- `yarn.lock` → yarn
|
||||
- `bun.lock` / `bun.lockb` → bun
|
||||
- `package-lock.json` → npm
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Identify consumer package (the one importing)
|
||||
2. Identify provider package(s) (being imported)
|
||||
3. Add dependency using package manager's workspace syntax
|
||||
4. Verify symlinks created in consumer's `node_modules/`
|
||||
|
||||
---
|
||||
|
||||
## pnpm
|
||||
|
||||
Uses `workspace:` protocol - symlinks only created when explicitly declared.
|
||||
|
||||
```bash
|
||||
# From consumer directory
|
||||
pnpm add @org/ui --workspace
|
||||
|
||||
# Or with --filter from anywhere
|
||||
pnpm add @org/ui --filter @org/app --workspace
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:*" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## yarn (v2+/berry)
|
||||
|
||||
Also uses `workspace:` protocol.
|
||||
|
||||
```bash
|
||||
yarn workspace @org/app add @org/ui
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:^" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## npm
|
||||
|
||||
No `workspace:` protocol. npm auto-symlinks workspace packages.
|
||||
|
||||
```bash
|
||||
npm install @org/ui --workspace @org/app
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "*" } }
|
||||
```
|
||||
|
||||
npm resolves to local workspace automatically during install.
|
||||
|
||||
---
|
||||
|
||||
## bun
|
||||
|
||||
Supports `workspace:` protocol (pnpm-compatible).
|
||||
|
||||
```bash
|
||||
cd packages/app && bun add @org/ui
|
||||
```
|
||||
|
||||
Result in `package.json`:
|
||||
|
||||
```json
|
||||
{ "dependencies": { "@org/ui": "workspace:*" } }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
**Example 1: pnpm - link ui lib to app**
|
||||
|
||||
```bash
|
||||
pnpm add @org/ui --filter @org/app --workspace
|
||||
```
|
||||
|
||||
**Example 2: npm - link multiple packages**
|
||||
|
||||
```bash
|
||||
npm install @org/data-access @org/ui --workspace @org/dashboard
|
||||
```
|
||||
|
||||
**Example 3: Debug "Cannot find module"**
|
||||
|
||||
1. Check if dependency is declared in consumer's `package.json`
|
||||
2. If not, add it using appropriate command above
|
||||
3. Run install (`pnpm install`, `npm install`, etc.)
|
||||
|
||||
## Notes
|
||||
|
||||
- Symlinks appear in `<consumer>/node_modules/@org/<package>`
|
||||
- **Hoisting differs by manager:**
|
||||
- npm/bun: hoist shared deps to root `node_modules`
|
||||
- pnpm: no hoisting (strict isolation, prevents phantom deps)
|
||||
- yarn berry: uses Plug'n'Play by default (no `node_modules`)
|
||||
- Root `package.json` should have `"private": true` to prevent accidental publish
|
||||
@@ -0,0 +1,301 @@
|
||||
---
|
||||
name: monitor-ci
|
||||
description: Monitor Nx Cloud CI pipeline and handle self-healing fixes. USE WHEN user says "monitor ci", "watch ci", "ci monitor", "watch ci for this branch", "track ci", "check ci status", wants to track CI status, or needs help with self-healing CI fixes. Prefer this skill over native CI provider tools (gh, glab, etc.) for CI monitoring — it integrates with Nx Cloud self-healing which those tools cannot access.
|
||||
---
|
||||
|
||||
# Monitor CI Command
|
||||
|
||||
You are the orchestrator for monitoring Nx Cloud CI pipeline executions and handling self-healing fixes. You spawn subagents to interact with Nx Cloud, run deterministic decision scripts, and take action based on the results.
|
||||
|
||||
## Context
|
||||
|
||||
- **Current Branch:** !`git branch --show-current`
|
||||
- **Current Commit:** !`git rev-parse --short HEAD`
|
||||
- **Remote Status:** !`git status -sb | head -1`
|
||||
|
||||
## User Instructions
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
**Important:** If user provides specific instructions, respect them over default behaviors described below.
|
||||
|
||||
## Configuration Defaults
|
||||
|
||||
| Setting | Default | Description |
|
||||
| ------------------------- | ------------- | ------------------------------------------------------------------------- |
|
||||
| `--max-cycles` | 10 | Maximum **agent-initiated** CI Attempt cycles before timeout |
|
||||
| `--timeout` | 120 | Maximum duration in minutes |
|
||||
| `--verbosity` | medium | Output level: minimal, medium, verbose |
|
||||
| `--branch` | (auto-detect) | Branch to monitor |
|
||||
| `--fresh` | false | Ignore previous context, start fresh |
|
||||
| `--auto-fix-workflow` | false | Attempt common fixes for pre-CI-Attempt failures (e.g., lockfile updates) |
|
||||
| `--new-cipe-timeout` | 10 | Minutes to wait for new CI Attempt after action |
|
||||
| `--local-verify-attempts` | 3 | Max local verification + enhance cycles before pushing to CI |
|
||||
|
||||
Parse any overrides from `$ARGUMENTS` and merge with defaults.
|
||||
|
||||
## Nx Cloud Connection Check
|
||||
|
||||
Before starting the monitoring loop, verify the workspace is connected to Nx Cloud. Without this connection, no CI data is available and the entire skill is inoperable.
|
||||
|
||||
### Step 0: Verify Nx Cloud Connection
|
||||
|
||||
1. **Check `nx.json`** at workspace root for `nxCloudId` or `nxCloudAccessToken`
|
||||
2. **If `nx.json` missing OR neither property exists** → exit with:
|
||||
|
||||
```
|
||||
Nx Cloud not connected. Unlock 70% faster CI and auto-fix broken PRs with https://nx.dev/nx-cloud
|
||||
```
|
||||
|
||||
3. **If connected** → continue to main loop
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
1. **This skill (orchestrator)**: spawns subagents, runs scripts, prints status, does local coding work
|
||||
2. **ci-monitor-subagent (haiku)**: calls one MCP tool (ci_information or update_self_healing_fix), returns structured result, exits
|
||||
3. **ci-poll-decide.mjs (deterministic script)**: takes ci_information result + state, returns action + status message
|
||||
4. **ci-state-update.mjs (deterministic script)**: manages budget gates, post-action state transitions, and cycle classification
|
||||
|
||||
## Status Reporting
|
||||
|
||||
The decision script handles message formatting based on verbosity. When printing messages to the user:
|
||||
|
||||
- Prepend `[monitor-ci]` to every message from the script's `message` field
|
||||
- For your own action messages (e.g. "Applying fix via MCP..."), also prepend `[monitor-ci]`
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
These behaviors cause real problems — racing with self-healing, losing CI progress, or wasting context:
|
||||
|
||||
| Anti-Pattern | Why It's Bad |
|
||||
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| Using CI provider CLIs with `--watch` flags (e.g., `gh pr checks --watch`, `glab ci status -w`) | Bypasses Nx Cloud self-healing entirely |
|
||||
| Writing custom CI polling scripts | Unreliable, pollutes context, no self-healing |
|
||||
| Cancelling CI workflows/pipelines | Destructive, loses CI progress |
|
||||
| Running CI checks on main agent | Wastes main agent context tokens |
|
||||
| Independently analyzing/fixing CI failures while polling | Races with self-healing, causes duplicate fixes and confused state |
|
||||
|
||||
**If this skill fails to activate**, the fallback is:
|
||||
|
||||
1. Use CI provider CLI for a one-time, read-only status check (single call, no watch/polling flags)
|
||||
2. Immediately delegate to this skill with gathered context
|
||||
3. Do not continue polling on main agent — it wastes context tokens and bypasses self-healing
|
||||
|
||||
## Session Context Behavior
|
||||
|
||||
If the user previously ran `/monitor-ci` in this session, you may have prior state (poll counts, last CI Attempt URL, etc.). Resume from that state unless `--fresh` is set, in which case discard it and start from Step 1.
|
||||
|
||||
## MCP Tool Reference
|
||||
|
||||
Three field sets control polling efficiency — use the lightest set that gives you what you need:
|
||||
|
||||
```yaml
|
||||
WAIT_FIELDS: 'cipeUrl,commitSha,cipeStatus'
|
||||
LIGHT_FIELDS: 'cipeStatus,cipeUrl,branch,commitSha,selfHealingStatus,verificationStatus,userAction,failedTaskIds,verifiedTaskIds,selfHealingEnabled,failureClassification,couldAutoApplyTasks,autoApplySkipped,autoApplySkipReason,shortLink,confidence,confidenceReasoning,hints,selfHealingSkippedReason,selfHealingSkipMessage'
|
||||
HEAVY_FIELDS: 'taskOutputSummary,suggestedFix,suggestedFixReasoning,suggestedFixDescription'
|
||||
```
|
||||
|
||||
The `ci_information` tool accepts `branch` (optional, defaults to current git branch), `select` (comma-separated field names), and `pageToken` (0-based pagination for long strings).
|
||||
|
||||
The `update_self_healing_fix` tool accepts a `shortLink` and an action: `APPLY`, `REJECT`, or `RERUN_ENVIRONMENT_STATE`.
|
||||
|
||||
## Default Behaviors by Status
|
||||
|
||||
The decision script returns one of the following statuses. This table defines the **default behavior** for each. User instructions can override any of these.
|
||||
|
||||
**Simple exits** — just report and exit:
|
||||
|
||||
| Status | Default Behavior |
|
||||
| ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `ci_success` | Exit with success |
|
||||
| `cipe_canceled` | Exit, CI was canceled |
|
||||
| `cipe_timed_out` | Exit, CI timed out |
|
||||
| `polling_timeout` | Exit, polling timeout reached |
|
||||
| `circuit_breaker` | Exit, no progress after 13 consecutive polls |
|
||||
| `environment_rerun_cap` | Exit, environment reruns exhausted |
|
||||
| `fix_auto_applying` | Self-healing is handling it — just record `last_cipe_url`, enter wait mode. No MCP call or local git ops needed. |
|
||||
| `error` | Wait 60s and loop |
|
||||
|
||||
**Statuses requiring action** — when handling these in Step 3, read `references/fix-flows.md` for the detailed flow:
|
||||
|
||||
| Status | Summary |
|
||||
| ------------------------ | --------------------------------------------------------------------------------------------- |
|
||||
| `fix_auto_apply_skipped` | Fix verified but auto-apply skipped (e.g., loop prevention). Inform user, offer manual apply. |
|
||||
| `fix_apply_ready` | Fix verified (all tasks or e2e-only). Apply via MCP. |
|
||||
| `fix_needs_local_verify` | Fix has unverified non-e2e tasks. Run locally, then apply or enhance. |
|
||||
| `fix_needs_review` | Fix verification failed/not attempted. Analyze and decide. |
|
||||
| `fix_failed` | Self-healing failed. Fetch heavy data, attempt local fix (gate check first). |
|
||||
| `no_fix` | No fix available. Fetch heavy data, attempt local fix (gate check first) or exit. |
|
||||
| `environment_issue` | Request environment rerun via MCP (gate check first). |
|
||||
| `self_healing_throttled` | Reject old fixes, attempt local fix. |
|
||||
| `no_new_cipe` | CI Attempt never spawned. Auto-fix workflow or exit with guidance. |
|
||||
| `cipe_no_tasks` | CI failed with no tasks. Retry once with empty commit. |
|
||||
|
||||
**Key rules (always apply):**
|
||||
|
||||
- **Git safety**: Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
- **Environment failures** (OOM, command not found, permission denied): bail immediately. These aren't code bugs, so spending local-fix budget on them is wasteful
|
||||
- **Gate check**: Run `ci-state-update.mjs gate` before local fix attempts — if budget exhausted, print message and exit
|
||||
|
||||
## Main Loop
|
||||
|
||||
### Step 1: Initialize Tracking
|
||||
|
||||
```
|
||||
cycle_count = 0 # Only incremented for agent-initiated cycles (counted against --max-cycles)
|
||||
start_time = now()
|
||||
no_progress_count = 0
|
||||
local_verify_count = 0
|
||||
env_rerun_count = 0
|
||||
last_cipe_url = null
|
||||
expected_commit_sha = null
|
||||
agent_triggered = false # Set true after monitor takes an action that triggers new CI Attempt
|
||||
poll_count = 0
|
||||
wait_mode = false
|
||||
prev_status = null
|
||||
prev_cipe_status = null
|
||||
prev_sh_status = null
|
||||
prev_verification_status = null
|
||||
prev_failure_classification = null
|
||||
```
|
||||
|
||||
### Step 2: Polling Loop
|
||||
|
||||
Repeat until done:
|
||||
|
||||
#### 2a. Spawn subagent (FETCH_STATUS)
|
||||
|
||||
Determine select fields based on mode:
|
||||
|
||||
- **Wait mode**: use WAIT_FIELDS (`cipeUrl,commitSha,cipeStatus`)
|
||||
- **Normal mode (first poll or after newCipeDetected)**: use LIGHT_FIELDS
|
||||
|
||||
Call the `ci_information` tool with the determined `select` fields for the current branch. Wait for the result before proceeding.
|
||||
|
||||
#### 2b. Run decision script
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-poll-decide.mjs '<subagent_result_json>' <poll_count> <verbosity> \
|
||||
[--wait-mode] \
|
||||
[--prev-cipe-url <last_cipe_url>] \
|
||||
[--expected-sha <expected_commit_sha>] \
|
||||
[--prev-status <prev_status>] \
|
||||
[--timeout <timeout_seconds>] \
|
||||
[--new-cipe-timeout <new_cipe_timeout_seconds>] \
|
||||
[--env-rerun-count <env_rerun_count>] \
|
||||
[--no-progress-count <no_progress_count>] \
|
||||
[--prev-cipe-status <prev_cipe_status>] \
|
||||
[--prev-sh-status <prev_sh_status>] \
|
||||
[--prev-verification-status <prev_verification_status>] \
|
||||
[--prev-failure-classification <prev_failure_classification>]
|
||||
```
|
||||
|
||||
The script outputs a single JSON line: `{ action, code, message, delay?, noProgressCount, envRerunCount, fields?, newCipeDetected?, verifiableTaskIds? }`
|
||||
|
||||
#### 2c. Process script output
|
||||
|
||||
Parse the JSON output and update tracking state:
|
||||
|
||||
- `no_progress_count = output.noProgressCount`
|
||||
- `env_rerun_count = output.envRerunCount`
|
||||
- `prev_cipe_status = subagent_result.cipeStatus`
|
||||
- `prev_sh_status = subagent_result.selfHealingStatus`
|
||||
- `prev_verification_status = subagent_result.verificationStatus`
|
||||
- `prev_failure_classification = subagent_result.failureClassification`
|
||||
- `prev_status = output.action + ":" + (output.code || subagent_result.cipeStatus)`
|
||||
- `poll_count++`
|
||||
|
||||
Based on `action`:
|
||||
|
||||
- **`action == "poll"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- If `output.newCipeDetected`: clear wait mode, reset `wait_mode = false`
|
||||
- **`action == "wait"`**: Print `output.message`, sleep `output.delay` seconds, go to 2a
|
||||
- **`action == "done"`**: Proceed to Step 3 with `output.code`
|
||||
|
||||
### Step 3: Handle Actionable Status
|
||||
|
||||
When decision script returns `action == "done"`:
|
||||
|
||||
1. Run cycle-check (Step 4) **before** handling the code
|
||||
2. Check the returned `code`
|
||||
3. Look up default behavior in the table above
|
||||
4. Check if user instructions override the default
|
||||
5. Execute the appropriate action
|
||||
6. **If action expects new CI Attempt**, update tracking (see Step 3a)
|
||||
7. If action results in looping, go to Step 2
|
||||
|
||||
#### Tool calls for actions
|
||||
|
||||
Several statuses require fetching additional data or calling tools:
|
||||
|
||||
- **fix_apply_ready**: Call `update_self_healing_fix` with action `APPLY`
|
||||
- **fix_needs_local_verify**: Call `ci_information` with HEAVY_FIELDS for fix details before local verification
|
||||
- **fix_needs_review**: Call `ci_information` with HEAVY_FIELDS → get `suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`
|
||||
- **fix_failed / no_fix**: Call `ci_information` with HEAVY_FIELDS → get `taskFailureSummaries` for local fix context
|
||||
- **environment_issue**: Call `update_self_healing_fix` with action `RERUN_ENVIRONMENT_STATE`
|
||||
- **self_healing_throttled**: Call `ci_information` with HEAVY_FIELDS → get `selfHealingSkipMessage`; then call `update_self_healing_fix` for each old fix
|
||||
|
||||
### Step 3a: Track State for New-CI-Attempt Detection
|
||||
|
||||
After actions that should trigger a new CI Attempt, run:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs post-action \
|
||||
--action <type> \
|
||||
--cipe-url <current_cipe_url> \
|
||||
--commit-sha <git_rev_parse_HEAD>
|
||||
```
|
||||
|
||||
Action types: `fix-auto-applying`, `apply-mcp`, `apply-local-push`, `reject-fix-push`, `local-fix-push`, `env-rerun`, `auto-fix-push`, `empty-commit-push`
|
||||
|
||||
The script returns `{ waitMode, pollCount, lastCipeUrl, expectedCommitSha, agentTriggered }`. Update all tracking state from the output, then go to Step 2.
|
||||
|
||||
### Step 4: Cycle Classification and Progress Tracking
|
||||
|
||||
When the decision script returns `action == "done"`, run cycle-check **before** handling the code:
|
||||
|
||||
```bash
|
||||
node <skill_dir>/scripts/ci-state-update.mjs cycle-check \
|
||||
--code <code> \
|
||||
[--agent-triggered] \
|
||||
--cycle-count <cycle_count> --max-cycles <max_cycles> \
|
||||
--env-rerun-count <env_rerun_count>
|
||||
```
|
||||
|
||||
The script returns `{ cycleCount, agentTriggered, envRerunCount, approachingLimit, message }`. Update tracking state from the output.
|
||||
|
||||
- If `approachingLimit` → ask user whether to continue (with 5 or 10 more cycles) or stop monitoring
|
||||
- If previous cycle was NOT agent-triggered (human pushed), log that human-initiated push was detected
|
||||
|
||||
#### Progress Tracking
|
||||
|
||||
- `no_progress_count`, circuit breaker (5 polls), and backoff reset are handled by ci-poll-decide.mjs (progress = any change in cipeStatus, selfHealingStatus, verificationStatus, or failureClassification)
|
||||
- `env_rerun_count` reset on non-environment status is handled by ci-state-update.mjs cycle-check
|
||||
- On new CI Attempt detected (poll script returns `newCipeDetected`) → reset `local_verify_count = 0`, `env_rerun_count = 0`
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Action |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Git rebase conflict | Report to user, exit |
|
||||
| `nx-cloud apply-locally` fails | Reject fix via MCP (`action: "REJECT"`), then attempt manual patch (Reject + Fix From Scratch Flow) or exit |
|
||||
| MCP tool error | Retry once, if fails report to user |
|
||||
| Subagent spawn failure | Retry once, if fails exit with error |
|
||||
| Decision script error | Treat as `error` status, increment `no_progress_count` |
|
||||
| No new CI Attempt detected | If `--auto-fix-workflow`, try lockfile update; otherwise report to user with guidance |
|
||||
| Lockfile auto-fix fails | Report to user, exit with guidance to check CI logs |
|
||||
|
||||
## User Instruction Examples
|
||||
|
||||
Users can override default behaviors:
|
||||
|
||||
| Instruction | Effect |
|
||||
| ------------------------------------------------ | --------------------------------------------------- |
|
||||
| "never auto-apply" | Always prompt before applying any fix |
|
||||
| "always ask before git push" | Prompt before each push |
|
||||
| "reject any fix for e2e tasks" | Auto-reject if `failedTaskIds` contains e2e |
|
||||
| "apply all fixes regardless of verification" | Skip verification check, apply everything |
|
||||
| "if confidence < 70, reject" | Check confidence field before applying |
|
||||
| "run 'nx affected -t typecheck' before applying" | Add local verification step |
|
||||
| "auto-fix workflow failures" | Attempt lockfile updates on pre-CI-Attempt failures |
|
||||
| "wait 45 min for new CI Attempt" | Override new-CI-Attempt timeout (default: 10 min) |
|
||||
@@ -0,0 +1,108 @@
|
||||
# Detailed Status Handling & Fix Flows
|
||||
|
||||
## Status Handling by Code
|
||||
|
||||
### fix_auto_apply_skipped
|
||||
|
||||
The script returns `autoApplySkipReason` in its output.
|
||||
|
||||
1. Report the skip reason to the user (e.g., "Auto-apply was skipped because the previous CI pipeline execution was triggered by Nx Cloud")
|
||||
2. Offer to apply the fix manually — spawn UPDATE_FIX subagent with `APPLY` if user agrees
|
||||
3. Record `last_cipe_url`, enter wait mode
|
||||
|
||||
### fix_apply_ready
|
||||
|
||||
- Spawn UPDATE_FIX subagent with `APPLY`
|
||||
- Record `last_cipe_url`, enter wait mode
|
||||
|
||||
### fix_needs_local_verify
|
||||
|
||||
The script returns `verifiableTaskIds` in its output.
|
||||
|
||||
1. **Detect package manager:** `pnpm-lock.yaml` → `pnpm nx`, `yarn.lock` → `yarn nx`, otherwise `npx nx`
|
||||
2. **Run verifiable tasks in parallel** — spawn `general` subagents for each task
|
||||
3. **If all pass** → spawn UPDATE_FIX subagent with `APPLY`, enter wait mode
|
||||
4. **If any fail** → Apply Locally + Enhance Flow (see below)
|
||||
|
||||
### fix_needs_review
|
||||
|
||||
Spawn FETCH_HEAVY subagent, then analyze fix content (`suggestedFixDescription`, `suggestedFixSummary`, `taskFailureSummaries`):
|
||||
|
||||
- If fix looks correct → apply via MCP
|
||||
- If fix needs enhancement → Apply Locally + Enhance Flow
|
||||
- If fix is wrong → run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, print message and exit. Otherwise → Reject + Fix From Scratch Flow
|
||||
|
||||
### fix_failed / no_fix
|
||||
|
||||
Spawn FETCH_HEAVY subagent for `taskFailureSummaries`. Run `ci-state-update.mjs gate --gate-type local-fix` — if not allowed, print message and exit. Otherwise attempt local fix (counter already incremented by gate). If successful → commit, push, enter wait mode. If not → exit with failure.
|
||||
|
||||
### environment_issue
|
||||
|
||||
1. Run `ci-state-update.mjs gate --gate-type env-rerun`. If not allowed, print message and exit.
|
||||
2. Spawn UPDATE_FIX subagent with `RERUN_ENVIRONMENT_STATE`
|
||||
3. Enter wait mode with `last_cipe_url` set
|
||||
|
||||
### self_healing_throttled
|
||||
|
||||
Spawn FETCH_HEAVY subagent for `selfHealingSkipMessage`.
|
||||
|
||||
1. **Parse throttle message** for CI Attempt URLs (regex: `/cipes/{id}`)
|
||||
2. **Reject previous fixes** — for each URL: spawn FETCH_THROTTLE_INFO to get `shortLink`, then UPDATE_FIX with `REJECT`
|
||||
3. **Attempt local fix**: Run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed → skip to step 4. Otherwise use `failedTaskIds` and `taskFailureSummaries` for context.
|
||||
4. **Fallback if local fix not possible or budget exhausted**: push empty commit (`git commit --allow-empty -m "ci: rerun after rejecting throttled fixes"`), enter wait mode
|
||||
|
||||
### no_new_cipe
|
||||
|
||||
1. Report to user: no CI attempt found, suggest checking CI provider
|
||||
2. If `--auto-fix-workflow`: detect package manager, run install, commit lockfile if changed, enter wait mode
|
||||
3. Otherwise: exit with guidance
|
||||
|
||||
### cipe_no_tasks
|
||||
|
||||
1. Report to user: CI failed with no tasks recorded
|
||||
2. Retry: `git commit --allow-empty -m "chore: retry ci [monitor-ci]"` + push, enter wait mode
|
||||
3. If retry also returns `cipe_no_tasks`: exit with failure
|
||||
|
||||
## Fix Action Flows
|
||||
|
||||
### Apply via MCP
|
||||
|
||||
Spawn UPDATE_FIX subagent with `APPLY`. New CI Attempt spawns automatically. No local git ops.
|
||||
|
||||
### Apply Locally + Enhance Flow
|
||||
|
||||
1. `nx-cloud apply-locally <shortLink>` (sets state to `APPLIED_LOCALLY`)
|
||||
2. Enhance code to fix failing tasks
|
||||
3. Run failing tasks to verify
|
||||
4. If still failing → run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, commit current state and push (let CI be final judge). Otherwise loop back to enhance.
|
||||
5. If passing → commit and push, enter wait mode
|
||||
|
||||
### Reject + Fix From Scratch Flow
|
||||
|
||||
1. Run `ci-state-update.mjs gate --gate-type local-fix`. If not allowed, print message and exit.
|
||||
2. Spawn UPDATE_FIX subagent with `REJECT`
|
||||
3. Fix from scratch locally
|
||||
4. Commit and push, enter wait mode
|
||||
|
||||
## Environment vs Code Failure Recognition
|
||||
|
||||
When any local fix path runs a task and it fails, assess whether the failure is a **code issue** or an **environment/tooling issue** before running the gate script.
|
||||
|
||||
**Indicators of environment/tooling failures** (non-exhaustive): command not found / binary missing, OOM / heap allocation failures, permission denied, network timeouts / DNS failures, missing system libraries, Docker/container issues, disk space exhaustion.
|
||||
|
||||
When detected → bail immediately without running gate (no budget consumed). Report that the failure is an environment/tooling issue, not a code bug.
|
||||
|
||||
**Code failures** (compilation errors, test assertion failures, lint violations, type errors) are genuine candidates for local fix attempts and proceed normally through the gate.
|
||||
|
||||
## Git Safety
|
||||
|
||||
- Stage specific files by name — `git add -A` or `git add .` risks committing the user's unrelated work-in-progress or secrets
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
```bash
|
||||
git commit -m "fix(<projects>): <brief description>
|
||||
|
||||
Failed tasks: <taskId1>, <taskId2>
|
||||
Local verification: passed|enhanced|failed-pushing-to-ci"
|
||||
```
|
||||
@@ -0,0 +1,428 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* CI Poll Decision Script
|
||||
*
|
||||
* Deterministic decision engine for CI monitoring.
|
||||
* Takes ci_information JSON + state args, outputs a single JSON action line.
|
||||
*
|
||||
* Architecture:
|
||||
* classify() — pure decision tree, returns { action, code, extra? }
|
||||
* buildOutput() — maps classification to full output with messages, delays, counters
|
||||
*
|
||||
* Usage:
|
||||
* node ci-poll-decide.mjs '<ci_info_json>' <poll_count> <verbosity> \
|
||||
* [--wait-mode] [--prev-cipe-url <url>] [--expected-sha <sha>] \
|
||||
* [--prev-status <status>] [--timeout <seconds>] [--new-cipe-timeout <seconds>] \
|
||||
* [--env-rerun-count <n>] [--no-progress-count <n>] \
|
||||
* [--prev-cipe-status <status>] [--prev-sh-status <status>] \
|
||||
* [--prev-verification-status <status>] [--prev-failure-classification <status>]
|
||||
*/
|
||||
|
||||
// --- Arg parsing ---
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
const ciInfoJson = args[0];
|
||||
const pollCount = parseInt(args[1], 10) || 0;
|
||||
const verbosity = args[2] || 'medium';
|
||||
|
||||
function getFlag(name) {
|
||||
return args.includes(name);
|
||||
}
|
||||
|
||||
function getArg(name) {
|
||||
const idx = args.indexOf(name);
|
||||
return idx !== -1 && idx + 1 < args.length ? args[idx + 1] : null;
|
||||
}
|
||||
|
||||
const waitMode = getFlag('--wait-mode');
|
||||
const prevCipeUrl = getArg('--prev-cipe-url');
|
||||
const expectedSha = getArg('--expected-sha');
|
||||
const prevStatus = getArg('--prev-status');
|
||||
const timeoutSeconds = parseInt(getArg('--timeout') || '0', 10);
|
||||
const newCipeTimeoutSeconds = parseInt(getArg('--new-cipe-timeout') || '0', 10);
|
||||
const envRerunCount = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
const inputNoProgressCount = parseInt(getArg('--no-progress-count') || '0', 10);
|
||||
const prevCipeStatus = getArg('--prev-cipe-status');
|
||||
const prevShStatus = getArg('--prev-sh-status');
|
||||
const prevVerificationStatus = getArg('--prev-verification-status');
|
||||
const prevFailureClassification = getArg('--prev-failure-classification');
|
||||
|
||||
// --- Parse CI info ---
|
||||
|
||||
let ci;
|
||||
try {
|
||||
ci = JSON.parse(ciInfoJson);
|
||||
} catch {
|
||||
console.log(
|
||||
JSON.stringify({
|
||||
action: 'done',
|
||||
code: 'error',
|
||||
message: 'Failed to parse ci_information JSON',
|
||||
noProgressCount: inputNoProgressCount + 1,
|
||||
envRerunCount,
|
||||
})
|
||||
);
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
const {
|
||||
cipeStatus,
|
||||
selfHealingStatus,
|
||||
verificationStatus,
|
||||
selfHealingEnabled,
|
||||
selfHealingSkippedReason,
|
||||
failureClassification: rawFailureClassification,
|
||||
failedTaskIds = [],
|
||||
verifiedTaskIds = [],
|
||||
couldAutoApplyTasks,
|
||||
autoApplySkipped,
|
||||
autoApplySkipReason,
|
||||
userAction,
|
||||
cipeUrl,
|
||||
commitSha,
|
||||
} = ci;
|
||||
|
||||
const failureClassification = rawFailureClassification?.toLowerCase() ?? null;
|
||||
|
||||
// --- Helpers ---
|
||||
|
||||
function categorizeTasks() {
|
||||
const verifiedSet = new Set(verifiedTaskIds);
|
||||
const unverified = failedTaskIds.filter((t) => !verifiedSet.has(t));
|
||||
if (unverified.length === 0) return { category: 'all_verified' };
|
||||
|
||||
const e2e = unverified.filter((t) => {
|
||||
const parts = t.split(':');
|
||||
return parts.length >= 2 && parts[1].includes('e2e');
|
||||
});
|
||||
if (e2e.length === unverified.length) return { category: 'e2e_only' };
|
||||
|
||||
const verifiable = unverified.filter((t) => {
|
||||
const parts = t.split(':');
|
||||
return !(parts.length >= 2 && parts[1].includes('e2e'));
|
||||
});
|
||||
return { category: 'needs_local_verify', verifiableTaskIds: verifiable };
|
||||
}
|
||||
|
||||
function backoff(count) {
|
||||
const delays = [60, 90, 120, 180];
|
||||
return delays[Math.min(count, delays.length - 1)];
|
||||
}
|
||||
|
||||
function hasStateChanged() {
|
||||
if (prevCipeStatus && cipeStatus !== prevCipeStatus) return true;
|
||||
if (prevShStatus && selfHealingStatus !== prevShStatus) return true;
|
||||
if (prevVerificationStatus && verificationStatus !== prevVerificationStatus)
|
||||
return true;
|
||||
if (
|
||||
prevFailureClassification &&
|
||||
failureClassification !== prevFailureClassification
|
||||
)
|
||||
return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
function isTimedOut() {
|
||||
if (timeoutSeconds <= 0) return false;
|
||||
const avgDelay = pollCount === 0 ? 0 : backoff(Math.floor(pollCount / 2));
|
||||
return pollCount * avgDelay >= timeoutSeconds;
|
||||
}
|
||||
|
||||
function isWaitTimedOut() {
|
||||
if (newCipeTimeoutSeconds <= 0) return false;
|
||||
return pollCount * 30 >= newCipeTimeoutSeconds;
|
||||
}
|
||||
|
||||
function isNewCipe() {
|
||||
return (
|
||||
(prevCipeUrl && cipeUrl && cipeUrl !== prevCipeUrl) ||
|
||||
(expectedSha && commitSha && commitSha === expectedSha)
|
||||
);
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// classify() — pure decision tree
|
||||
//
|
||||
// Returns: { action: 'poll'|'wait'|'done', code: string, extra? }
|
||||
//
|
||||
// Decision priority (top wins):
|
||||
// WAIT MODE:
|
||||
// 1. new CI Attempt detected → poll (new_cipe_detected)
|
||||
// 2. wait timed out → done (no_new_cipe)
|
||||
// 3. still waiting → wait (waiting_for_cipe)
|
||||
// NORMAL MODE:
|
||||
// 4. polling timeout → done (polling_timeout)
|
||||
// 5. circuit breaker (13 polls) → done (circuit_breaker)
|
||||
// 6. CI succeeded → done (ci_success)
|
||||
// 7. CI canceled → done (cipe_canceled)
|
||||
// 8. CI timed out → done (cipe_timed_out)
|
||||
// 9. CI failed, no tasks recorded → done (cipe_no_tasks)
|
||||
// 10. environment failure → done (environment_rerun_cap | environment_issue)
|
||||
// 11. self-healing throttled → done (self_healing_throttled)
|
||||
// 12. CI in progress / not started → poll (ci_running)
|
||||
// 13. self-healing in progress → poll (sh_running)
|
||||
// 14. flaky task auto-rerun → poll (flaky_rerun)
|
||||
// 15. fix auto-applied → poll (fix_auto_applied)
|
||||
// 16. auto-apply: skipped → done (fix_auto_apply_skipped)
|
||||
// 17. auto-apply: verification pending→ poll (verification_pending)
|
||||
// 18. auto-apply: verified → done (fix_auto_applying)
|
||||
// 19. fix: verification failed/none → done (fix_needs_review)
|
||||
// 20. fix: all/e2e verified → done (fix_apply_ready)
|
||||
// 21. fix: needs local verify → done (fix_needs_local_verify)
|
||||
// 22. self-healing failed → done (fix_failed)
|
||||
// 23. no fix available → done (no_fix)
|
||||
// 24. fallback → poll (fallback)
|
||||
// ============================================================
|
||||
|
||||
function classify() {
|
||||
// --- Wait mode ---
|
||||
if (waitMode) {
|
||||
if (isNewCipe()) return { action: 'poll', code: 'new_cipe_detected' };
|
||||
if (isWaitTimedOut()) return { action: 'done', code: 'no_new_cipe' };
|
||||
return { action: 'wait', code: 'waiting_for_cipe' };
|
||||
}
|
||||
|
||||
// --- Guards ---
|
||||
if (isTimedOut()) return { action: 'done', code: 'polling_timeout' };
|
||||
if (noProgressCount >= 13) return { action: 'done', code: 'circuit_breaker' };
|
||||
|
||||
// --- Terminal CI states ---
|
||||
if (cipeStatus === 'SUCCEEDED') return { action: 'done', code: 'ci_success' };
|
||||
if (cipeStatus === 'CANCELED')
|
||||
return { action: 'done', code: 'cipe_canceled' };
|
||||
if (cipeStatus === 'TIMED_OUT')
|
||||
return { action: 'done', code: 'cipe_timed_out' };
|
||||
|
||||
// --- CI failed, no tasks ---
|
||||
if (
|
||||
cipeStatus === 'FAILED' &&
|
||||
failedTaskIds.length === 0 &&
|
||||
selfHealingStatus == null
|
||||
)
|
||||
return { action: 'done', code: 'cipe_no_tasks' };
|
||||
|
||||
// --- Environment failure ---
|
||||
if (failureClassification === 'environment_state') {
|
||||
if (envRerunCount >= 2)
|
||||
return { action: 'done', code: 'environment_rerun_cap' };
|
||||
return { action: 'done', code: 'environment_issue' };
|
||||
}
|
||||
|
||||
// --- Throttled ---
|
||||
if (selfHealingSkippedReason === 'THROTTLED')
|
||||
return { action: 'done', code: 'self_healing_throttled' };
|
||||
|
||||
// --- Still running: CI ---
|
||||
if (cipeStatus === 'IN_PROGRESS' || cipeStatus === 'NOT_STARTED')
|
||||
return { action: 'poll', code: 'ci_running' };
|
||||
|
||||
// --- Still running: self-healing ---
|
||||
if (
|
||||
(selfHealingStatus === 'IN_PROGRESS' ||
|
||||
selfHealingStatus === 'NOT_STARTED') &&
|
||||
!selfHealingSkippedReason
|
||||
)
|
||||
return { action: 'poll', code: 'sh_running' };
|
||||
|
||||
// --- Still running: flaky rerun ---
|
||||
if (failureClassification === 'flaky_task')
|
||||
return { action: 'poll', code: 'flaky_rerun' };
|
||||
|
||||
// --- Fix auto-applied, waiting for new CI Attempt ---
|
||||
if (userAction === 'APPLIED_AUTOMATICALLY')
|
||||
return { action: 'poll', code: 'fix_auto_applied' };
|
||||
|
||||
// --- Auto-apply path (couldAutoApplyTasks) ---
|
||||
if (couldAutoApplyTasks === true) {
|
||||
if (autoApplySkipped === true)
|
||||
return {
|
||||
action: 'done',
|
||||
code: 'fix_auto_apply_skipped',
|
||||
extra: { autoApplySkipReason },
|
||||
};
|
||||
if (
|
||||
verificationStatus === 'NOT_STARTED' ||
|
||||
verificationStatus === 'IN_PROGRESS'
|
||||
)
|
||||
return { action: 'poll', code: 'verification_pending' };
|
||||
if (verificationStatus === 'COMPLETED')
|
||||
return { action: 'done', code: 'fix_auto_applying' };
|
||||
// verification FAILED or NOT_EXECUTABLE → falls through to fix_needs_review
|
||||
}
|
||||
|
||||
// --- Fix available ---
|
||||
if (selfHealingStatus === 'COMPLETED') {
|
||||
if (
|
||||
verificationStatus === 'FAILED' ||
|
||||
verificationStatus === 'NOT_EXECUTABLE' ||
|
||||
(couldAutoApplyTasks !== true && !verificationStatus)
|
||||
)
|
||||
return { action: 'done', code: 'fix_needs_review' };
|
||||
|
||||
const tasks = categorizeTasks();
|
||||
if (tasks.category === 'all_verified' || tasks.category === 'e2e_only')
|
||||
return { action: 'done', code: 'fix_apply_ready' };
|
||||
return {
|
||||
action: 'done',
|
||||
code: 'fix_needs_local_verify',
|
||||
extra: { verifiableTaskIds: tasks.verifiableTaskIds },
|
||||
};
|
||||
}
|
||||
|
||||
// --- Fix failed ---
|
||||
if (selfHealingStatus === 'FAILED')
|
||||
return { action: 'done', code: 'fix_failed' };
|
||||
|
||||
// --- No fix available ---
|
||||
if (
|
||||
cipeStatus === 'FAILED' &&
|
||||
(selfHealingEnabled === false || selfHealingStatus === 'NOT_EXECUTABLE')
|
||||
)
|
||||
return { action: 'done', code: 'no_fix' };
|
||||
|
||||
// --- Fallback ---
|
||||
return { action: 'poll', code: 'fallback' };
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// buildOutput() — maps classification to full JSON output
|
||||
// ============================================================
|
||||
|
||||
// Message templates keyed by status or key
|
||||
const messages = {
|
||||
// wait mode
|
||||
new_cipe_detected: () =>
|
||||
`New CI Attempt detected! CI: ${cipeStatus || 'N/A'}`,
|
||||
no_new_cipe: () =>
|
||||
'New CI Attempt timeout exceeded. No new CI Attempt detected.',
|
||||
waiting_for_cipe: () => 'Waiting for new CI Attempt...',
|
||||
|
||||
// guards
|
||||
polling_timeout: () => 'Polling timeout exceeded.',
|
||||
circuit_breaker: () => 'No progress after 13 consecutive polls. Stopping.',
|
||||
|
||||
// terminal
|
||||
ci_success: () => 'CI passed successfully!',
|
||||
cipe_canceled: () => 'CI Attempt was canceled.',
|
||||
cipe_timed_out: () => 'CI Attempt timed out.',
|
||||
cipe_no_tasks: () => 'CI failed but no Nx tasks were recorded.',
|
||||
|
||||
// environment
|
||||
environment_rerun_cap: () => 'Environment rerun cap (2) exceeded. Bailing.',
|
||||
environment_issue: () => 'CI: FAILED | Classification: ENVIRONMENT_STATE',
|
||||
|
||||
// throttled
|
||||
self_healing_throttled: () =>
|
||||
'Self-healing throttled \u2014 too many unapplied fixes.',
|
||||
|
||||
// polling
|
||||
ci_running: () => `CI: ${cipeStatus}`,
|
||||
sh_running: () => `CI: ${cipeStatus} | Self-healing: ${selfHealingStatus}`,
|
||||
flaky_rerun: () =>
|
||||
'CI: FAILED | Classification: FLAKY_TASK (auto-rerun in progress)',
|
||||
fix_auto_applied: () =>
|
||||
'CI: FAILED | Fix auto-applied, new CI Attempt spawning',
|
||||
verification_pending: () =>
|
||||
`CI: FAILED | Self-healing: COMPLETED | Verification: ${verificationStatus}`,
|
||||
|
||||
// actionable
|
||||
fix_auto_applying: () => 'Fix verified! Auto-applying...',
|
||||
fix_auto_apply_skipped: (extra) =>
|
||||
`Fix verified but auto-apply was skipped. ${
|
||||
extra?.autoApplySkipReason
|
||||
? `Reason: ${extra.autoApplySkipReason}`
|
||||
: 'Offer to apply manually.'
|
||||
}`,
|
||||
fix_needs_review: () =>
|
||||
`Fix available but needs review. Verification: ${
|
||||
verificationStatus || 'N/A'
|
||||
}`,
|
||||
fix_apply_ready: () => 'Fix available and verified. Ready to apply.',
|
||||
fix_needs_local_verify: (extra) =>
|
||||
`Fix available. ${extra.verifiableTaskIds.length} task(s) need local verification.`,
|
||||
fix_failed: () => 'Self-healing failed to generate a fix.',
|
||||
no_fix: () => 'CI failed, no fix available.',
|
||||
|
||||
// fallback
|
||||
fallback: () =>
|
||||
`CI: ${cipeStatus || 'N/A'} | Self-healing: ${
|
||||
selfHealingStatus || 'N/A'
|
||||
} | Verification: ${verificationStatus || 'N/A'}`,
|
||||
};
|
||||
|
||||
// Codes where noProgressCount resets to 0 (genuine progress occurred)
|
||||
const resetProgressCodes = new Set([
|
||||
'ci_success',
|
||||
'fix_auto_applying',
|
||||
'fix_auto_apply_skipped',
|
||||
'fix_needs_review',
|
||||
'fix_apply_ready',
|
||||
'fix_needs_local_verify',
|
||||
]);
|
||||
|
||||
function formatMessage(msg) {
|
||||
if (verbosity === 'minimal') {
|
||||
const currentStatus = `${cipeStatus}|${selfHealingStatus}|${verificationStatus}`;
|
||||
if (currentStatus === (prevStatus || '')) return null;
|
||||
return msg;
|
||||
}
|
||||
if (verbosity === 'verbose') {
|
||||
return [
|
||||
`Poll #${pollCount + 1} | CI: ${cipeStatus || 'N/A'} | Self-healing: ${
|
||||
selfHealingStatus || 'N/A'
|
||||
} | Verification: ${verificationStatus || 'N/A'}`,
|
||||
msg,
|
||||
].join('\n');
|
||||
}
|
||||
return `Poll #${pollCount + 1} | ${msg}`;
|
||||
}
|
||||
|
||||
function buildOutput(decision) {
|
||||
const { action, code, extra } = decision;
|
||||
|
||||
// noProgressCount is already computed before classify() was called.
|
||||
// Here we only handle the reset for "genuine progress" done-codes.
|
||||
|
||||
const msgFn = messages[code];
|
||||
const rawMsg = msgFn ? msgFn(extra) : `Unknown: ${code}`;
|
||||
const message = formatMessage(rawMsg);
|
||||
|
||||
const result = {
|
||||
action,
|
||||
code,
|
||||
message,
|
||||
noProgressCount: resetProgressCodes.has(code) ? 0 : noProgressCount,
|
||||
envRerunCount,
|
||||
};
|
||||
|
||||
// Add delay
|
||||
if (action === 'wait') {
|
||||
result.delay = 30;
|
||||
} else if (action === 'poll') {
|
||||
result.delay = code === 'new_cipe_detected' ? 60 : backoff(noProgressCount);
|
||||
result.fields = 'light';
|
||||
}
|
||||
|
||||
// Add extras
|
||||
if (code === 'new_cipe_detected') result.newCipeDetected = true;
|
||||
if (extra?.verifiableTaskIds)
|
||||
result.verifiableTaskIds = extra.verifiableTaskIds;
|
||||
if (extra?.autoApplySkipReason)
|
||||
result.autoApplySkipReason = extra.autoApplySkipReason;
|
||||
|
||||
console.log(JSON.stringify(result));
|
||||
}
|
||||
|
||||
// --- Run ---
|
||||
|
||||
// Compute noProgressCount from input. Single assignment, no mutation.
|
||||
// Wait mode: reset on new cipe, otherwise unchanged (wait doesn't count as no-progress).
|
||||
// Normal mode: reset on any state change, otherwise increment.
|
||||
const noProgressCount = (() => {
|
||||
if (waitMode) return isNewCipe() ? 0 : inputNoProgressCount;
|
||||
if (isNewCipe() || hasStateChanged()) return 0;
|
||||
return inputNoProgressCount + 1;
|
||||
})();
|
||||
|
||||
buildOutput(classify());
|
||||
@@ -0,0 +1,160 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* CI State Update Script
|
||||
*
|
||||
* Deterministic state management for CI monitor actions.
|
||||
* Three commands: gate, post-action, cycle-check.
|
||||
*
|
||||
* Usage:
|
||||
* node ci-state-update.mjs gate --gate-type <local-fix|env-rerun> [counter args]
|
||||
* node ci-state-update.mjs post-action --action <type> [--cipe-url <url>] [--commit-sha <sha>]
|
||||
* node ci-state-update.mjs cycle-check --code <code> [--agent-triggered] [counter args]
|
||||
*/
|
||||
|
||||
// --- Arg parsing ---
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
const command = args[0];
|
||||
|
||||
function getFlag(name) {
|
||||
return args.includes(name);
|
||||
}
|
||||
|
||||
function getArg(name) {
|
||||
const idx = args.indexOf(name);
|
||||
return idx !== -1 && idx + 1 < args.length ? args[idx + 1] : null;
|
||||
}
|
||||
|
||||
function output(result) {
|
||||
console.log(JSON.stringify(result));
|
||||
}
|
||||
|
||||
// --- gate ---
|
||||
// Check if an action is allowed and return incremented counter.
|
||||
// Called before any local fix attempt or environment rerun.
|
||||
|
||||
function gate() {
|
||||
const gateType = getArg('--gate-type');
|
||||
|
||||
if (gateType === 'local-fix') {
|
||||
const count = parseInt(getArg('--local-verify-count') || '0', 10);
|
||||
const max = parseInt(getArg('--local-verify-attempts') || '3', 10);
|
||||
if (count >= max) {
|
||||
return output({
|
||||
allowed: false,
|
||||
localVerifyCount: count,
|
||||
message: `Local fix budget exhausted (${count}/${max} attempts)`,
|
||||
});
|
||||
}
|
||||
return output({
|
||||
allowed: true,
|
||||
localVerifyCount: count + 1,
|
||||
message: null,
|
||||
});
|
||||
}
|
||||
|
||||
if (gateType === 'env-rerun') {
|
||||
const count = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
if (count >= 2) {
|
||||
return output({
|
||||
allowed: false,
|
||||
envRerunCount: count,
|
||||
message: `Environment issue persists after ${count} reruns. Manual investigation needed.`,
|
||||
});
|
||||
}
|
||||
return output({
|
||||
allowed: true,
|
||||
envRerunCount: count + 1,
|
||||
message: null,
|
||||
});
|
||||
}
|
||||
|
||||
output({ allowed: false, message: `Unknown gate type: ${gateType}` });
|
||||
}
|
||||
|
||||
// --- post-action ---
|
||||
// Compute next state after an action is taken.
|
||||
// Returns wait mode params and whether the action was agent-triggered.
|
||||
|
||||
function postAction() {
|
||||
const action = getArg('--action');
|
||||
const cipeUrl = getArg('--cipe-url');
|
||||
const commitSha = getArg('--commit-sha');
|
||||
|
||||
// MCP-triggered or auto-applied: track by cipeUrl
|
||||
const cipeUrlActions = ['fix-auto-applying', 'apply-mcp', 'env-rerun'];
|
||||
// Local push: track by commitSha
|
||||
const commitShaActions = [
|
||||
'apply-local-push',
|
||||
'reject-fix-push',
|
||||
'local-fix-push',
|
||||
'auto-fix-push',
|
||||
'empty-commit-push',
|
||||
];
|
||||
|
||||
const trackByCipeUrl = cipeUrlActions.includes(action);
|
||||
const trackByCommitSha = commitShaActions.includes(action);
|
||||
|
||||
if (!trackByCipeUrl && !trackByCommitSha) {
|
||||
return output({ error: `Unknown action: ${action}` });
|
||||
}
|
||||
|
||||
// fix-auto-applying: self-healing did it, NOT the monitor
|
||||
const agentTriggered = action !== 'fix-auto-applying';
|
||||
|
||||
output({
|
||||
waitMode: true,
|
||||
pollCount: 0,
|
||||
lastCipeUrl: trackByCipeUrl ? cipeUrl : null,
|
||||
expectedCommitSha: trackByCommitSha ? commitSha : null,
|
||||
agentTriggered,
|
||||
});
|
||||
}
|
||||
|
||||
// --- cycle-check ---
|
||||
// Cycle classification + counter resets when a new "done" code is received.
|
||||
// Called at the start of handling each actionable code.
|
||||
|
||||
function cycleCheck() {
|
||||
const status = getArg('--code');
|
||||
const wasAgentTriggered = getFlag('--agent-triggered');
|
||||
let cycleCount = parseInt(getArg('--cycle-count') || '0', 10);
|
||||
const maxCycles = parseInt(getArg('--max-cycles') || '10', 10);
|
||||
let envRerunCount = parseInt(getArg('--env-rerun-count') || '0', 10);
|
||||
|
||||
// Cycle classification: if previous cycle was agent-triggered, count it
|
||||
if (wasAgentTriggered) cycleCount++;
|
||||
|
||||
// Reset env_rerun_count on non-environment status
|
||||
if (status !== 'environment_issue') envRerunCount = 0;
|
||||
|
||||
// Approaching limit gate
|
||||
const approachingLimit = cycleCount >= maxCycles - 2;
|
||||
|
||||
output({
|
||||
cycleCount,
|
||||
agentTriggered: false,
|
||||
envRerunCount,
|
||||
approachingLimit,
|
||||
message: approachingLimit
|
||||
? `Approaching cycle limit (${cycleCount}/${maxCycles})`
|
||||
: null,
|
||||
});
|
||||
}
|
||||
|
||||
// --- Dispatch ---
|
||||
|
||||
switch (command) {
|
||||
case 'gate':
|
||||
gate();
|
||||
break;
|
||||
case 'post-action':
|
||||
postAction();
|
||||
break;
|
||||
case 'cycle-check':
|
||||
cycleCheck();
|
||||
break;
|
||||
default:
|
||||
output({ error: `Unknown command: ${command}` });
|
||||
}
|
||||
@@ -0,0 +1,166 @@
|
||||
---
|
||||
name: nx-generate
|
||||
description: Generate code using nx generators. INVOKE IMMEDIATELY when user mentions scaffolding, setup, structure, creating apps/libs, or setting up project structure. Trigger words - scaffold, setup, create a new app, create a new lib, project structure, generate, add a new project. ALWAYS use this BEFORE calling nx_docs or exploring - this skill handles discovery internally.
|
||||
---
|
||||
|
||||
# Run Nx Generator
|
||||
|
||||
Nx generators are powerful tools that scaffold projects, make automated code migrations or automate repetitive tasks in a monorepo. They ensure consistency across the codebase and reduce boilerplate work.
|
||||
|
||||
This skill applies when the user wants to:
|
||||
|
||||
- Create new projects like libraries or applications
|
||||
- Scaffold features or boilerplate code
|
||||
- Run workspace-specific or custom generators
|
||||
- Do anything else that an nx generator exists for
|
||||
|
||||
## Key Principles
|
||||
|
||||
1. **Always use `--no-interactive`** - Prevents prompts that would hang execution
|
||||
2. **Read the generator source code** - The schema alone is not enough; understand what the generator actually does
|
||||
3. **Match existing repo patterns** - Study similar artifacts in the repo and follow their conventions
|
||||
4. **Verify with lint/test/build/typecheck etc.** - Generated code must pass verification. The listed targets are just an example, use what's appropriate for this workspace.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Discover Available Generators
|
||||
|
||||
Use the Nx CLI to discover available generators:
|
||||
|
||||
- List all generators for a plugin: `npx nx list @nx/react`
|
||||
- View available plugins: `npx nx list`
|
||||
|
||||
This includes plugin generators (e.g., `@nx/react:library`) and local workspace generators.
|
||||
|
||||
### 2. Match Generator to User Request
|
||||
|
||||
Identify which generator(s) could fulfill the user's needs. Consider what artifact type they want, which framework is relevant, and any specific generator names mentioned.
|
||||
|
||||
**IMPORTANT**: When both a local workspace generator and an external plugin generator could satisfy the request, **always prefer the local workspace generator**. Local generators are customized for the specific repo's patterns.
|
||||
|
||||
If no suitable generator exists, you can stop using this skill. However, the burden of proof is high—carefully consider all available generators before deciding none apply.
|
||||
|
||||
### 3. Get Generator Options
|
||||
|
||||
Use the `--help` flag to understand available options:
|
||||
|
||||
```bash
|
||||
npx nx g @nx/react:library --help
|
||||
```
|
||||
|
||||
Pay attention to required options, defaults that might need overriding, and options relevant to the user's request.
|
||||
|
||||
### Library Buildability
|
||||
|
||||
**Default to non-buildable libraries** unless there's a specific reason for buildable.
|
||||
|
||||
| Type | When to use | Generator flags |
|
||||
| --------------------------- | ----------------------------------------------------------------- | ----------------------------------- |
|
||||
| **Non-buildable** (default) | Internal monorepo libs consumed by apps | No `--bundler` flag |
|
||||
| **Buildable** | Publishing to npm, cross-repo sharing, stable libs for cache hits | `--bundler=vite` or `--bundler=swc` |
|
||||
|
||||
Non-buildable libs:
|
||||
|
||||
- Export `.ts`/`.tsx` source directly
|
||||
- Consumer's bundler compiles them
|
||||
- Faster dev experience, less config
|
||||
|
||||
Buildable libs:
|
||||
|
||||
- Have their own build target
|
||||
- Useful for stable libs that rarely change (cache hits)
|
||||
- Required for npm publishing
|
||||
|
||||
**If unclear, ask the user:** "Should this library be buildable (own build step, better caching) or non-buildable (source consumed directly, simpler setup)?"
|
||||
|
||||
### 4. Read Generator Source Code
|
||||
|
||||
**This step is critical.** The schema alone does not tell you everything. Reading the source code helps you:
|
||||
|
||||
- Know exactly what files will be created/modified and where
|
||||
- Understand side effects (updating configs, installing deps, etc.)
|
||||
- Identify behaviors and options not obvious from the schema
|
||||
- Understand how options interact with each other
|
||||
|
||||
To find generator source code:
|
||||
|
||||
- For plugin generators: Use `node -e "console.log(require.resolve('@nx/<plugin>/generators.json'));"` to find the generators.json, then locate the source from there
|
||||
- If that fails, read directly from `node_modules/<plugin>/generators.json`
|
||||
- For local generators: Typically in `tools/generators/` or a local plugin directory. Search the repo for the generator name.
|
||||
|
||||
After reading the source, reconsider: Is this the right generator? If not, go back to step 2.
|
||||
|
||||
> **⚠️ `--directory` flag behavior can be misleading.**
|
||||
> It should specify the full path of the generated library or component, not the parent path that it will be generated in.
|
||||
>
|
||||
> ```bash
|
||||
> # ✅ Correct - directory is the full path for the library
|
||||
> nx g @nx/react:library --directory=libs/my-lib
|
||||
> # generates libs/my-lib/package.json and more
|
||||
>
|
||||
> # ❌ Wrong - this will create files at libs and libs/src/...
|
||||
> nx g @nx/react:library --name=my-lib --directory=libs
|
||||
> # generates libs/package.json and more
|
||||
> ```
|
||||
|
||||
### 5. Examine Existing Patterns
|
||||
|
||||
Before generating, examine the target area of the codebase:
|
||||
|
||||
- Look at similar existing artifacts (other libraries, applications, etc.)
|
||||
- Identify naming conventions, file structures, and configuration patterns
|
||||
- Note which test runners, build tools, and linters are used
|
||||
- Configure the generator to match these patterns
|
||||
|
||||
### 6. Dry-Run to Verify File Placement
|
||||
|
||||
**Always run with `--dry-run` first** to verify files will be created in the correct location:
|
||||
|
||||
```bash
|
||||
npx nx g @nx/react:library --name=my-lib --dry-run --no-interactive
|
||||
```
|
||||
|
||||
Review the output carefully. If files would be created in the wrong location, adjust your options based on what you learned from the generator source code.
|
||||
|
||||
Note: Some generators don't support dry-run (e.g., if they install npm packages). If dry-run fails for this reason, proceed to running the generator for real.
|
||||
|
||||
### 7. Run the Generator
|
||||
|
||||
Execute the generator:
|
||||
|
||||
```bash
|
||||
nx generate <generator-name> <options> --no-interactive
|
||||
```
|
||||
|
||||
> **Tip:** New packages often need workspace dependencies wired up (e.g., importing shared types, being consumed by apps). The `link-workspace-packages` skill can help add these correctly.
|
||||
|
||||
### 8. Modify Generated Code (If Needed)
|
||||
|
||||
Generators provide a starting point. Modify the output as needed to:
|
||||
|
||||
- Add or modify functionality as requested
|
||||
- Adjust imports, exports, or configurations
|
||||
- Integrate with existing code patterns
|
||||
|
||||
**Important:** If you replace or delete generated test files (e.g., `*.spec.ts`), either write meaningful replacement tests or remove the `test` target from the project configuration. Empty test suites will cause `nx test` to fail.
|
||||
|
||||
### 9. Format and Verify
|
||||
|
||||
Format all generated/modified files:
|
||||
|
||||
```bash
|
||||
nx format --fix
|
||||
```
|
||||
|
||||
This example is for built-in nx formatting with prettier. There might be other formatting tools for this workspace, use these when appropriate.
|
||||
|
||||
Then verify the generated code works. Keep in mind that the changes you make with a generator or subsequent modifications might impact various projects so it's usually not enough to only run targets for the artifact you just created.
|
||||
|
||||
```bash
|
||||
# these targets are just an example!
|
||||
nx run-many -t build,lint,test,typecheck
|
||||
```
|
||||
|
||||
These targets are common examples used across many workspaces. You should do research into other targets available for this workspace and its projects. CI configuration is usually a good guide for what the critical targets are that have to pass.
|
||||
|
||||
If verification fails with manageable issues (a few lint errors, minor type issues), fix them. If issues are extensive, attempt obvious fixes first, then escalate to the user with details about what was generated, what's failing, and what you've attempted.
|
||||
@@ -0,0 +1,238 @@
|
||||
---
|
||||
name: nx-import
|
||||
description: Import, merge, or combine repositories into an Nx workspace using nx import. USE WHEN the user asks to adopt Nx across repos, move projects into a monorepo, or bring code/history from another repository.
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
- `nx import` brings code from a source repository or folder into the current workspace, preserving commit history.
|
||||
- After nx `22.6.0`, `nx import` responds with .ndjson outputs and follow-up questions. For earlier versions, always run with `--no-interactive` and specify all flags directly.
|
||||
- Run `nx import --help` for available options.
|
||||
- Make sure the destination directory is empty before importing.
|
||||
EXAMPLE: target has `libs/utils` and `libs/models`; source has `libs/ui` and `libs/data-access` — you cannot import `libs/` into `libs/` directly. Import each source library individually.
|
||||
|
||||
Primary docs:
|
||||
|
||||
- https://nx.dev/docs/guides/adopting-nx/import-project
|
||||
- https://nx.dev/docs/guides/adopting-nx/preserving-git-histories
|
||||
|
||||
Read the nx docs if you have the tools for it.
|
||||
|
||||
## Import Strategy
|
||||
|
||||
**Subdirectory-at-a-time** (`nx import <source> apps --source=apps`):
|
||||
|
||||
- **Recommended for monorepo sources** — files land at top level, no redundant config
|
||||
- Caveats: multiple import commands (separate merge commits each); dest must not have conflicting directories; root configs (deps, plugins, targetDefaults) not imported
|
||||
- **Directory conflicts**: Import into alternate-named dir (e.g. `imported-apps/`), then rename
|
||||
|
||||
**Whole repo** (`nx import <source> imported --source=.`):
|
||||
|
||||
- **Only for non-monorepo sources** (single-project repos)
|
||||
- For monorepos, creates messy nested config (`imported/nx.json`, `imported/tsconfig.base.json`, etc.)
|
||||
- If you must: keep imported `tsconfig.base.json` (projects extend it), prefix workspace globs and executor paths
|
||||
|
||||
### Directory Conventions
|
||||
|
||||
- **Always prefer the destination's existing conventions.** Source uses `libs/`but dest uses `packages/`? Import into `packages/` (`nx import <source> packages/foo --source=libs/foo`).
|
||||
- If dest has no convention (empty workspace), ask the user.
|
||||
|
||||
### Application vs Library Detection
|
||||
|
||||
Before importing, identify whether the source is an **application** or a **library**:
|
||||
|
||||
- **Applications**: Deployable end products. Common indicators:
|
||||
- _Frontend_: `next.config.*`, `vite.config.*` with a build entry point, framework-specific app scaffolding (CRA, Angular CLI app, etc.)
|
||||
- _Backend (Node.js)_: Express/Fastify/NestJS server entrypoint, no `"exports"` field in `package.json`
|
||||
- _JVM_: Maven `pom.xml` with `<packaging>jar</packaging>` or `<packaging>war</packaging>` and a `main` class; Gradle `application` plugin or `mainClass` setting
|
||||
- _.NET_: `.csproj`/`.fsproj` with `<OutputType>Exe</OutputType>` or `<OutputType>WinExe</OutputType>`
|
||||
- _General_: Dockerfile, a runnable entrypoint, no public API surface intended for import by other projects
|
||||
- **Libraries**: Reusable packages consumed by other projects. Common indicators: `"main"`/`"exports"` in `package.json`, Maven/Gradle packaging as a library jar, .NET `<OutputType>Library</OutputType>`, named exports intended for import by other packages.
|
||||
|
||||
**Destination directory rules**:
|
||||
|
||||
- Applications → `apps/<name>`. Check workspace globs (e.g. `pnpm-workspace.yaml`, `workspaces` in root `package.json`) for an existing `apps/*` entry.
|
||||
- If `apps/*` is **not** present, add it before importing: update the workspace glob config and commit (or stage) the change.
|
||||
- Example: `nx import <source> apps/my-app --source=packages/my-app`
|
||||
- Libraries → follow the dest's existing convention (`packages/`, `libs/`, etc.).
|
||||
|
||||
## Common Issues
|
||||
|
||||
### pnpm Workspace Globs (Critical)
|
||||
|
||||
`nx import` adds the imported directory itself (e.g. `apps`) to `pnpm-workspace.yaml`, **NOT** glob patterns for packages within it. Cross-package imports will fail with `Cannot find module`.
|
||||
|
||||
**Fix**: Replace with proper globs from the source config (e.g. `apps/*`, `libs/shared/*`), then `pnpm install`.
|
||||
|
||||
### Root Dependencies and Config Not Imported (Critical)
|
||||
|
||||
`nx import` does **NOT** merge from the source's root:
|
||||
|
||||
- `dependencies`/`devDependencies` from `package.json`
|
||||
- `targetDefaults` from `nx.json` (e.g. `"@nx/esbuild:esbuild": { "dependsOn": ["^build"] }` — critical for build ordering)
|
||||
- `namedInputs` from `nx.json` (e.g. `production` exclusion patterns for test files)
|
||||
- Plugin configurations from `nx.json`
|
||||
|
||||
**Fix**: Diff source and dest `package.json` + `nx.json`. Add missing deps, merge relevant `targetDefaults` and `namedInputs`.
|
||||
|
||||
### TypeScript Project References
|
||||
|
||||
After import, run `nx sync --yes`. If it reports nothing but typecheck still fails, `nx reset` first, then `nx sync --yes` again.
|
||||
|
||||
### Explicit Executor Path Fixups
|
||||
|
||||
Inferred targets (via Nx plugins) resolve config relative to project root — no changes needed. Explicit executor targets (e.g. `@nx/esbuild:esbuild`) have workspace-root-relative paths (`main`, `outputPath`, `tsConfig`, `assets`, `sourceRoot`) that must be prefixed with the import destination directory.
|
||||
|
||||
### Plugin Detection
|
||||
|
||||
- **Whole-repo import**: `nx import` detects and offers to install plugins. Accept them.
|
||||
- **Subdirectory import**: Plugins NOT auto-detected. Manually add with `npx nx add @nx/PLUGIN`. Check `include`/`exclude` patterns — defaults won't match alternate directories (e.g. `apps-beta/`).
|
||||
- Run `npx nx reset` after any plugin config changes.
|
||||
|
||||
### Redundant Root Files (Whole-Repo Only)
|
||||
|
||||
Whole-repo import brings ALL source root files into the dest subdirectory. Clean up:
|
||||
|
||||
- `pnpm-lock.yaml` — stale; dest has its own lockfile
|
||||
- `pnpm-workspace.yaml` — source workspace config; conflicts with dest
|
||||
- `node_modules/` — stale symlinks pointing to source filesystem
|
||||
- `.gitignore` — redundant with dest root `.gitignore`
|
||||
- `nx.json` — source Nx config; dest has its own
|
||||
- `README.md` — optional; keep or remove
|
||||
|
||||
**Don't blindly delete** `tsconfig.base.json` — imported projects may extend it via relative paths.
|
||||
|
||||
### Root ESLint Config Missing (Subdirectory Import)
|
||||
|
||||
Subdirectory import doesn't bring the source's root `eslint.config.mjs`, but project configs reference `../../eslint.config.mjs`.
|
||||
|
||||
**Fix order**:
|
||||
|
||||
1. Install ESLint deps first: `pnpm add -wD eslint@^9 @nx/eslint-plugin typescript-eslint` (plus framework-specific plugins)
|
||||
2. Create root `eslint.config.mjs` (copy from source or create with `@nx/eslint-plugin` base rules)
|
||||
3. Then `npx nx add @nx/eslint` to register the plugin in `nx.json`
|
||||
|
||||
Install `typescript-eslint` explicitly — pnpm's strict hoisting won't auto-resolve this transitive dep of `@nx/eslint-plugin`.
|
||||
|
||||
### ESLint Version Pinning (Critical)
|
||||
|
||||
**Pin ESLint to v9** (`eslint@^9.0.0`). ESLint 10 breaks `@nx/eslint` and many plugins with cryptic errors like `Cannot read properties of undefined (reading 'version')`.
|
||||
|
||||
`@nx/eslint` may peer-depend on ESLint 8, causing the wrong version to resolve. If lint fails with `Cannot read properties of undefined (reading 'allow')`, add `pnpm.overrides`:
|
||||
|
||||
```json
|
||||
{ "pnpm": { "overrides": { "eslint": "^9.0.0" } } }
|
||||
```
|
||||
|
||||
### Dependency Version Conflicts
|
||||
|
||||
After import, compare key deps (`typescript`, `eslint`, framework-specific). If dest uses newer versions, upgrade imported packages to match (usually safe). If source is newer, may need to upgrade dest first. Use `pnpm.overrides` to enforce single-version policy if desired.
|
||||
|
||||
### Module Boundaries
|
||||
|
||||
Imported projects may lack `tags`. Add tags or update `@nx/enforce-module-boundaries` rules.
|
||||
|
||||
### Project Name Collisions (Multi-Import)
|
||||
|
||||
Same `name` in `package.json` across source and dest causes `MultipleProjectsWithSameNameError`. **Fix**: Rename conflicting names (e.g. `@org/api` → `@org/teama-api`), update all dep references and import statements, `pnpm install`. The root `package.json` of each imported repo also becomes a project — rename those too.
|
||||
|
||||
### Workspace Dep Import Ordering
|
||||
|
||||
`pnpm install` fails during `nx import` if a `"workspace:*"` dependency hasn't been imported yet. File operations still succeed. **Fix**: Import all projects first, then `pnpm install --no-frozen-lockfile`.
|
||||
|
||||
### `.gitkeep` Blocking Subdirectory Import
|
||||
|
||||
The TS preset creates `packages/.gitkeep`. Remove it and commit before importing.
|
||||
|
||||
### Frontend tsconfig Base Settings (Critical)
|
||||
|
||||
The TS preset defaults (`module: "nodenext"`, `moduleResolution: "nodenext"`, `lib: ["es2022"]`) are incompatible with frontend frameworks (React, Next.js, Vue, Vite). After importing frontend projects, verify the dest root `tsconfig.base.json`:
|
||||
|
||||
- **`moduleResolution`**: Must be `"bundler"` (not `"nodenext"`)
|
||||
- **`module`**: Must be `"esnext"` (not `"nodenext"`)
|
||||
- **`lib`**: Must include `"dom"` and `"dom.iterable"` (frontend projects need these)
|
||||
- **`jsx`**: `"react-jsx"` for React-only workspaces, per-project for mixed frameworks
|
||||
|
||||
For **subdirectory imports**, the dest root tsconfig is authoritative — update it. For **whole-repo imports**, imported projects may extend their own nested `tsconfig.base.json`, making this less critical.
|
||||
|
||||
If the dest also has backend projects needing `nodenext`, use per-project overrides instead of changing the root.
|
||||
|
||||
**Gotcha**: TypeScript does NOT merge `lib` arrays — a project-level override **replaces** the base array entirely. Always include all needed entries (e.g. `es2022`, `dom`, `dom.iterable`) in any project-level `lib`.
|
||||
|
||||
### `@nx/react` Typings for Libraries
|
||||
|
||||
React libraries generated with `@nx/react:library` reference `@nx/react/typings/cssmodule.d.ts` and `@nx/react/typings/image.d.ts` in their tsconfig `types`. These fail with `Cannot find type definition file` unless `@nx/react` is installed in the dest workspace.
|
||||
|
||||
**Fix**: `pnpm add -wD @nx/react`
|
||||
|
||||
### Jest Preset Missing (Subdirectory Import)
|
||||
|
||||
Nx presets create `jest.preset.js` at the workspace root, and project jest configs reference it (e.g. `../../jest.preset.js`). Subdirectory import does NOT bring this file.
|
||||
|
||||
**Fix**:
|
||||
|
||||
1. Run `npx nx add @nx/jest` — registers `@nx/jest/plugin` in `nx.json` and updates `namedInputs`
|
||||
2. Create `jest.preset.js` at workspace root (see `references/JEST.md` for content) — `nx add` only creates this when a generator runs, not on bare `nx add`
|
||||
3. Install test runner deps: `pnpm add -wD jest jest-environment-jsdom ts-jest @types/jest`
|
||||
4. Install framework-specific test deps as needed (see `references/JEST.md`)
|
||||
|
||||
For deeper Jest issues (tsconfig.spec.json, Babel transforms, CI atomization, Jest vs Vitest coexistence), see `references/JEST.md`.
|
||||
|
||||
### Target Name Prefixing (Whole-Repo Import)
|
||||
|
||||
When importing a project with existing npm scripts (`build`, `dev`, `start`, `lint`), Nx plugins auto-prefix inferred target names to avoid conflicts: e.g. `next:build`, `vite:build`, `eslint:lint`.
|
||||
|
||||
**Fix**: Remove the Nx-rewritten npm scripts from the imported `package.json`, then either:
|
||||
|
||||
- Accept the prefixed names (e.g. `nx run app:next:build`)
|
||||
- Rename plugin target names in `nx.json` to use unprefixed names
|
||||
|
||||
## Non-Nx Source Issues
|
||||
|
||||
When the source is a plain pnpm/npm workspace without `nx.json`.
|
||||
|
||||
### npm Script Rewriting (Critical)
|
||||
|
||||
Nx rewrites `package.json` scripts during init, creating broken commands (e.g. `vitest run` → `nx test run`). **Fix**: Remove all rewritten scripts — Nx plugins infer targets from config files.
|
||||
|
||||
### `noEmit` → `composite` + `emitDeclarationOnly` (Critical)
|
||||
|
||||
Plain TS projects use `"noEmit": true`, incompatible with Nx project references.
|
||||
|
||||
**Symptoms**: "typecheck target is disabled because one or more project references set 'noEmit: true'" or TS6310.
|
||||
|
||||
**Fix** in **all** imported tsconfigs:
|
||||
|
||||
1. Remove `"noEmit": true`. If inherited via extends chain, set `"noEmit": false` explicitly.
|
||||
2. Add `"composite": true`, `"emitDeclarationOnly": true`, `"declarationMap": true`
|
||||
3. Add `"outDir": "dist"` and `"tsBuildInfoFile": "dist/tsconfig.tsbuildinfo"`
|
||||
4. Add `"extends": "../../tsconfig.base.json"` if missing. Remove settings now inherited from base.
|
||||
|
||||
### Stale node_modules and Lockfiles
|
||||
|
||||
`nx import` may bring `node_modules/` (pnpm symlinks pointing to the source filesystem) and `pnpm-lock.yaml` from the source. Both are stale.
|
||||
|
||||
**Fix**: `rm -rf imported/node_modules imported/pnpm-lock.yaml imported/pnpm-workspace.yaml imported/.gitignore`, then `pnpm install`.
|
||||
|
||||
### ESLint Config Handling
|
||||
|
||||
- **Legacy `.eslintrc.json` (ESLint 8)**: Delete all `.eslintrc.*`, remove v8 deps, create flat `eslint.config.mjs`.
|
||||
- **Flat config (`eslint.config.js`)**: Self-contained configs can often be left as-is.
|
||||
- **No ESLint**: Create both root and project-level configs from scratch.
|
||||
|
||||
### TypeScript `paths` Aliases
|
||||
|
||||
Nx uses `package.json` `"exports"` + pnpm workspace linking instead of tsconfig `"paths"`. If packages have proper `"exports"`, paths are redundant. Otherwise, update paths for the new directory structure.
|
||||
|
||||
## Technology-specific Guidance
|
||||
|
||||
Identify technologies in the source repo, then read and apply the matching reference file(s).
|
||||
|
||||
Available references:
|
||||
|
||||
- `references/ESLINT.md` — ESLint projects: duplicate `lint`/`eslint:lint` targets, legacy `.eslintrc.*` linting generated files, flat config `.cjs` self-linting, `typescript-eslint` v7/v9 peer dep conflict, mixed ESLint v8+v9 in one workspace.
|
||||
- `references/GRADLE.md`
|
||||
- `references/JEST.md` — Jest testing: `@nx/jest/plugin` setup, jest.preset.js, testing deps by framework, tsconfig.spec.json, Jest vs Vitest coexistence, Babel transforms, CI atomization.
|
||||
- `references/NEXT.md` — Next.js projects: `@nx/next/plugin` targets, `withNx`, Next.js TS config (`noEmit`, `jsx: "preserve"`), auto-installing deps via wrong PM, non-Nx `create-next-app` imports, mixed Next.js+Vite coexistence.
|
||||
- `references/TURBOREPO.md`
|
||||
- `references/VITE.md` — Vite projects (React, Vue, or both): `@nx/vite/plugin` typecheck target, `resolve.alias`/`__dirname` fixes, framework deps, Vue-specific setup, mixed React+Vue coexistence.
|
||||
@@ -0,0 +1,109 @@
|
||||
## ESLint
|
||||
|
||||
ESLint-specific guidance for `nx import`. For generic import issues (root deps, pnpm globs, project references), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### How `@nx/eslint/plugin` Works
|
||||
|
||||
`@nx/eslint/plugin` scans for ESLint config files and creates a lint target for each project. It detects **both** flat config files (`eslint.config.{js,mjs,cjs,ts,mts,cts}`) and legacy config files (`.eslintrc.{json,js,cjs,mjs,yml,yaml}`).
|
||||
|
||||
**Plugin options (set during `nx add @nx/eslint`):**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/eslint/plugin",
|
||||
"options": {
|
||||
"targetName": "eslint:lint"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Auto-installation**: `nx import` auto-detects ESLint config files and offers to install `@nx/eslint`. Accept the offer — it registers the plugin and updates `namedInputs.production` to exclude ESLint config files.
|
||||
|
||||
---
|
||||
|
||||
### Duplicate `lint` and `eslint:lint` Targets
|
||||
|
||||
After import, projects will have **two** lint-related targets if the source `package.json` has a `"lint"` npm script:
|
||||
|
||||
- `eslint:lint` — inferred by `@nx/eslint/plugin`; has proper caching and input/output tracking
|
||||
- `lint` — created by Nx from the npm script via `nx:run-script`; no caching intelligence, just wraps `npm run lint`
|
||||
|
||||
**Fix**: Remove the `"lint"` script from each project's `package.json`. Keep `"lint:fix"` if present — there is no plugin-inferred equivalent for auto-fixing.
|
||||
|
||||
---
|
||||
|
||||
### Legacy `.eslintrc.*` Configs Linting Generated Files
|
||||
|
||||
When `@nx/eslint/plugin` runs `eslint .` on a project with a legacy `.eslintrc.*` config that uses `parserOptions.project`, it tries to lint **all** files in the project directory including:
|
||||
|
||||
- Generated `dist/**/*.d.ts` files (not in tsconfig `include`)
|
||||
- The `.eslintrc.js` config file itself (not in tsconfig `include`)
|
||||
|
||||
This causes `Parsing error: ESLint was configured to run on X using parserOptions.project, however that TSConfig does not include this file`.
|
||||
|
||||
**Fix**: Add `ignorePatterns` to the `.eslintrc.*` config:
|
||||
|
||||
```json
|
||||
// .eslintrc.json
|
||||
{
|
||||
"ignorePatterns": ["dist/**"]
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
// .eslintrc.js — also ignore the config file itself since module.exports isn't in tsconfig
|
||||
module.exports = {
|
||||
ignorePatterns: ['dist/**', '.eslintrc.js'],
|
||||
// ...
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Flat Config `.cjs` Files Self-Linting
|
||||
|
||||
When a project uses `eslint.config.cjs` (CJS flat config), `eslint .` lints the config file itself. The `require()` call on line 1 triggers `@typescript-eslint/no-require-imports`.
|
||||
|
||||
**Fix**: Add the config filename to the top-level `ignores` array:
|
||||
|
||||
```js
|
||||
module.exports = tseslint.config(
|
||||
{
|
||||
ignores: ['dist/**', 'node_modules/**', 'eslint.config.cjs'],
|
||||
}
|
||||
// ...
|
||||
);
|
||||
```
|
||||
|
||||
The same applies to `eslint.config.js` in a CJS project (no `"type": "module"`) if it uses `require()`.
|
||||
|
||||
---
|
||||
|
||||
### `typescript-eslint` Version Conflict With ESLint 9
|
||||
|
||||
`typescript-eslint@7.x` declares `peerDependencies: { "eslint": "^8.56.0" }`, but it is commonly used alongside `"eslint": "^9.0.0"`. npm treats this as a hard peer dep conflict and refuses to install.
|
||||
|
||||
**Root cause**: `@nx/eslint` init adds `eslint@~8.57.0` at the workspace root (for its own peer deps). Workspace packages that request `eslint@^9.0.0` + `typescript-eslint@^7.0.0` trigger the conflict when npm resolves their deps.
|
||||
|
||||
**Fix**: Upgrade `typescript-eslint` from `^7.0.0` to `^8.0.0` directly in the affected workspace package's `package.json`. The `tseslint.config()` API and `tseslint.configs.recommended` are identical between v7 and v8 — no config changes needed.
|
||||
|
||||
```json
|
||||
// packages/my-package/package.json
|
||||
{
|
||||
"devDependencies": {
|
||||
"typescript-eslint": "^8.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: npm's root-level `"overrides"` field does not force versions for workspace packages' direct dependencies — update each package.json individually.
|
||||
|
||||
---
|
||||
|
||||
### Mixed ESLint v8 and v9 in One Workspace
|
||||
|
||||
Legacy v8 and flat-config v9 packages can coexist in the same workspace. Each package resolves its own `eslint` version. The root `eslint@~8.57.0` (added by `@nx/eslint` init) is used by legacy v8 packages; v9 packages get their own hoisted `eslint@9`.
|
||||
|
||||
`@nx/eslint/plugin` infers `eslint:lint` targets for **both** config formats. Legacy packages run ESLint v8 with `.eslintrc.*`; flat-config packages run ESLint v9 with `eslint.config.*`. No special nx.json configuration is needed to support both simultaneously.
|
||||
@@ -0,0 +1,12 @@
|
||||
## Gradle
|
||||
|
||||
- If you import an entire Gradle repository into a subfolder, files like `gradlew`, `gradlew.bat`, and `gradle/wrapper` will end up inside that imported subfolder.
|
||||
- The `@nx/gradle` plugin expects those files at the workspace root to infer Gradle projects/tasks automatically.
|
||||
- If the target workspace has no Gradle setup yet, consider moving those files to the root (especially when using `@nx/gradle`).
|
||||
- If the target workspace already has Gradle configured, avoid duplicate wrappers: remove imported duplicates from the subfolder or merge carefully.
|
||||
- Because the import lands in a subfolder, Gradle project references can break; review settings and project path references, then fix any errors.
|
||||
- If `@nx/gradle` is installed, run `nx show projects` to verify that Gradle projects are being inferred.
|
||||
|
||||
Helpful docs:
|
||||
|
||||
- https://nx.dev/docs/technologies/java/gradle/introduction
|
||||
@@ -0,0 +1,228 @@
|
||||
## Jest
|
||||
|
||||
Jest-specific guidance for `nx import`. For the basic "Jest Preset Missing" fix (create `jest.preset.js`, install deps), see `SKILL.md`. This file covers deeper Jest integration issues.
|
||||
|
||||
---
|
||||
|
||||
### How `@nx/jest` Works
|
||||
|
||||
`@nx/jest/plugin` scans for `jest.config.{ts,js,cjs,mjs,cts,mts}` and creates a `test` target for each project.
|
||||
|
||||
**Plugin options:**
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": {
|
||||
"targetName": "test"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
`npx nx add @nx/jest` does two things:
|
||||
|
||||
1. **Registers `@nx/jest/plugin` in `nx.json`** — without this, no `test` targets are inferred
|
||||
2. Updates `namedInputs.production` to exclude test files
|
||||
|
||||
**Gotcha**: `nx add @nx/jest` does NOT create `jest.preset.js` — that file is only generated when you run a generator (e.g. `@nx/jest:configuration`). For imports, you must create it manually (see "Jest Preset" section below).
|
||||
|
||||
**Other gotcha**: If you create `jest.preset.js` manually but skip `npx nx add @nx/jest`, the plugin won't be registered and `nx run PROJECT:test` will fail with "Cannot find target 'test'". You need both.
|
||||
|
||||
---
|
||||
|
||||
### Jest Preset
|
||||
|
||||
The preset provides shared Jest configuration (test patterns, ts-jest transform, resolver, jsdom environment).
|
||||
|
||||
**Root `jest.preset.js`:**
|
||||
|
||||
```js
|
||||
const nxPreset = require('@nx/jest/preset').default;
|
||||
module.exports = { ...nxPreset };
|
||||
```
|
||||
|
||||
**Project `jest.config.ts`:**
|
||||
|
||||
```ts
|
||||
export default {
|
||||
displayName: 'my-lib',
|
||||
preset: '../../jest.preset.js',
|
||||
// project-specific overrides
|
||||
};
|
||||
```
|
||||
|
||||
The `preset` path is relative from the project root to the workspace root. Subdirectory imports preserve the original relative path (e.g. `../../jest.preset.js`), which resolves correctly if the import destination matches the source directory depth.
|
||||
|
||||
---
|
||||
|
||||
### Testing Dependencies
|
||||
|
||||
#### Core (always needed)
|
||||
|
||||
```
|
||||
pnpm add -wD jest ts-jest @types/jest @nx/jest
|
||||
```
|
||||
|
||||
#### Environment-specific
|
||||
|
||||
- **DOM testing** (React, Vue, browser libs): `jest-environment-jsdom`
|
||||
- **Node testing** (APIs, CLIs): no extra deps (Jest defaults to `node` env, but Nx preset defaults to `jsdom`)
|
||||
|
||||
#### React testing
|
||||
|
||||
```
|
||||
pnpm add -wD @testing-library/react @testing-library/jest-dom
|
||||
```
|
||||
|
||||
#### React with Babel (non-ts-jest transform)
|
||||
|
||||
Some React projects use Babel instead of ts-jest for JSX transformation:
|
||||
|
||||
```
|
||||
pnpm add -wD babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript
|
||||
```
|
||||
|
||||
**When**: Project `jest.config` has `transform` using `babel-jest` instead of `ts-jest`. Common in older Nx workspaces and CRA migrations.
|
||||
|
||||
#### Vue testing
|
||||
|
||||
```
|
||||
pnpm add -wD @vue/test-utils
|
||||
```
|
||||
|
||||
Vue projects typically use Vitest (not Jest) — see VITE.md.
|
||||
|
||||
---
|
||||
|
||||
### `tsconfig.spec.json`
|
||||
|
||||
Jest projects need a `tsconfig.spec.json` that includes test files:
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": "./tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "../../dist/out-tsc",
|
||||
"module": "commonjs",
|
||||
"types": ["jest", "node"]
|
||||
},
|
||||
"include": [
|
||||
"jest.config.ts",
|
||||
"src/**/*.test.ts",
|
||||
"src/**/*.spec.ts",
|
||||
"src/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Common issues after import:**
|
||||
|
||||
- Missing `"types": ["jest", "node"]` — causes `describe`/`it`/`expect` to be unrecognized
|
||||
- Missing `"module": "commonjs"` — Jest doesn't support ESM by default (ts-jest transpiles to CJS)
|
||||
- `include` array missing test patterns — TypeScript won't check test files
|
||||
|
||||
---
|
||||
|
||||
### Jest vs Vitest Coexistence
|
||||
|
||||
Workspaces can have both:
|
||||
|
||||
- **Jest**: Next.js apps, older React libs, Node libraries
|
||||
- **Vitest**: Vite-based React/Vue apps and libs
|
||||
|
||||
Both `@nx/jest/plugin` and `@nx/vite/plugin` (which infers Vitest targets) coexist without conflicts — they detect different config files (`jest.config.*` vs `vite.config.*`).
|
||||
|
||||
**Target naming**: Both default to `test`. If a project somehow has both config files, rename one:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": { "targetName": "jest-test" }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `@testing-library/jest-dom` — Jest vs Vitest
|
||||
|
||||
Projects migrating from Jest to Vitest (or workspaces with both) need different imports:
|
||||
|
||||
**Jest** (in `test-setup.ts`):
|
||||
|
||||
```ts
|
||||
import '@testing-library/jest-dom';
|
||||
```
|
||||
|
||||
**Vitest** (in `test-setup.ts`):
|
||||
|
||||
```ts
|
||||
import '@testing-library/jest-dom/vitest';
|
||||
```
|
||||
|
||||
If the source used Jest but the dest workspace uses Vitest for that project type, update the import path. Also add `@testing-library/jest-dom` to tsconfig `types` array.
|
||||
|
||||
---
|
||||
|
||||
### Non-Nx Source: Test Script Rewriting
|
||||
|
||||
Nx rewrites `package.json` scripts during init. Test scripts get broken:
|
||||
|
||||
- `"test": "jest"` → `"test": "nx test"` (circular if no executor configured)
|
||||
- `"test": "vitest run"` → `"test": "nx test run"` (broken — `run` becomes an argument)
|
||||
|
||||
**Fix**: Remove all rewritten test scripts. `@nx/jest/plugin` and `@nx/vite/plugin` infer test targets from config files.
|
||||
|
||||
---
|
||||
|
||||
### CI Atomization
|
||||
|
||||
`@nx/jest/plugin` supports splitting tests per-file for CI parallelism:
|
||||
|
||||
```json
|
||||
{
|
||||
"plugin": "@nx/jest/plugin",
|
||||
"options": {
|
||||
"targetName": "test",
|
||||
"ciTargetName": "test-ci"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This creates `test-ci--src/lib/foo.spec.ts` targets for each test file, enabling Nx Cloud distribution. Not relevant during import, but useful for post-import CI setup.
|
||||
|
||||
---
|
||||
|
||||
### Common Post-Import Issues
|
||||
|
||||
1. **"Cannot find target 'test'"**: `@nx/jest/plugin` not registered in `nx.json`. Run `npx nx add @nx/jest` or manually add the plugin entry.
|
||||
|
||||
2. **"Cannot find module 'jest-preset'"**: `jest.preset.js` missing at workspace root. Create it (see SKILL.md).
|
||||
|
||||
3. **"Cannot find type definition file for 'jest'"**: Missing `@types/jest` or `tsconfig.spec.json` doesn't have `"types": ["jest", "node"]`.
|
||||
|
||||
4. **Tests fail with "Cannot use import statement outside a module"**: `ts-jest` not installed or not configured as transform. Check `jest.config.ts` transform section.
|
||||
|
||||
5. **Snapshot path mismatches**: After import, `__snapshots__` directories may have paths baked in. Run tests once with `--updateSnapshot` to regenerate.
|
||||
|
||||
---
|
||||
|
||||
## Fix Order
|
||||
|
||||
### Subdirectory Import (Nx Source)
|
||||
|
||||
1. `npx nx add @nx/jest` — registers plugin in `nx.json` (does NOT create `jest.preset.js`)
|
||||
2. Create `jest.preset.js` manually (see "Jest Preset" section above)
|
||||
3. Install deps: `pnpm add -wD jest jest-environment-jsdom ts-jest @types/jest`
|
||||
4. Install framework test deps: `@testing-library/react @testing-library/jest-dom` (React), `@vue/test-utils` (Vue)
|
||||
5. Verify `tsconfig.spec.json` has `"types": ["jest", "node"]`
|
||||
6. `nx run-many -t test`
|
||||
|
||||
### Whole-Repo Import (Non-Nx Source)
|
||||
|
||||
1. Remove rewritten test scripts from `package.json`
|
||||
2. `npx nx add @nx/jest` — registers plugin (does NOT create preset)
|
||||
3. Create `jest.preset.js` manually
|
||||
4. Install deps (same as above)
|
||||
5. Verify/fix `jest.config.*` — ensure `preset` path points to root `jest.preset.js`
|
||||
6. Verify/fix `tsconfig.spec.json` — add `types`, `module`, `include` if missing
|
||||
7. `nx run-many -t test`
|
||||
@@ -0,0 +1,214 @@
|
||||
## Next.js
|
||||
|
||||
Next.js-specific guidance for `nx import`. For generic import issues (pnpm globs, root deps, project references, name collisions, ESLint, frontend tsconfig base settings, `@nx/react` typings, Jest preset, target name prefixing, non-Nx source handling), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### `@nx/next/plugin` Inferred Targets
|
||||
|
||||
`@nx/next/plugin` detects `next.config.{ts,js,cjs,mjs}` and creates these targets:
|
||||
|
||||
- `build` → `next build` (with `dependsOn: ['^build']`)
|
||||
- `dev` → `next dev`
|
||||
- `start` → `next start` (depends on `build`)
|
||||
- `serve-static` → same as `start`
|
||||
- `build-deps` / `watch-deps` — for TS solution setup
|
||||
|
||||
**No separate typecheck target** — Next.js runs TypeScript checking as part of `next build`. The `@nx/js/typescript` plugin provides a standalone `typecheck` target for non-Next libraries in the workspace.
|
||||
|
||||
**Build target conflict**: Both `@nx/next/plugin` and `@nx/js/typescript` define a `build` target. `@nx/next/plugin` wins for Next.js projects (it detects `next.config.*`), while `@nx/js/typescript` handles libraries with `tsconfig.lib.json`. No rename needed — they coexist.
|
||||
|
||||
### `withNx` in `next.config.js`
|
||||
|
||||
Nx-generated Next.js projects use `composePlugins(withNx)` from `@nx/next`. This wrapper is optional for `next build` via the inferred plugin (which just runs `next build`), but it provides Nx-specific configuration. Keep it if present.
|
||||
|
||||
### Root Dependencies for Next.js
|
||||
|
||||
Beyond the generic root deps issue (see SKILL.md), Next.js projects typically need:
|
||||
|
||||
**Core**: `react`, `react-dom`, `@types/react`, `@types/react-dom`, `@types/node`, `@nx/react` (see SKILL.md for `@nx/react` typings)
|
||||
**Nx plugins**: `@nx/next` (auto-installed by import), `@nx/eslint`, `@nx/jest`
|
||||
**Testing**: see SKILL.md "Jest Preset Missing" section
|
||||
**ESLint**: `@next/eslint-plugin-next` (in addition to generic ESLint deps from SKILL.md)
|
||||
|
||||
### Next.js Auto-Installing Dependencies via Wrong Package Manager
|
||||
|
||||
Next.js detects missing `@types/react` during `next build` and tries to install it using `yarn add` regardless of the actual package manager. In a pnpm workspace, this fails with a "nearest package directory isn't part of the project" error.
|
||||
|
||||
**Root cause**: `@types/react` is missing from root devDependencies.
|
||||
**Fix**: Install deps at the root before building: `pnpm add -wD @types/react @types/react-dom`
|
||||
|
||||
### Next.js TypeScript Config Specifics
|
||||
|
||||
Next.js app tsconfigs have unique patterns compared to Vite:
|
||||
|
||||
- **`noEmit: true`** with `emitDeclarationOnly: false` — Next.js handles emit, TS just checks types. This conflicts with `composite: true` from the TS solution setup.
|
||||
- **`"types": ["jest", "node"]`** — includes test types in the main tsconfig (no separate `tsconfig.app.json`)
|
||||
- **`"plugins": [{ "name": "next" }]`** — for IDE integration
|
||||
- **`include`** references `.next/types/**/*.ts` for Next.js auto-generated types
|
||||
- **`"jsx": "preserve"`** — Next.js uses its own JSX transform, not React's
|
||||
|
||||
**Gotcha**: The Next.js tsconfig sets `"noEmit": true` which disables `composite` mode. This is fine because Next.js projects use `next build` for building, not `tsc`. The `@nx/js/typescript` plugin's `typecheck` target is not needed for Next.js apps.
|
||||
|
||||
### `next.config.js` Lint Warning
|
||||
|
||||
Imported Next.js configs may have `// eslint-disable-next-line @typescript-eslint/no-var-requires` but the project ESLint config enables different rule sets. This produces `Unused eslint-disable directive` warnings. Harmless — remove the comment or ignore.
|
||||
|
||||
### `@nx/next:init` Rewrites All npm Scripts (Whole-Repo Import)
|
||||
|
||||
When `@nx/next:init` runs during a whole-repo import, it rewrites the project's `package.json` scripts to prefixed `nx` calls:
|
||||
|
||||
```json
|
||||
{
|
||||
"dev": "nx next:dev",
|
||||
"build": "nx next:build",
|
||||
"start": "nx next:start"
|
||||
}
|
||||
```
|
||||
|
||||
This is the standard "npm Script Rewriting" issue from SKILL.md, but triggered by `@nx/next:init` rather than Nx init. **Fix**: Remove all rewritten scripts from `package.json` — `@nx/next/plugin` infers all targets from `next.config.*`.
|
||||
|
||||
---
|
||||
|
||||
## Non-Nx Source (create-next-app)
|
||||
|
||||
### Whole-Repo Import Recommended
|
||||
|
||||
For single-project `create-next-app` repos, use whole-repo import into a subdirectory:
|
||||
|
||||
```bash
|
||||
nx import /path/to/source apps/web --ref=main --source=. --no-interactive
|
||||
```
|
||||
|
||||
### `next-env.d.ts`
|
||||
|
||||
`next build` auto-generates `next-env.d.ts` at the project root. Add `next-env.d.ts` to the dest root `.gitignore` — it is framework-generated and should not be committed.
|
||||
|
||||
### ESLint: Self-Contained `eslint-config-next`
|
||||
|
||||
`create-next-app` generates a flat ESLint config using `eslint-config-next` (which bundles its own plugins). This is **self-contained** — no root `eslint.config.mjs` needed, no `@nx/eslint-plugin` dependency. The `@nx/eslint/plugin` detects it and creates a lint target.
|
||||
|
||||
### TypeScript: No Changes Needed
|
||||
|
||||
Non-Nx Next.js projects have self-contained tsconfigs with `noEmit: true`, their own `lib`, `module`, `moduleResolution`, and `jsx` settings. Since `next build` handles type checking internally, no tsconfig modifications are needed. The project does NOT need to extend `tsconfig.base.json`.
|
||||
|
||||
**Gotcha**: The `@nx/js/typescript` plugin won't create a `typecheck` target because there's no `tsconfig.lib.json`. This is fine — use `next:build` for type checking.
|
||||
|
||||
### `noEmit: true` and TS Solution Setup
|
||||
|
||||
Non-Nx Next.js projects use `noEmit: true`, which conflicts with Nx's TS solution setup (`composite: true`). If the dest workspace uses project references and you want the Next.js app to participate:
|
||||
|
||||
1. Remove `noEmit: true`, add `composite: true`, `emitDeclarationOnly: true`
|
||||
2. Add `extends: "../../tsconfig.base.json"`
|
||||
3. Add `outDir` and `tsBuildInfoFile`
|
||||
|
||||
**However**, this is optional for standalone Next.js apps that don't export types consumed by other workspace projects.
|
||||
|
||||
### Tailwind / PostCSS
|
||||
|
||||
`create-next-app` with Tailwind generates `postcss.config.mjs`. This works as-is after import — no path changes needed since PostCSS resolves relative to the project root.
|
||||
|
||||
---
|
||||
|
||||
## Mixed Next.js + Vite Coexistence
|
||||
|
||||
When both Next.js and Vite projects exist in the same workspace.
|
||||
|
||||
### Plugin Coexistence
|
||||
|
||||
Both `@nx/next/plugin` and `@nx/vite/plugin` can coexist in `nx.json`. They detect different config files (`next.config.*` vs `vite.config.*`) so there are no conflicts. The `@nx/js/typescript` plugin handles libraries.
|
||||
|
||||
### Vite Standalone Project tsconfig Fixes
|
||||
|
||||
Vite standalone projects (imported as whole-repo) have self-contained tsconfigs without `composite: true`. The `@nx/js/typescript` plugin's typecheck target runs `tsc --build --emitDeclarationOnly` which requires `composite`.
|
||||
|
||||
**Fix**:
|
||||
|
||||
1. Add `extends: "../../tsconfig.base.json"` to the root project tsconfig
|
||||
2. Add `composite: true`, `declaration: true`, `declarationMap: true`, `tsBuildInfoFile` to `tsconfig.app.json` and `tsconfig.spec.json`
|
||||
3. Set `moduleResolution: "bundler"` (replace `"node"`)
|
||||
4. Add source files to `tsconfig.spec.json` `include` — specs import app code, and `composite` mode requires all files to be listed
|
||||
|
||||
### Typecheck Target Names
|
||||
|
||||
- `@nx/vite/plugin` defaults `typecheckTargetName` to `"vite:typecheck"`
|
||||
- `@nx/js/typescript` uses `"typecheck"`
|
||||
- Next.js projects have NO standalone typecheck target — Next.js runs type checking during `next build`
|
||||
|
||||
No naming conflicts between frameworks.
|
||||
|
||||
---
|
||||
|
||||
## Fix Order — Nx Source (Subdirectory Import)
|
||||
|
||||
1. Import Next.js apps into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
2. Generic fixes from SKILL.md (pnpm globs, root deps, `.gitkeep` removal, frontend tsconfig base settings, `@nx/react` typings)
|
||||
3. Install Next.js-specific deps: `pnpm add -wD @next/eslint-plugin-next`
|
||||
4. ESLint setup (see SKILL.md: "Root ESLint Config Missing")
|
||||
5. Jest setup (see SKILL.md: "Jest Preset Missing")
|
||||
6. `nx reset && nx sync --yes && nx run-many -t typecheck,build,test,lint`
|
||||
|
||||
## Fix Order — Non-Nx Source (create-next-app)
|
||||
|
||||
1. Import into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
2. Generic fixes from SKILL.md (pnpm globs, stale files cleanup, script rewriting, target name prefixing)
|
||||
3. (Optional) If app needs to export types for other workspace projects: fix `noEmit` → `composite` (see SKILL.md)
|
||||
4. `nx reset && nx run-many -t next:build,eslint:lint` (or unprefixed names if renamed)
|
||||
|
||||
---
|
||||
|
||||
## Iteration Log
|
||||
|
||||
### Scenario 1: Basic Nx Next.js App Router + Shared Lib → TS preset (PASS)
|
||||
|
||||
- Source: CNW next preset (Next.js 16, App Router) + `@nx/react:library` shared-ui
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Import: subdirectory-at-a-time (apps, libs separately)
|
||||
- Errors found & fixed:
|
||||
1. pnpm-workspace.yaml: `apps`/`libs` → `apps/*`/`libs/*`
|
||||
2. Root tsconfig: `nodenext` → `bundler`, add `dom`/`dom.iterable` to `lib`, add `jsx: react-jsx`
|
||||
3. Missing `@nx/react` (for CSS module/image type defs in lib)
|
||||
4. Missing `@types/react`, `@types/react-dom`, `@types/node`
|
||||
5. Next.js trying `yarn add @types/react` — fixed by installing at root
|
||||
6. Missing `@nx/eslint`, root `eslint.config.mjs`, ESLint plugins
|
||||
7. Missing `@nx/jest`, `jest.preset.js`, `jest-environment-jsdom`, `ts-jest`
|
||||
- All targets green: typecheck, build, test, lint
|
||||
|
||||
### Scenario 3: Non-Nx create-next-app (App Router + Tailwind) → TS preset (PASS)
|
||||
|
||||
- Source: `create-next-app@latest` (Next.js 16.1.6, App Router, Tailwind v4, flat ESLint config)
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Import: whole-repo into `apps/web`
|
||||
- Errors found & fixed:
|
||||
1. pnpm-workspace.yaml: `apps/web` → `apps/*`
|
||||
2. Stale files: `node_modules/`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `.gitignore` — deleted
|
||||
3. Nx-rewritten npm scripts (`"build": "nx next:build"`, etc.) — removed
|
||||
- No tsconfig changes needed — self-contained config with `noEmit: true`
|
||||
- ESLint self-contained via `eslint-config-next` — no root config needed
|
||||
- No test setup (create-next-app doesn't include tests)
|
||||
- All targets green: next:build, eslint:lint
|
||||
|
||||
### Scenario 4: Non-Nx create-next-app (alongside Vite, React Router 7, TanStack, CRA) → TS preset (PASS)
|
||||
|
||||
- See VITE.md Scenario 6 for the full multi-import scenario
|
||||
- Next.js-specific findings:
|
||||
1. `@nx/next:init` rewrote all scripts to `nx next:*` format — removed all rewritten scripts
|
||||
2. Stale files: `node_modules/`, `package-lock.json`, `.gitignore` — deleted (npm workspace, no pnpm files)
|
||||
3. ESLint self-contained via `eslint-config-next` — no root config needed
|
||||
4. No tsconfig changes needed — `noEmit: true` stays; `next build` handles type checking
|
||||
- Targets: `next:build`, `next:dev`, `next:start`, `eslint:lint`
|
||||
|
||||
### Scenario 5: Mixed Next.js (Nx) + Vite React (standalone) → TS preset (PASS)
|
||||
|
||||
- Source A: CNW next preset (Next.js 16, App Router) — subdirectory import of `apps/`
|
||||
- Source B: CNW react-standalone preset (Vite 7, React 19) — whole-repo import into `apps/vite-app`
|
||||
- Dest: CNW ts preset (Nx 23)
|
||||
- Errors found & fixed:
|
||||
1. All Scenario 1 fixes for the Next.js app
|
||||
2. Stale files from Vite source: `node_modules/`, `pnpm-lock.yaml`, `pnpm-workspace.yaml`, `.gitignore`, `nx.json`
|
||||
3. Removed rewritten scripts from Vite app's `package.json`
|
||||
4. ESLint 8 vs 9 conflict — `@nx/eslint` peer on ESLint 8 resolved wrong version. Fixed with `pnpm.overrides`
|
||||
5. Vite tsconfigs missing `composite: true`, `declaration: true` — needed for `tsc --build --emitDeclarationOnly`
|
||||
6. Vite `tsconfig.spec.json` `include` missing source files — specs import app code
|
||||
7. Vite tsconfig `moduleResolution: "node"` → `"bundler"`, added `extends: "../../tsconfig.base.json"`
|
||||
- All targets green: typecheck, build, test, lint for both projects
|
||||
@@ -0,0 +1,62 @@
|
||||
## Turborepo
|
||||
|
||||
- Nx replaces Turborepo task orchestration, but a clean migration requires handling Turborepo's config packages.
|
||||
- Migration guide: https://nx.dev/docs/guides/adopting-nx/from-turborepo#easy-automated-migration-example
|
||||
- Since Nx replaces Turborepo, all turbo config files and config packages become dead code and should be removed.
|
||||
|
||||
## The Config-as-Package Pattern
|
||||
|
||||
Turborepo monorepos ship with internal workspace packages that share configuration:
|
||||
|
||||
- **`@repo/typescript-config`** (or similar) — tsconfig files (`base.json`, `nextjs.json`, `react-library.json`, etc.)
|
||||
- **`@repo/eslint-config`** (or similar) — ESLint config files and all ESLint plugin dependencies
|
||||
|
||||
These are not code libraries. They distribute config via Node module resolution (e.g., `"extends": "@repo/typescript-config/nextjs.json"`). This is the **default** Turborepo pattern — expect it in virtually every Turborepo import. Package names vary — check `package.json` files to identify the actual names.
|
||||
|
||||
## Check for Root Config Files First
|
||||
|
||||
**Before doing any config merging, check whether the destination workspace uses shared root configuration.** This decides how to handle the config packages.
|
||||
|
||||
- If the workspace has a root `tsconfig.base.json` and/or root `eslint.config.mjs` that projects extend, merge the config packages into these root configs (see steps below).
|
||||
- If the workspace does NOT have root config files — each project manages its own configuration independently (similar to Turborepo). In this case, **do not create root config files or merge into them**. Just remove turbo-specific parts (`turbo.json`, `eslint-plugin-turbo`) and leave the config packages in place, or ask the user how they want to handle them.
|
||||
|
||||
If unclear, check for the presence of `tsconfig.base.json` at the root or ask the user.
|
||||
|
||||
## Merging TypeScript Config (Only When Root tsconfig.base.json Exists)
|
||||
|
||||
The config package contains a hierarchy of tsconfig files. Each project extends one via package name.
|
||||
|
||||
1. **Read the config package** — trace the full inheritance chain (e.g., `nextjs.json` extends `base.json`).
|
||||
2. **Update root `tsconfig.base.json`** — absorb `compilerOptions` from the base config. Add Nx `paths` for cross-project imports (Turborepo doesn't use path aliases, Nx relies on them).
|
||||
3. **Update each project's `tsconfig.json`**:
|
||||
- Change `"extends"` from `"@repo/typescript-config/<variant>.json"` to the relative path to root `tsconfig.base.json`.
|
||||
- Inline variant-specific overrides from the intermediate config (e.g., Next.js: `"module": "ESNext"`, `"moduleResolution": "Bundler"`, `"jsx": "preserve"`, `"noEmit": true`; React library: `"jsx": "react-jsx"`).
|
||||
- Preserve project-specific settings (`outDir`, `include`, `exclude`, etc.).
|
||||
4. **Delete the config package** and remove it from all `devDependencies`.
|
||||
|
||||
## Merging ESLint Config (Only When Root eslint.config Exists)
|
||||
|
||||
The config package centralizes ESLint plugin dependencies and exports composable flat configs.
|
||||
|
||||
1. **Read the config package** — identify exported configs, plugin dependencies, and inheritance.
|
||||
2. **Update root `eslint.config.mjs`** — absorb base rules (JS recommended, TypeScript-ESLint, Prettier, etc.). Drop `eslint-plugin-turbo`.
|
||||
3. **Update each project's `eslint.config.mjs`** — switch from importing `@repo/eslint-config/<variant>` to extending the root config, adding framework-specific plugins inline.
|
||||
4. **Move ESLint plugin dependencies** from the config package to root `devDependencies`.
|
||||
5. If `@nx/eslint` plugin is configured with inferred targets, remove `"lint"` scripts from project `package.json` files.
|
||||
6. **Delete the config package** and remove it from all `devDependencies`.
|
||||
|
||||
## General Cleanup
|
||||
|
||||
- Remove turbo-specific dependencies: `turbo`, `eslint-plugin-turbo`.
|
||||
- Delete all `turbo.json` files (root and per-package).
|
||||
- Run workspace validation (`nx run-many -t build lint test typecheck`) to confirm nothing broke.
|
||||
|
||||
## Key Pitfalls
|
||||
|
||||
- **Trace the full inheritance chain** before inlining — check what each variant inherits from the base.
|
||||
- **Module resolution changes** — from Node package resolution (`@repo/...`) to relative paths (`../../tsconfig.base.json`).
|
||||
- **ESLint configs are JavaScript, not JSON** — handle JS imports, array spreading, and plugin objects when merging.
|
||||
|
||||
Helpful docs:
|
||||
|
||||
- https://nx.dev/docs/guides/adopting-nx/from-turborepo
|
||||
@@ -0,0 +1,397 @@
|
||||
## Vite
|
||||
|
||||
Vite-specific guidance for `nx import`. For generic import issues (pnpm globs, root deps, project references, name collisions, ESLint, frontend tsconfig base settings, `@nx/react` typings, Jest preset, non-Nx source handling), see `SKILL.md`.
|
||||
|
||||
---
|
||||
|
||||
### `@nx/vite/plugin` Typecheck Target
|
||||
|
||||
`@nx/vite/plugin` defaults `typecheckTargetName` to `"vite:typecheck"`. If the workspace expects `"typecheck"`, set it explicitly in `nx.json`. If `@nx/js/typescript` is also registered, rename one target to avoid conflicts (e.g. `"tsc-typecheck"` for the JS plugin).
|
||||
|
||||
Keep both plugins only if the workspace has non-Vite pure TS libraries — `@nx/js/typescript` handles those while `@nx/vite/plugin` handles Vite projects.
|
||||
|
||||
### @nx/vite Plugin Install Failure
|
||||
|
||||
Plugin init loads `vite.config.ts` before deps are available. **Fix**: `pnpm add -wD vite @vitejs/plugin-react` (or `@vitejs/plugin-vue`) first, then `pnpm exec nx add @nx/vite`.
|
||||
|
||||
### Vite `resolve.alias` and `__dirname` (Non-Nx Sources)
|
||||
|
||||
**`__dirname` undefined** (CJS-only): Replace with `fileURLToPath(new URL('./src', import.meta.url))` from `'node:url'`.
|
||||
|
||||
**`@/` path alias**: Vite's `resolve.alias` works at runtime but TS needs matching `"paths"`. Set `"baseUrl": "."` in project tsconfig.
|
||||
|
||||
**PostCSS/Tailwind**: Verify `content` globs resolve correctly after import.
|
||||
|
||||
### Missing TypeScript `types` (Non-Nx Sources)
|
||||
|
||||
Non-Nx tsconfigs may not declare all needed types. Ensure Vite projects include `"types": ["node", "vite/client"]` in their tsconfig.
|
||||
|
||||
### `noEmit` Fix: Vite-Specific Notes
|
||||
|
||||
See SKILL.md for the generic noEmit→composite fix. Vite-specific additions:
|
||||
|
||||
- Non-Nx Vite projects often have **both** `tsconfig.app.json` and `tsconfig.node.json` with `noEmit` — fix both
|
||||
- Solution-style tsconfigs (`"files": [], "references": [...]`) may lack `extends`. Add `extends` pointing to the dest root `tsconfig.base.json` so base settings (`moduleResolution`, `lib`) apply.
|
||||
- This is safe — Vite/Vitest ignore TypeScript emit settings.
|
||||
|
||||
### Dependency Version Conflicts
|
||||
|
||||
**Shared Vite deps (both frameworks):** `vite`, `vitest`, `jsdom`, `@types/node`, `typescript` (dev)
|
||||
|
||||
**Vite 6→7**: Typecheck fails (`Plugin<any>` type mismatch); build/serve still works. Fix: align versions.
|
||||
**Vitest 3→4**: Usually works; type conflicts may surface in shared test utils.
|
||||
|
||||
---
|
||||
|
||||
## React Router 7 (Vite-Based)
|
||||
|
||||
React Router 7 (`@react-router/dev`) uses Vite under the hood with a `vite.config.ts` and a `react-router.config.ts`. The `@nx/vite/plugin` detects `vite.config.ts` and creates inferred targets.
|
||||
|
||||
### Targets
|
||||
|
||||
`@nx/vite/plugin` creates `build`, `dev`, `serve` targets. The `build` target invokes the script defined in `package.json` (usually `react-router build`), not `vite build` directly.
|
||||
|
||||
**No separate typecheck target from `@nx/vite/plugin`** — React Router 7 typegen is run as part of `typecheck` (e.g. `react-router typegen && tsc`). The `typecheck` target is inferred from the tsconfig. Keep the `typecheck` script in `package.json` if present; it is not rewritten.
|
||||
|
||||
### tsconfig Notes
|
||||
|
||||
React Router 7 uses a single `tsconfig.json` (no `tsconfig.app.json`/`tsconfig.node.json` split). It includes:
|
||||
|
||||
- `"rootDirs": [".", "./.react-router/types"]` — for generated type files; keep as-is
|
||||
- `"paths": { "~/*": ["./app/*"] }` — self-referential alias; keep as-is
|
||||
- `"noEmit": true` — replace with composite settings per SKILL.md
|
||||
|
||||
### Build Output
|
||||
|
||||
React Router 7 outputs to `build/` (not `dist/`). Add `build` to the dest root `.gitignore`.
|
||||
|
||||
### Generated Types Directory
|
||||
|
||||
React Router 7 generates `.react-router/` at the project root for route type generation. Add `.react-router` to the dest root `.gitignore`.
|
||||
|
||||
---
|
||||
|
||||
## TanStack Start (Vite-Based)
|
||||
|
||||
TanStack Start uses Vinxi under the hood, which wraps Vite. Projects have a standard `vite.config.ts` that `@nx/vite/plugin` detects normally.
|
||||
|
||||
### Targets
|
||||
|
||||
`@nx/vite/plugin` creates `build`, `dev`, `preview`, `serve-static`, `typecheck` targets. The `build` target runs `vite build` which invokes the TanStack Start Vinxi pipeline (produces both client and SSR bundles).
|
||||
|
||||
### tsconfig Notes
|
||||
|
||||
TanStack Start uses a single `tsconfig.json` with `"allowImportingTsExtensions": true` and `"noEmit": true`. Apply the standard noEmit → composite fix. `allowImportingTsExtensions` is compatible with `emitDeclarationOnly: true` — no change needed.
|
||||
|
||||
### `paths` Aliases
|
||||
|
||||
TanStack Start commonly uses `"#/*": ["./src/*"]` and `"@/*": ["./src/*"]`. These are self-referential — keep as-is for a single-project app.
|
||||
|
||||
### Uncommitted Source Repo
|
||||
|
||||
`create-tan-stack` initializes a git repo but does NOT make an initial commit. Before importing, commit first:
|
||||
|
||||
```bash
|
||||
git -C /path/to/source add . && git -C /path/to/source commit -m "Initial commit"
|
||||
```
|
||||
|
||||
### Generated and Build Directories
|
||||
|
||||
TanStack Start / Vinxi / Nitro generate several directories that must be added to the dest root `.gitignore`:
|
||||
|
||||
- `.vinxi` — Vinxi build cache
|
||||
- `.tanstack` — TanStack generated files
|
||||
- `.nitro` — Nitro build artifacts
|
||||
- `.output` — server-side build output (SSR/edge)
|
||||
|
||||
These are not covered by `dist` or `build`.
|
||||
|
||||
---
|
||||
|
||||
## React-Specific
|
||||
|
||||
### React Dependencies
|
||||
|
||||
**Production:** `react`, `react-dom`
|
||||
**Dev:** `@types/react`, `@types/react-dom`, `@vitejs/plugin-react`, `@testing-library/react`, `@testing-library/jest-dom`, `jsdom`
|
||||
**ESLint (Nx sources):** `eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-plugin-react-hooks`
|
||||
**ESLint (`create-vite`):** `eslint-plugin-react-refresh`, `eslint-plugin-react-hooks` — self-contained flat configs can be left as-is
|
||||
**Nx plugins:** `@nx/react` (generators), `@nx/vite`, `@nx/vitest`, `@nx/eslint`
|
||||
|
||||
### React TypeScript Configuration
|
||||
|
||||
Add `"jsx": "react-jsx"` — in `tsconfig.base.json` for single-framework workspaces, per-project for mixed (see Mixed section).
|
||||
|
||||
### React ESLint Config
|
||||
|
||||
```js
|
||||
import nx from '@nx/eslint-plugin';
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
export default [
|
||||
...baseConfig,
|
||||
...nx.configs['flat/react'],
|
||||
{ files: ['**/*.ts', '**/*.tsx'], rules: {} },
|
||||
];
|
||||
```
|
||||
|
||||
### React Version Conflicts
|
||||
|
||||
React 18 (source) + React 19 (dest): pnpm may hoist mismatched `react-dom`, causing `TypeError: Cannot read properties of undefined (reading 'S')`. **Fix**: Align versions with `pnpm.overrides`.
|
||||
|
||||
### `@testing-library/jest-dom` with Vitest
|
||||
|
||||
If source used Jest: change import to `@testing-library/jest-dom/vitest` in test-setup.ts, add to tsconfig `types`.
|
||||
|
||||
---
|
||||
|
||||
## Vue-Specific
|
||||
|
||||
### Vue Dependencies
|
||||
|
||||
**Production:** `vue` (plus `vue-router`, `pinia` if used)
|
||||
**Dev:** `@vitejs/plugin-vue`, `vue-tsc`, `@vue/test-utils`, `jsdom`
|
||||
**ESLint:** `eslint-plugin-vue`, `vue-eslint-parser`, `@vue/eslint-config-typescript`, `@vue/eslint-config-prettier`
|
||||
**Nx plugins:** `@nx/vue` (generators), `@nx/vite`, `@nx/vitest`, `@nx/eslint` (install AFTER deps — see below)
|
||||
|
||||
### Vue TypeScript Configuration
|
||||
|
||||
Add to `tsconfig.base.json` (single-framework) or per-project (mixed):
|
||||
|
||||
```json
|
||||
{ "jsx": "preserve", "jsxImportSource": "vue", "resolveJsonModule": true }
|
||||
```
|
||||
|
||||
### `vue-shims.d.ts`
|
||||
|
||||
Vue SFC files need a type declaration. Usually exists in each project's `src/` and imports cleanly. If missing:
|
||||
|
||||
```ts
|
||||
declare module '*.vue' {
|
||||
import { defineComponent } from 'vue';
|
||||
const component: ReturnType<typeof defineComponent>;
|
||||
export default component;
|
||||
}
|
||||
```
|
||||
|
||||
### `vue-tsc` Auto-Detection
|
||||
|
||||
Both `@nx/js/typescript` and `@nx/vite/plugin` auto-detect `vue-tsc` when installed — no manual config needed. Remove source scripts like `"typecheck": "vue-tsc --noEmit"`.
|
||||
|
||||
### ESLint Plugin Installation Order (Critical)
|
||||
|
||||
`@nx/eslint` init **crashes** if Vue ESLint deps aren't installed first (it loads all config files).
|
||||
|
||||
**Correct order:**
|
||||
|
||||
1. `pnpm add -wD eslint@^9 eslint-plugin-vue vue-eslint-parser @vue/eslint-config-typescript @typescript-eslint/parser @nx/eslint-plugin typescript-eslint`
|
||||
2. Create root `eslint.config.mjs`
|
||||
3. Then `npx nx add @nx/eslint`
|
||||
|
||||
### Vue ESLint Config Pattern
|
||||
|
||||
```js
|
||||
import vue from 'eslint-plugin-vue';
|
||||
import vueParser from 'vue-eslint-parser';
|
||||
import tsParser from '@typescript-eslint/parser';
|
||||
import baseConfig from '../../eslint.config.mjs';
|
||||
export default [
|
||||
...baseConfig,
|
||||
...vue.configs['flat/recommended'],
|
||||
{
|
||||
files: ['**/*.vue'],
|
||||
languageOptions: { parser: vueParser, parserOptions: { parser: tsParser } },
|
||||
},
|
||||
{
|
||||
files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx', '**/*.vue'],
|
||||
rules: { 'vue/multi-word-component-names': 'off' },
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
**Important**: `vue-eslint-parser` override must come **AFTER** base config — `flat/typescript` sets the TS parser globally without a `files` filter, breaking `.vue` parsing.
|
||||
|
||||
`vue-eslint-parser` must be an explicit pnpm dependency (strict resolution prevents transitive import).
|
||||
|
||||
**Known issue**: Some generated Vue ESLint configs omit `vue-eslint-parser`. Use the pattern above instead.
|
||||
|
||||
---
|
||||
|
||||
## Mixed React + Vue
|
||||
|
||||
When both frameworks coexist, several settings become per-project.
|
||||
|
||||
### tsconfig `jsx` — Per-Project Only
|
||||
|
||||
- React: `"jsx": "react-jsx"` in project tsconfig
|
||||
- Vue: `"jsx": "preserve"`, `"jsxImportSource": "vue"` in project tsconfig
|
||||
- Root: **NO** `jsx` setting
|
||||
|
||||
### Typecheck — Auto-Detects Framework
|
||||
|
||||
`@nx/vite/plugin` uses `vue-tsc` for Vue projects and `tsc` for React automatically.
|
||||
|
||||
```json
|
||||
{
|
||||
"plugins": [
|
||||
{ "plugin": "@nx/eslint/plugin", "options": { "targetName": "lint" } },
|
||||
{
|
||||
"plugin": "@nx/vite/plugin",
|
||||
"options": {
|
||||
"buildTargetName": "build",
|
||||
"typecheckTargetName": "typecheck",
|
||||
"testTargetName": "test"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Remove `@nx/js/typescript` if all projects use Vite. Keep it (renamed to `"tsc-typecheck"`) only for non-Vite pure TS libs.
|
||||
|
||||
### ESLint — Three-Tier Config
|
||||
|
||||
1. **Root**: Base rules only, no framework-specific rules
|
||||
2. **React projects**: Extend root + `nx.configs['flat/react']`
|
||||
3. **Vue projects**: Extend root + `vue.configs['flat/recommended']` + `vue-eslint-parser`
|
||||
|
||||
**Required packages**: Shared (`eslint@^9`, `@nx/eslint-plugin`, `typescript-eslint`, `@typescript-eslint/parser`), React (`eslint-plugin-import`, `eslint-plugin-jsx-a11y`, `eslint-plugin-react`, `eslint-plugin-react-hooks`), Vue (`eslint-plugin-vue`, `vue-eslint-parser`)
|
||||
|
||||
`@nx/react`/`@nx/vue` are for generators only — no target conflicts.
|
||||
|
||||
---
|
||||
|
||||
## Redundant npm Scripts After Import
|
||||
|
||||
`nx import` copies `package.json` verbatim, so npm scripts come along. For Vite-based projects `@nx/vite/plugin` already infers the same targets from `vite.config.ts` — the npm scripts just shadow the plugin with weaker `nx:run-script` wrappers (no first-class caching inputs/outputs). Remove them after import.
|
||||
|
||||
### Standalone Vite App (`create-vite`)
|
||||
|
||||
Remove the following scripts — every one is redundant:
|
||||
|
||||
| Script | Plugin replacement |
|
||||
| ----------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `dev: vite` | `@nx/vite/plugin` → `dev` |
|
||||
| `build: tsc -b && vite build` | `@nx/vite/plugin` → `build`; `typecheck` via `@nx/js/typescript` handles tsc |
|
||||
| `preview: vite preview` | `@nx/vite/plugin` → `preview` |
|
||||
| `lint: eslint .` | `@nx/eslint/plugin` → `eslint:lint` |
|
||||
|
||||
### TanStack Start
|
||||
|
||||
Remove `build`, `dev`, `preview`, and `test` scripts, but move any hardcoded `--port` flag to `vite.config.ts` first:
|
||||
|
||||
```ts
|
||||
// vite.config.ts
|
||||
export default defineConfig({
|
||||
server: { port: 3000 }, // replaces `vite dev --port 3000`
|
||||
...
|
||||
})
|
||||
```
|
||||
|
||||
### React Router 7 — Keep ALL scripts
|
||||
|
||||
Do **not** remove React Router 7 scripts. They use the framework CLI (`react-router build`, `react-router dev`, `react-router-serve`) which is not interchangeable with plain `vite`:
|
||||
|
||||
- `typecheck` runs `react-router typegen && tsc` — typegen must precede `tsc` or it fails on missing route types
|
||||
- `start` serves the SSR bundle — no plugin equivalent
|
||||
|
||||
---
|
||||
|
||||
## Fix Orders
|
||||
|
||||
### Nx Source
|
||||
|
||||
1. Generic fixes from SKILL.md (pnpm globs, root deps, executor paths, frontend tsconfig base settings, `@nx/react` typings)
|
||||
2. Configure `@nx/vite/plugin` typecheck target
|
||||
3. **React**: `jsx: "react-jsx"` (root or per-project)
|
||||
4. **Vue**: `jsx: "preserve"` + `jsxImportSource: "vue"`; verify `vue-shims.d.ts`; install ESLint deps before `@nx/eslint`
|
||||
5. **Mixed**: `jsx` per-project; remove/rename `@nx/js/typescript`
|
||||
6. `nx sync --yes && nx reset && nx run-many -t typecheck,build,test,lint`
|
||||
|
||||
### Non-Nx Source (additional steps)
|
||||
|
||||
0. Import into `apps/<name>` (see SKILL.md: "Application vs Library Detection")
|
||||
1. Generic fixes from SKILL.md (stale files cleanup, pnpm globs, rewritten scripts, target name prefixing, noEmit→composite, ESLint handling)
|
||||
2. Fix `noEmit` in **all** tsconfigs (app, node, etc. — non-Nx projects often have multiple)
|
||||
3. Add `extends` to solution-style tsconfigs so root settings apply
|
||||
4. Fix `resolve.alias` / `__dirname` / `baseUrl`
|
||||
5. Ensure `types` include `vite/client` and `node`
|
||||
6. Install `@nx/vite` manually if it failed during import
|
||||
7. Remove redundant npm scripts so `@nx/vite/plugin` infers them natively (see "Redundant npm Scripts" section)
|
||||
8. **Vue**: Add `outDir` + `**/*.vue.d.ts` to ESLint ignores
|
||||
9. Full verification
|
||||
|
||||
### Multiple-Source Imports
|
||||
|
||||
See SKILL.md for generic multi-import (name collisions, dep refs). Vite-specific: fix tsconfig `references` paths for alternate directories (`../../libs/` → `../../libs-beta/`).
|
||||
|
||||
### Non-Nx Source: React Router 7
|
||||
|
||||
1. Ensure source has at least one commit (see SKILL.md: "Source Repo Has No Commits")
|
||||
2. `nx import` whole-repo into `apps/<name>` (see SKILL.md: "Application vs Library Detection") → auto-installs `@nx/vite`, `@nx/react`
|
||||
3. Stale file cleanup: `node_modules/`, `package-lock.json`, `.gitignore`
|
||||
4. Fix `tsconfig.json`: `noEmit` → `composite + emitDeclarationOnly + outDir + tsBuildInfoFile`
|
||||
5. Add `build` and `.react-router` to dest root `.gitignore`
|
||||
6. **Keep all npm scripts** — React Router 7 uses framework CLI (`react-router build/dev`), not plain vite (see "Redundant npm Scripts" above)
|
||||
7. `npm install && nx reset && nx sync --yes`
|
||||
|
||||
### Non-Nx Source: TanStack Start
|
||||
|
||||
1. Ensure source has at least one commit — `create-tan-stack` does NOT auto-commit (see SKILL.md)
|
||||
2. `nx import` whole-repo into `apps/<name>` (see SKILL.md: "Application vs Library Detection") → auto-installs `@nx/vite`, `@nx/vitest`
|
||||
3. Stale file cleanup: `node_modules/`, `package-lock.json`, `.gitignore`
|
||||
4. Fix `tsconfig.json`: `noEmit` → `composite + emitDeclarationOnly + outDir + tsBuildInfoFile`
|
||||
5. Keep `allowImportingTsExtensions` — compatible with `emitDeclarationOnly: true`
|
||||
6. Add `.vinxi`, `.tanstack`, `.nitro`, `.output` to dest root `.gitignore`
|
||||
7. Move hardcoded `--port` from `dev` script into `vite.config.ts` (`server: { port: N }`)
|
||||
8. Remove redundant npm scripts — `@nx/vite/plugin` infers `build`, `dev`, `preview`, `test` (see "Redundant npm Scripts" above)
|
||||
9. `npm install && nx reset && nx sync --yes`
|
||||
|
||||
### Quick Reference: React vs Vue
|
||||
|
||||
| Aspect | React | Vue |
|
||||
| ------------- | ------------------------ | ----------------------------------------- |
|
||||
| Vite plugin | `@vitejs/plugin-react` | `@vitejs/plugin-vue` |
|
||||
| Type checker | `tsc` | `vue-tsc` (auto-detected) |
|
||||
| SFC support | N/A | `vue-shims.d.ts` needed |
|
||||
| tsconfig jsx | `"react-jsx"` | `"preserve"` + `"jsxImportSource": "vue"` |
|
||||
| ESLint parser | Standard TS | `vue-eslint-parser` + TS sub-parser |
|
||||
| ESLint setup | Straightforward | Must install deps before `@nx/eslint` |
|
||||
| Test utils | `@testing-library/react` | `@vue/test-utils` |
|
||||
|
||||
### Quick Reference: Vite-Based React Frameworks
|
||||
|
||||
| Aspect | Vite (standalone) | React Router 7 | TanStack Start |
|
||||
| ------------------ | ----------------- | ----------------------- | ------------------------ |
|
||||
| Build config | `vite.config.ts` | `vite.config.ts` | `vite.config.ts` |
|
||||
| Build output | `dist/` | `build/` | `dist/` |
|
||||
| SSR bundle | No | Yes (`build/server/`) | Yes (`dist/server/`) |
|
||||
| tsconfig layout | app + node split | Single tsconfig | Single tsconfig |
|
||||
| Auto-committed | Depends on tool | Usually yes | **No — commit first** |
|
||||
| `nx import` plugin | `@nx/vite` | `@nx/vite`, `@nx/react` | `@nx/vite`, `@nx/vitest` |
|
||||
|
||||
---
|
||||
|
||||
## Iteration Log
|
||||
|
||||
### Scenario 6: Multiple non-Nx React apps (CRA, Next.js, React Router 7, TanStack Start, Vite) → TS preset (PASS)
|
||||
|
||||
- Sources: 5 standalone non-Nx repos with different build tools
|
||||
- Dest: CNW ts preset (Nx 22.5.1), npm workspaces, `packages/*`
|
||||
- Import: whole-repo for each, sequential into `packages/<name>`
|
||||
- Pre-import fixes:
|
||||
1. Removed `packages/.gitkeep` and committed
|
||||
2. `git init && git add . && git commit` in Vite app (no git at all)
|
||||
3. `git add . && git commit` in TanStack app (git init'd but no commits)
|
||||
- Import: `npm exec nx -- import <source> packages/<name> --source=. --ref=main --no-interactive`
|
||||
- Next.js import auto-installed `@nx/eslint`, `@nx/next`
|
||||
- React Router 7 import auto-installed `@nx/vite`, `@nx/react`, `@nx/docker` (Dockerfile present)
|
||||
- TanStack import auto-installed `@nx/vitest`
|
||||
- Post-import fixes:
|
||||
1. Removed stale `node_modules/`, `package-lock.json`, `.gitignore` from each package
|
||||
2. Removed Nx-rewritten scripts from `board-games-nextjs/package.json` (had `"build": "nx next:build"`, etc.)
|
||||
3. Updated root `tsconfig.base.json`: `nodenext` → `bundler`, added `dom`/`dom.iterable` to lib, added `jsx: react-jsx`
|
||||
4. Added `build` to dest root `.gitignore` (CRA and React Router 7 output there)
|
||||
5. Fixed `noEmit` → `composite + emitDeclarationOnly` in: `board-games-vite/tsconfig.app.json`, `board-games-vite/tsconfig.node.json`, `board-games-react-router/tsconfig.json`, `board-games-tanstack/tsconfig.json`
|
||||
6. Fixed `tsBuildInfoFile` paths from `./node_modules/.tmp/...` to `./dist/...`
|
||||
7. Installed root `@types/react`, `@types/react-dom`, `@types/node`
|
||||
- All targets green: `build` for all 5 projects; `typecheck` for Vite/React Router/TanStack; `next:build` for Next.js
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
name: nx-plugins
|
||||
description: Find and add Nx plugins. USE WHEN user wants to discover available plugins, install a new plugin, or add support for a specific framework or technology to the workspace.
|
||||
---
|
||||
|
||||
## Finding and Installing new plugins
|
||||
|
||||
- List plugins: `pnpm nx list`
|
||||
- Install plugins `pnpm nx add <plugin>`. Example: `pnpm nx add @nx/react`.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: nx-run-tasks
|
||||
description: Helps with running tasks in an Nx workspace. USE WHEN the user wants to execute build, test, lint, serve, or run any other tasks defined in the workspace.
|
||||
---
|
||||
|
||||
You can run tasks with Nx in the following way.
|
||||
|
||||
Keep in mind that you might have to prefix things with npx/pnpx/yarn if the user doesn't have nx installed globally. Look at the package.json or lockfile to determine which package manager is in use.
|
||||
|
||||
For more details on any command, run it with `--help` (e.g. `nx run-many --help`, `nx affected --help`).
|
||||
|
||||
## Understand which tasks can be run
|
||||
|
||||
You can check those via `nx show project <projectname> --json`, for example `nx show project myapp --json`. It contains a `targets` section which has information about targets that can be run. You can also just look at the `package.json` scripts or `project.json` targets, but you might miss out on inferred tasks by Nx plugins.
|
||||
|
||||
## Run a single task
|
||||
|
||||
```
|
||||
nx run <project>:<task>
|
||||
```
|
||||
|
||||
where `project` is the project name defined in `package.json` or `project.json` (if present).
|
||||
|
||||
## Run multiple tasks
|
||||
|
||||
```
|
||||
nx run-many -t build test lint typecheck
|
||||
```
|
||||
|
||||
You can pass a `-p` flag to filter to specific projects, otherwise it runs on all projects. You can also use `--exclude` to exclude projects, and `--parallel` to control the number of parallel processes (default is 3).
|
||||
|
||||
Examples:
|
||||
|
||||
- `nx run-many -t test -p proj1 proj2` — test specific projects
|
||||
- `nx run-many -t test --projects=*-app --exclude=excluded-app` — test projects matching a pattern
|
||||
- `nx run-many -t test --projects=tag:api-*` — test projects by tag
|
||||
|
||||
## Run tasks for affected projects
|
||||
|
||||
Use `nx affected` to only run tasks on projects that have been changed and projects that depend on changed projects. This is especially useful in CI and for large workspaces.
|
||||
|
||||
```
|
||||
nx affected -t build test lint
|
||||
```
|
||||
|
||||
By default it compares against the base branch. You can customize this:
|
||||
|
||||
- `nx affected -t test --base=main --head=HEAD` — compare against a specific base and head
|
||||
- `nx affected -t test --files=libs/mylib/src/index.ts` — specify changed files directly
|
||||
|
||||
## Useful flags
|
||||
|
||||
These flags work with `run`, `run-many`, and `affected`:
|
||||
|
||||
- `--skipNxCache` — rerun tasks even when results are cached
|
||||
- `--verbose` — print additional information such as stack traces
|
||||
- `--nxBail` — stop execution after the first failed task
|
||||
- `--configuration=<name>` — use a specific configuration (e.g. `production`)
|
||||
@@ -0,0 +1,286 @@
|
||||
---
|
||||
name: nx-workspace
|
||||
description: "Explore and understand Nx workspaces. USE WHEN answering questions about the workspace, projects, or tasks. ALSO USE WHEN an nx command fails or you need to check available targets/configuration before running a task. EXAMPLES: 'What projects are in this workspace?', 'How is project X configured?', 'What depends on library Y?', 'What targets can I run?', 'Cannot find configuration for task', 'debug nx task failure'."
|
||||
---
|
||||
|
||||
# Nx Workspace Exploration
|
||||
|
||||
This skill provides read-only exploration of Nx workspaces. Use it to understand workspace structure, project configuration, available targets, and dependencies.
|
||||
|
||||
Keep in mind that you might have to prefix commands with `npx`/`pnpx`/`yarn` if nx isn't installed globally. Check the lockfile to determine the package manager in use.
|
||||
|
||||
## Listing Projects
|
||||
|
||||
Use `nx show projects` to list projects in the workspace.
|
||||
|
||||
The project filtering syntax (`-p`/`--projects`) works across many Nx commands including `nx run-many`, `nx release`, `nx show projects`, and more. Filters support explicit names, glob patterns, tag references (e.g. `tag:name`), directories, and negation (e.g. `!project-name`).
|
||||
|
||||
```bash
|
||||
# List all projects
|
||||
nx show projects
|
||||
|
||||
# Filter by pattern (glob)
|
||||
nx show projects --projects "apps/*"
|
||||
nx show projects --projects "shared-*"
|
||||
|
||||
# Filter by tag
|
||||
nx show projects --projects "tag:publishable"
|
||||
nx show projects -p 'tag:publishable,!tag:internal'
|
||||
|
||||
# Filter by target (projects that have a specific target)
|
||||
nx show projects --withTarget build
|
||||
|
||||
# Combine filters
|
||||
nx show projects --type lib --withTarget test
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
nx show projects -p "tag:scope:client,packages/*"
|
||||
|
||||
# Negate patterns
|
||||
nx show projects -p '!tag:private'
|
||||
nx show projects -p '!*-e2e'
|
||||
|
||||
# Output as JSON
|
||||
nx show projects --json
|
||||
```
|
||||
|
||||
## Project Configuration
|
||||
|
||||
Use `nx show project <name> --json` to get the full resolved configuration for a project.
|
||||
|
||||
**Important**: Do NOT read `project.json` directly - it only contains partial configuration. The `nx show project --json` command returns the full resolved config including inferred targets from plugins.
|
||||
|
||||
You can read the full project schema at `node_modules/nx/schemas/project-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Get full project configuration
|
||||
nx show project my-app --json
|
||||
|
||||
# Extract specific parts from the JSON
|
||||
nx show project my-app --json | jq '.targets'
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Check project metadata
|
||||
nx show project my-app --json | jq '{name, root, sourceRoot, projectType, tags}'
|
||||
```
|
||||
|
||||
## Target Information
|
||||
|
||||
Targets define what tasks can be run on a project.
|
||||
|
||||
```bash
|
||||
# List all targets for a project
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Get full target configuration
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
|
||||
# Check target executor/command
|
||||
nx show project my-app --json | jq '.targets.build.executor'
|
||||
nx show project my-app --json | jq '.targets.build.command'
|
||||
|
||||
# View target options
|
||||
nx show project my-app --json | jq '.targets.build.options'
|
||||
|
||||
# Check target inputs/outputs (for caching)
|
||||
nx show project my-app --json | jq '.targets.build.inputs'
|
||||
nx show project my-app --json | jq '.targets.build.outputs'
|
||||
|
||||
# Find projects with a specific target
|
||||
nx show projects --withTarget serve
|
||||
nx show projects --withTarget e2e
|
||||
```
|
||||
|
||||
## Workspace Configuration
|
||||
|
||||
Read `nx.json` directly for workspace-level configuration.
|
||||
You can read the full project schema at `node_modules/nx/schemas/nx-schema.json` to understand nx project configuration options.
|
||||
|
||||
```bash
|
||||
# Read the full nx.json
|
||||
cat nx.json
|
||||
|
||||
# Or use jq for specific sections
|
||||
cat nx.json | jq '.targetDefaults'
|
||||
cat nx.json | jq '.namedInputs'
|
||||
cat nx.json | jq '.plugins'
|
||||
cat nx.json | jq '.generators'
|
||||
```
|
||||
|
||||
Key nx.json sections:
|
||||
|
||||
- `targetDefaults` - Default configuration applied to all targets of a given name
|
||||
- `namedInputs` - Reusable input definitions for caching
|
||||
- `plugins` - Nx plugins and their configuration
|
||||
- ...and much more, read the schema or nx.json for details
|
||||
|
||||
## Affected Projects
|
||||
|
||||
If the user is asking about affected projects, read the [affected projects reference](references/AFFECTED.md) for detailed commands and examples.
|
||||
|
||||
## Common Exploration Patterns
|
||||
|
||||
### "What's in this workspace?"
|
||||
|
||||
```bash
|
||||
nx show projects
|
||||
nx show projects --type app
|
||||
nx show projects --type lib
|
||||
```
|
||||
|
||||
### "How do I build/test/lint project X?"
|
||||
|
||||
```bash
|
||||
nx show project X --json | jq '.targets | keys'
|
||||
nx show project X --json | jq '.targets.build'
|
||||
```
|
||||
|
||||
### "What depends on library Y?"
|
||||
|
||||
```bash
|
||||
# Use the project graph to find dependents
|
||||
nx graph --print | jq '.graph.dependencies | to_entries[] | select(.value[].target == "Y") | .key'
|
||||
```
|
||||
|
||||
## Programmatic Answers
|
||||
|
||||
When processing nx CLI results, use command-line tools to compute the answer programmatically rather than counting or parsing output manually. Always use `--json` flags to get structured output that can be processed with `jq`, `grep`, or other tools you have installed locally.
|
||||
|
||||
### Listing Projects
|
||||
|
||||
```bash
|
||||
nx show projects --json
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
["my-app", "my-app-e2e", "shared-ui", "shared-utils", "api"]
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Count projects
|
||||
nx show projects --json | jq 'length'
|
||||
|
||||
# Filter by pattern
|
||||
nx show projects --json | jq '.[] | select(startswith("shared-"))'
|
||||
|
||||
# Get affected projects as array
|
||||
nx show projects --affected --json | jq '.'
|
||||
```
|
||||
|
||||
### Project Details
|
||||
|
||||
```bash
|
||||
nx show project my-app --json
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "apps/my-app",
|
||||
"name": "my-app",
|
||||
"sourceRoot": "apps/my-app/src",
|
||||
"projectType": "application",
|
||||
"tags": ["type:app", "scope:client"],
|
||||
"targets": {
|
||||
"build": {
|
||||
"executor": "@nx/vite:build",
|
||||
"options": { "outputPath": "dist/apps/my-app" }
|
||||
},
|
||||
"serve": {
|
||||
"executor": "@nx/vite:dev-server",
|
||||
"options": { "buildTarget": "my-app:build" }
|
||||
},
|
||||
"test": {
|
||||
"executor": "@nx/vite:test",
|
||||
"options": {}
|
||||
}
|
||||
},
|
||||
"implicitDependencies": []
|
||||
}
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Get target names
|
||||
nx show project my-app --json | jq '.targets | keys'
|
||||
|
||||
# Get specific target config
|
||||
nx show project my-app --json | jq '.targets.build'
|
||||
|
||||
# Get tags
|
||||
nx show project my-app --json | jq '.tags'
|
||||
|
||||
# Get project root
|
||||
nx show project my-app --json | jq -r '.root'
|
||||
```
|
||||
|
||||
### Project Graph
|
||||
|
||||
```bash
|
||||
nx graph --print
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```json
|
||||
{
|
||||
"graph": {
|
||||
"nodes": {
|
||||
"my-app": {
|
||||
"name": "my-app",
|
||||
"type": "app",
|
||||
"data": { "root": "apps/my-app", "tags": ["type:app"] }
|
||||
},
|
||||
"shared-ui": {
|
||||
"name": "shared-ui",
|
||||
"type": "lib",
|
||||
"data": { "root": "libs/shared-ui", "tags": ["type:ui"] }
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"my-app": [
|
||||
{ "source": "my-app", "target": "shared-ui", "type": "static" }
|
||||
],
|
||||
"shared-ui": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Common operations:
|
||||
|
||||
```bash
|
||||
# Get all project names from graph
|
||||
nx graph --print | jq '.graph.nodes | keys'
|
||||
|
||||
# Find dependencies of a project
|
||||
nx graph --print | jq '.graph.dependencies["my-app"]'
|
||||
|
||||
# Find projects that depend on a library
|
||||
nx graph --print | jq '.graph.dependencies | to_entries[] | select(.value[].target == "shared-ui") | .key'
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Cannot find configuration for task X:target"
|
||||
|
||||
```bash
|
||||
# Check what targets exist on the project
|
||||
nx show project X --json | jq '.targets | keys'
|
||||
|
||||
# Check if any projects have that target
|
||||
nx show projects --withTarget target
|
||||
```
|
||||
|
||||
### "The workspace is out of sync"
|
||||
|
||||
```bash
|
||||
nx sync
|
||||
nx reset # if sync doesn't fix stale cache
|
||||
```
|
||||
@@ -0,0 +1,27 @@
|
||||
## Affected Projects
|
||||
|
||||
Find projects affected by changes in the current branch.
|
||||
|
||||
```bash
|
||||
# Affected since base branch (auto-detected)
|
||||
nx show projects --affected
|
||||
|
||||
# Affected with explicit base
|
||||
nx show projects --affected --base=main
|
||||
nx show projects --affected --base=origin/main
|
||||
|
||||
# Affected between two commits
|
||||
nx show projects --affected --base=abc123 --head=def456
|
||||
|
||||
# Affected apps only
|
||||
nx show projects --affected --type app
|
||||
|
||||
# Affected excluding e2e projects
|
||||
nx show projects --affected --exclude="*-e2e"
|
||||
|
||||
# Affected by uncommitted changes
|
||||
nx show projects --affected --uncommitted
|
||||
|
||||
# Affected by untracked files
|
||||
nx show projects --affected --untracked
|
||||
```
|
||||
@@ -0,0 +1,101 @@
|
||||
name: Banner Content Monitor
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '*/15 * * * *'
|
||||
workflow_dispatch: # Allow manual trigger
|
||||
|
||||
permissions: {}
|
||||
|
||||
env:
|
||||
BANNER_URL: ${{ vars.BANNER_URL }}
|
||||
|
||||
jobs:
|
||||
check-and-deploy:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Fetch banner content and compute hash
|
||||
id: banner
|
||||
run: |
|
||||
if [ -z "$BANNER_URL" ]; then
|
||||
echo "BANNER_URL is not set"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Fetch content and compute hash
|
||||
CONTENT_HASH=$(curl -sf "$BANNER_URL" | sha256sum | cut -d' ' -f1)
|
||||
|
||||
if [ -z "$CONTENT_HASH" ]; then
|
||||
echo "Failed to fetch banner content"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "current_hash=$CONTENT_HASH" >> $GITHUB_OUTPUT
|
||||
echo "Current banner hash: $CONTENT_HASH"
|
||||
|
||||
- name: Restore cached hash
|
||||
id: cache
|
||||
uses: actions/cache/restore@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: .banner-hash
|
||||
key: banner-content-hash-
|
||||
restore-keys: |
|
||||
banner-content-hash-
|
||||
|
||||
- name: Compare hashes
|
||||
id: compare
|
||||
run: |
|
||||
CURRENT_HASH="${{ steps.banner.outputs.current_hash }}"
|
||||
|
||||
if [ -f .banner-hash ]; then
|
||||
CACHED_HASH=$(cat .banner-hash)
|
||||
echo "Cached hash: $CACHED_HASH"
|
||||
else
|
||||
CACHED_HASH=""
|
||||
echo "No cached hash found"
|
||||
fi
|
||||
|
||||
if [ "$CURRENT_HASH" != "$CACHED_HASH" ]; then
|
||||
echo "changed=true" >> $GITHUB_OUTPUT
|
||||
echo "Banner content has changed!"
|
||||
else
|
||||
echo "changed=false" >> $GITHUB_OUTPUT
|
||||
echo "Banner content unchanged"
|
||||
fi
|
||||
|
||||
- name: Setup Node
|
||||
if: steps.compare.outputs.changed == 'true'
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
with:
|
||||
node-version: '24'
|
||||
|
||||
- name: Trigger Netlify deploys
|
||||
if: steps.compare.outputs.changed == 'true'
|
||||
env:
|
||||
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||
run: |
|
||||
npm install -g netlify-cli
|
||||
|
||||
echo "Triggering nx-docs deploy..."
|
||||
netlify deploy --trigger --prod -s nx-docs
|
||||
|
||||
echo "Triggering nx-dev deploy..."
|
||||
netlify deploy --trigger --prod -s nx-dev
|
||||
|
||||
echo "Triggering nrwl-blog deploy..."
|
||||
netlify deploy --trigger --prod -s nrwl-blog
|
||||
|
||||
echo "All deploys triggered successfully"
|
||||
|
||||
- name: Save new hash to cache
|
||||
if: steps.compare.outputs.changed == 'true'
|
||||
run: |
|
||||
echo "${{ steps.banner.outputs.current_hash }}" > .banner-hash
|
||||
|
||||
- name: Update cache
|
||||
if: steps.compare.outputs.changed == 'true'
|
||||
uses: actions/cache/save@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: .banner-hash
|
||||
key: banner-content-hash-${{ github.run_id }}
|
||||
@@ -0,0 +1,329 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- '[0-9]+.[0-9]+.x'
|
||||
pull_request:
|
||||
branches:
|
||||
- "**"
|
||||
|
||||
env:
|
||||
NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
|
||||
NX_CLOUD_ENABLE_METRICS_COLLECTION: 'true'
|
||||
PNPM_HOME: ~/.pnpm
|
||||
# Pin corepack to the pnpm version from packageManager. Without this, corepack
|
||||
# falls back to "latest" in directories that have no packageManager field
|
||||
# (e.g. e2e temp dirs), pulling pnpm 11 and breaking install.
|
||||
COREPACK_DEFAULT_TO_LATEST: '0'
|
||||
|
||||
jobs:
|
||||
main-linux:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
NX_BATCH_MODE: 'true'
|
||||
NX_E2E_CI_CACHE_KEY: e2e-github-linux
|
||||
NX_DAEMON: 'true'
|
||||
NX_PERF_LOGGING: 'false'
|
||||
NX_VERBOSE_LOGGING: 'false'
|
||||
NX_NATIVE_LOGGING: 'false'
|
||||
NX_E2E_RUN_E2E: 'true'
|
||||
NX_CI_EXECUTION_ENV: 'linux'
|
||||
NX_CLOUD_NO_TIMEOUTS: 'true'
|
||||
NX_ALLOW_NON_CACHEABLE_DTE: 'true'
|
||||
NX_CLOUD_EXPERIMENTAL_POLLING: 'true'
|
||||
NX_CLOUD_CONTINUOUS_ASSIGNMENT: 'true'
|
||||
NX_CLOUD_VERBOSE_LOGGING: 'true'
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Set verbose logging from debug mode
|
||||
if: runner.debug == '1'
|
||||
run: echo "NX_VERBOSE_LOGGING=true" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Fetch Master
|
||||
run: git fetch origin master:master
|
||||
if: ${{ github.event_name == 'pull_request' }}
|
||||
|
||||
- name: Set SHAs
|
||||
uses: nrwl/nx-set-shas@310288c04d90696f9f1bc27c5e3caea6642b53d4 # v5.0.0
|
||||
with:
|
||||
main-branch-name: 'master'
|
||||
|
||||
- name: Start CI Run
|
||||
run: npx nx-cloud@next start-ci-run --distribute-on="./.nx/workflows/dynamic-changesets.yaml" --stop-agents-after="e2e"
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Get pnpm store directory
|
||||
id: pnpm-cache
|
||||
run: echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache pnpm store
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@48b5f213c81028ace310571dc5ec0fbbca0b2947 # v4.4.3
|
||||
|
||||
- name: Install project dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Restore .NET analyzer projects
|
||||
run: dotnet restore nx.sln
|
||||
|
||||
- name: Nx Report
|
||||
run:
|
||||
pnpm nx report
|
||||
|
||||
- name: Run Checks/Lint/Test/Build
|
||||
run: |
|
||||
pids=()
|
||||
|
||||
pnpm nx record -- nx format:check &
|
||||
pids+=($!)
|
||||
|
||||
pnpm nx record -- nx sync:check
|
||||
pids+=($!)
|
||||
|
||||
pnpm nx build workspace-plugin && pnpm nx record -- pnpm nx-cloud conformance:check
|
||||
pids+=($!)
|
||||
|
||||
pnpm nx run-many -t check-imports check-lock-files check-codeowners --parallel=1 --no-dte &
|
||||
pids+=($!)
|
||||
|
||||
pnpm nx affected --targets=lint,test,build,e2e,e2e-ci,format-native,lint-native,gradle:build-ci,vale,run &
|
||||
pids+=($!)
|
||||
|
||||
for pid in "${pids[@]}"; do
|
||||
wait "$pid"
|
||||
done
|
||||
timeout-minutes: 100
|
||||
- name: Fix CI
|
||||
run: pnpm nx fix-ci
|
||||
if: failure()
|
||||
|
||||
main-macos:
|
||||
runs-on: macos-latest
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}${{ contains(github.event_name, 'push') && format('-{0}', github.sha) || '' }}
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
NX_E2E_CI_CACHE_KEY: e2e-github-macos
|
||||
NX_PERF_LOGGING: 'false'
|
||||
NX_CI_EXECUTION_ENV: 'macos'
|
||||
SELECTED_PM: 'npm'
|
||||
steps:
|
||||
|
||||
- name: Log concurrency info
|
||||
run: |
|
||||
echo "Concurrency group: ${{ github.workflow }}-${{ github.ref }}${{ contains(github.event_name, 'push') && format('-{0}', github.sha) || '' }}"
|
||||
echo "Concurrency cancel-in-progress: ${{ !contains(github.event_name, 'push') }}"
|
||||
echo "Concurrency cancel-event-name: ${{ github.event_name }}"
|
||||
if: always()
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Set verbose logging from debug mode
|
||||
if: runner.debug == '1'
|
||||
run: echo "NX_VERBOSE_LOGGING=true" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Fetch Master
|
||||
run: git fetch origin master:master
|
||||
if: ${{ github.event_name == 'pull_request' }}
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Set SHAs
|
||||
uses: nrwl/nx-set-shas@310288c04d90696f9f1bc27c5e3caea6642b53d4 # v5.0.0
|
||||
with:
|
||||
main-branch-name: 'master'
|
||||
|
||||
- name: Check for React Native changes
|
||||
id: check-changes
|
||||
run: |
|
||||
HAS_CHANGED=$(node ./scripts/check-react-native-changes.js $NX_BASE $NX_HEAD);
|
||||
if $HAS_CHANGED; then
|
||||
echo "has_changes=true" >> $GITHUB_OUTPUT
|
||||
echo "React Native projects are affected, will run macOS tests"
|
||||
else
|
||||
echo "has_changes=false" >> $GITHUB_OUTPUT
|
||||
echo "No React Native projects affected, skipping macOS tests"
|
||||
fi
|
||||
|
||||
- name: Restore Homebrew packages
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: |
|
||||
/opt/homebrew
|
||||
~/Library/Caches/Homebrew
|
||||
key: nrwl-nx-homebrew-packages
|
||||
|
||||
- name: Configure Detox Environment, Install applesimutils
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
run: |
|
||||
# Ensure Xcode command line tools are installed and configured
|
||||
xcode-select --print-path || sudo xcode-select --reset
|
||||
sudo xcode-select -s /Applications/Xcode.app
|
||||
|
||||
# Install or update applesimutils with error handling
|
||||
if ! brew list applesimutils &>/dev/null; then
|
||||
echo "Installing applesimutils..."
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew tap wix/brew >/dev/null
|
||||
# Homebrew now refuses to load formulae from third-party taps unless trusted
|
||||
brew trust wix/brew
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils >/dev/null || {
|
||||
echo "Failed to install applesimutils, retrying with update..."
|
||||
brew update
|
||||
brew trust wix/brew
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils
|
||||
}
|
||||
else
|
||||
echo "Updating applesimutils..."
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew upgrade applesimutils || true
|
||||
fi
|
||||
|
||||
# Verify applesimutils installation
|
||||
applesimutils --version || (echo "applesimutils installation failed" && exit 1)
|
||||
|
||||
# Configure environment for M-series Mac
|
||||
echo "DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer" >> $GITHUB_ENV
|
||||
echo "PLATFORM_NAME=iOS Simulator" >> $GITHUB_ENV
|
||||
|
||||
# Set additional environment variables for better debugging
|
||||
echo "DETOX_DISABLE_TELEMETRY=1" >> $GITHUB_ENV
|
||||
echo "DETOX_LOG_LEVEL=trace" >> $GITHUB_ENV
|
||||
|
||||
# Verify Xcode installation
|
||||
xcodebuild -version
|
||||
|
||||
# List available simulators
|
||||
xcrun simctl list devices available
|
||||
timeout-minutes: 10
|
||||
continue-on-error: false
|
||||
|
||||
- name: Reset iOS Simulators
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
id: reset-simulators
|
||||
run: |
|
||||
echo "Resetting iOS Simulators..."
|
||||
|
||||
# Kill simulator processes
|
||||
sudo killall -9 com.apple.CoreSimulator.CoreSimulatorService 2>/dev/null || true
|
||||
killall "Simulator" 2>/dev/null || true
|
||||
killall "iOS Simulator" 2>/dev/null || true
|
||||
|
||||
# Wait for processes to terminate
|
||||
sleep 3
|
||||
|
||||
# Shutdown and erase all simulators (ignore failures)
|
||||
xcrun simctl shutdown all 2>/dev/null || true
|
||||
sleep 5
|
||||
xcrun simctl erase all 2>/dev/null || true
|
||||
|
||||
# If erase failed, try the nuclear option
|
||||
if xcrun simctl list devices | grep -q "Booted" 2>/dev/null; then
|
||||
echo "Standard reset failed, using nuclear option..."
|
||||
rm -rf ~/Library/Developer/CoreSimulator/Devices/* 2>/dev/null || true
|
||||
launchctl remove com.apple.CoreSimulator.CoreSimulatorService 2>/dev/null || true
|
||||
sleep 3
|
||||
fi
|
||||
|
||||
# Clean up additional directories
|
||||
rm -rf ~/Library/Developer/CoreSimulator/Caches/* 2>/dev/null || true
|
||||
rm -rf ~/Library/Logs/CoreSimulator/* 2>/dev/null || true
|
||||
rm -rf ~/Library/Developer/Xcode/DerivedData/* 2>/dev/null || true
|
||||
|
||||
echo "Simulator reset completed"
|
||||
timeout-minutes: 5
|
||||
continue-on-error: true
|
||||
|
||||
- name: Verify Simulator Reset
|
||||
if: steps.check-changes.outputs.has_changes == 'true' && steps.reset-simulators.outcome == 'success'
|
||||
run: |
|
||||
# Verify CoreSimulator service restarted
|
||||
pgrep -fl "CoreSimulator" || (echo "CoreSimulator service not running" && exit 1)
|
||||
|
||||
# Check simulator list is clean
|
||||
xcrun simctl list devices
|
||||
|
||||
# Verify simulator runtime paths exist and are writable
|
||||
test -d ~/Library/Developer/CoreSimulator/Devices || (echo "Simulator devices directory missing" && exit 1)
|
||||
touch ~/Library/Developer/CoreSimulator/Devices/test || (echo "Simulator devices directory not writable" && exit 1)
|
||||
rm ~/Library/Developer/CoreSimulator/Devices/test
|
||||
timeout-minutes: 5
|
||||
|
||||
- name: Diagnose Simulator Reset Failure
|
||||
if: steps.check-changes.outputs.has_changes == 'true' && steps.reset-simulators.outcome == 'failure'
|
||||
run: |
|
||||
echo "Simulator reset failed. Collecting diagnostic information..."
|
||||
xcrun simctl list
|
||||
echo "Checking simulator logs..."
|
||||
ls -la ~/Library/Logs/CoreSimulator/ || echo "No simulator logs found"
|
||||
|
||||
- name: Save Homebrew Cache
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: |
|
||||
/opt/homebrew
|
||||
~/Library/Caches/Homebrew
|
||||
key: nrwl-nx-homebrew-packages
|
||||
|
||||
- name: Get pnpm store directory
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
id: pnpm-cache-macos
|
||||
run: echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache pnpm store
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: ${{ steps.pnpm-cache-macos.outputs.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Install project dependencies
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
run: |
|
||||
pnpm install --frozen-lockfile
|
||||
pnpm playwright install --with-deps
|
||||
|
||||
- name: Restore .NET packages
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
run: dotnet restore nx.sln
|
||||
|
||||
- name: Run E2E Tests for macOS
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
run: |
|
||||
pnpm nx affected -t e2e-macos-local --parallel=1 --base=$NX_BASE --head=$NX_HEAD
|
||||
@@ -0,0 +1,114 @@
|
||||
# For most projects, this workflow file will not need changing; you simply need
|
||||
# to commit it to your repository.
|
||||
#
|
||||
# You may wish to alter this file to override the set of languages analyzed,
|
||||
# or to provide custom queries or build logic.
|
||||
#
|
||||
# ******** NOTE ********
|
||||
# We have attempted to detect the languages in your repository. Please check
|
||||
# the `language` matrix defined below to confirm you have the correct set of
|
||||
# supported CodeQL languages.
|
||||
#
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
schedule:
|
||||
- cron: '20 14 * * 6'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze (${{ matrix.language }})
|
||||
# Runner size impacts CodeQL analysis time. To learn more, please see:
|
||||
# - https://gh.io/recommended-hardware-resources-for-running-codeql
|
||||
# - https://gh.io/supported-runners-and-hardware-resources
|
||||
# - https://gh.io/using-larger-runners (GitHub.com only)
|
||||
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
|
||||
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
|
||||
permissions:
|
||||
# required for all workflows
|
||||
security-events: write
|
||||
|
||||
# required to fetch internal or private CodeQL packs
|
||||
packages: read
|
||||
|
||||
# only required for workflows in private repositories
|
||||
actions: read
|
||||
contents: read
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- language: actions
|
||||
build-mode: none
|
||||
|
||||
# We would like to test our Java / Kotlin... but its currently failing. We can follow up.
|
||||
# - language: java-kotlin
|
||||
# build-mode: autobuild
|
||||
- language: javascript-typescript
|
||||
build-mode: none
|
||||
- language: rust
|
||||
build-mode: none
|
||||
- language: csharp
|
||||
build-mode: autobuild
|
||||
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
|
||||
# Use `c-cpp` to analyze code written in C, C++ or both
|
||||
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
|
||||
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
|
||||
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
|
||||
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
|
||||
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
|
||||
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- name: Setup Language Tooling
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
# Add any setup steps before running the `github/codeql-action/init` action.
|
||||
# This includes steps like installing compilers or runtimes (`actions/setup-node`
|
||||
# or others). This is typically only required for manual builds.
|
||||
# - name: Setup runtime (example)
|
||||
# uses: actions/setup-example@v1
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@15403aac29bd91419968e066cded66bde56b0283 # v3
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
build-mode: ${{ matrix.build-mode }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
|
||||
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
||||
# queries: security-extended,security-and-quality
|
||||
|
||||
# If the analyze step fails for one of the languages you are analyzing with
|
||||
# "We were unable to automatically build your code", modify the matrix above
|
||||
# to set the build mode to "manual" for that language. Then modify this step
|
||||
# to build your code.
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
||||
- if: matrix.build-mode == 'manual'
|
||||
shell: bash
|
||||
run: |
|
||||
echo 'If you are using a "manual" build mode for one or more of the' \
|
||||
'languages you are analyzing, replace this with the commands to build' \
|
||||
'your code, for example:'
|
||||
echo ' make bootstrap'
|
||||
echo ' make release'
|
||||
exit 1
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@15403aac29bd91419968e066cded66bde56b0283 # v3
|
||||
with:
|
||||
category: "/language:${{matrix.language}}"
|
||||
@@ -0,0 +1,111 @@
|
||||
# For most projects, this workflow file will not need changing; you simply need
|
||||
# to commit it to your repository.
|
||||
#
|
||||
# You may wish to alter this file to override the set of languages analyzed,
|
||||
# or to provide custom queries or build logic.
|
||||
#
|
||||
# ******** NOTE ********
|
||||
# We have attempted to detect the languages in your repository. Please check
|
||||
# the `language` matrix defined below to confirm you have the correct set of
|
||||
# supported CodeQL languages.
|
||||
#
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [ "**" ]
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze (${{ matrix.language }})
|
||||
# Runner size impacts CodeQL analysis time. To learn more, please see:
|
||||
# - https://gh.io/recommended-hardware-resources-for-running-codeql
|
||||
# - https://gh.io/supported-runners-and-hardware-resources
|
||||
# - https://gh.io/using-larger-runners (GitHub.com only)
|
||||
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
|
||||
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
|
||||
permissions:
|
||||
# required to fetch internal or private CodeQL packs
|
||||
packages: read
|
||||
|
||||
# only required for workflows in private repositories
|
||||
actions: read
|
||||
contents: read
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- language: actions
|
||||
build-mode: none
|
||||
|
||||
# See comment in @./codeql-master.yml about Java / Kotlin
|
||||
# - language: java-kotlin
|
||||
# build-mode: autobuild
|
||||
- language: javascript-typescript
|
||||
build-mode: none
|
||||
- language: rust
|
||||
build-mode: none
|
||||
- language: csharp
|
||||
build-mode: autobuild
|
||||
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
|
||||
# Use `c-cpp` to analyze code written in C, C++ or both
|
||||
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
|
||||
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
|
||||
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
|
||||
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
|
||||
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
|
||||
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- name: Setup Language Tooling
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
# Add any setup steps before running the `github/codeql-action/init` action.
|
||||
# This includes steps like installing compilers or runtimes (`actions/setup-node`
|
||||
# or others). This is typically only required for manual builds.
|
||||
# - name: Setup runtime (example)
|
||||
# uses: actions/setup-example@v1
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@15403aac29bd91419968e066cded66bde56b0283 # v3
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
build-mode: ${{ matrix.build-mode }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
|
||||
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
||||
# queries: security-extended,security-and-quality
|
||||
|
||||
# If the analyze step fails for one of the languages you are analyzing with
|
||||
# "We were unable to automatically build your code", modify the matrix above
|
||||
# to set the build mode to "manual" for that language. Then modify this step
|
||||
# to build your code.
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
||||
- if: matrix.build-mode == 'manual'
|
||||
shell: bash
|
||||
run: |
|
||||
echo 'If you are using a "manual" build mode for one or more of the' \
|
||||
'languages you are analyzing, replace this with the commands to build' \
|
||||
'your code, for example:'
|
||||
echo ' make bootstrap'
|
||||
echo ' make release'
|
||||
exit 1
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@15403aac29bd91419968e066cded66bde56b0283 # v3
|
||||
with:
|
||||
category: "/language:${{matrix.language}}"
|
||||
upload: 'never'
|
||||
upload-database: false
|
||||
@@ -0,0 +1,21 @@
|
||||
name: Unmergeable Labels Check
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [synchronize, opened, reopened, labeled, unlabeled]
|
||||
|
||||
jobs:
|
||||
do-not-merge:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
name: Prevent Merging
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check for label
|
||||
run: |
|
||||
echo "${{ toJSON(github.event.*.labels.*.name) }}"
|
||||
node -e 'const forbidden = ["target: next major version", "pr status: needs tests", "pr status: in-progress", "blocked: needs rebase", "pr status: do not merge"];
|
||||
const match = ${{ toJSON(github.event.*.labels.*.name) }}.find(l => forbidden.includes(l.toLowerCase()));
|
||||
if (match) {
|
||||
console.log("Cannot merge PRs that are labeled with " + match);
|
||||
process.exit(1)
|
||||
}'
|
||||
@@ -0,0 +1,510 @@
|
||||
name: E2E matrix
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 5 * * *'
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
debug_enabled:
|
||||
type: boolean
|
||||
description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
|
||||
required: false
|
||||
default: false
|
||||
|
||||
env:
|
||||
CYPRESS_CACHE_FOLDER: ${{ github.workspace }}/.cypress
|
||||
# Pin corepack to the pnpm version from packageManager. Without this, corepack
|
||||
# falls back to "latest" in directories that have no packageManager field
|
||||
# (e.g. e2e temp dirs), pulling pnpm 11 and breaking install.
|
||||
COREPACK_DEFAULT_TO_LATEST: '0'
|
||||
|
||||
permissions: {}
|
||||
jobs:
|
||||
preinstall:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
timeout-minutes: 20
|
||||
env:
|
||||
NODE_VERSION: ${{ matrix.node_version }}
|
||||
strategy:
|
||||
matrix:
|
||||
os:
|
||||
- ubuntu-latest
|
||||
- macos-latest
|
||||
# - windows-latest Windows fails to build gradle wrapper which always runs when we build nx.
|
||||
## https://staging.nx.app/runs/LgD4vxGn8w?utm_source=pull-request&utm_medium=comment
|
||||
node_version:
|
||||
- 22
|
||||
- 24
|
||||
- 26
|
||||
exclude:
|
||||
# macos skips the oldest node to keep the macos matrix slim
|
||||
- os: macos-latest
|
||||
node_version: 22
|
||||
# - os: windows-latest TODO(Jack): Windows fails to build gradle wrapper which always runs when we build nx. Re-enable when we fix this.
|
||||
# node_version: 22
|
||||
|
||||
name: Cache install (${{ matrix.os }}, node v${{ matrix.node_version }})
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
npm install -g corepack@latest
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Get pnpm store directory
|
||||
id: pnpm-cache
|
||||
run: echo "path=$(pnpm store path)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache pnpm store
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: ${{ steps.pnpm-cache.outputs.path }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Ensure Python setuptools Installed on Macos
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
id: brew-install-python-setuptools
|
||||
run: brew install python-setuptools
|
||||
|
||||
- name: Install pnpm packages
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Install Playwright
|
||||
run: pnpm playwright install --with-deps
|
||||
|
||||
- name: Restore .NET packages
|
||||
run: dotnet restore nx.sln
|
||||
|
||||
- name: Homebrew cache directory path
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
id: homebrew-cache-dir-path
|
||||
run: echo "dir=$(brew --cache)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache Homebrew
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
lookup-only: true
|
||||
path: ${{ steps.homebrew-cache-dir-path.outputs.dir }}
|
||||
key: brew-${{ matrix.node_version }}
|
||||
restore-keys: |
|
||||
brew-
|
||||
|
||||
- name: Cache Cypress
|
||||
id: cache-cypress
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
lookup-only: true
|
||||
path: '${{ github.workspace }}/.cypress'
|
||||
key: ${{ runner.os }}-cypress
|
||||
|
||||
- name: Install Cypress
|
||||
if: steps.cache-cypress.outputs.cache-hit != 'true'
|
||||
run: npx cypress install
|
||||
|
||||
prepare-matrix:
|
||||
name: Prepare matrix combinations
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
timeout-minutes: 5
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
matrix: ${{ steps.process-json.outputs.MATRIX }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Process matrix data
|
||||
id: process-json
|
||||
run: echo "MATRIX=$(npx tsx .github/workflows/nightly/process-matrix.ts | jq -c .)" >> $GITHUB_OUTPUT
|
||||
|
||||
e2e:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
needs:
|
||||
- preinstall
|
||||
- prepare-matrix
|
||||
permissions:
|
||||
contents: read
|
||||
runs-on: ${{ matrix.os }}
|
||||
timeout-minutes: 200 # <- cap each job to 200 minutes
|
||||
env:
|
||||
NODE_VERSION: ${{ matrix.node_version }}
|
||||
strategy:
|
||||
matrix: ${{fromJson(needs.prepare-matrix.outputs.matrix)}} # Load matrix from previous job
|
||||
fail-fast: false
|
||||
|
||||
name: ${{ matrix.os_name }}/${{ matrix.package_manager }}/${{ matrix.node_version }} ${{ join(matrix.project) }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Prepare dir for output
|
||||
run: mkdir -p outputs
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
npm install -g corepack@latest
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Install pnpm packages
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Install Playwright
|
||||
run: pnpm playwright install --with-deps
|
||||
|
||||
- name: Restore .NET packages
|
||||
run: dotnet restore nx.sln
|
||||
|
||||
- name: Cleanup
|
||||
if: ${{ matrix.os == 'ubuntu-latest' }}
|
||||
run: |
|
||||
# Workaround to provide additional free space for testing.
|
||||
# https://github.com/actions/virtual-environments/issues/2840
|
||||
sudo rm -rf /usr/share/dotnet
|
||||
sudo rm -rf /opt/ghc
|
||||
sudo rm -rf '/usr/local/share/boost'
|
||||
sudo rm -rf "$AGENT_TOOLSDIRECTORY"
|
||||
sudo apt-get install lsof
|
||||
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
|
||||
|
||||
- name: Homebrew cache directory path
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
id: homebrew-cache-dir-path
|
||||
run: echo "dir=$(brew --cache)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Cache Homebrew
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: ${{ steps.homebrew-cache-dir-path.outputs.dir }}
|
||||
key: brew-${{ matrix.node_version }}
|
||||
restore-keys: |
|
||||
brew-
|
||||
|
||||
- name: Cache Cypress
|
||||
id: cache-cypress
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: '${{ github.workspace }}/.cypress'
|
||||
key: ${{ runner.os }}-cypress
|
||||
|
||||
- name: Install Cypress
|
||||
if: steps.cache-cypress.outputs.cache-hit != 'true'
|
||||
run: npx cypress install
|
||||
|
||||
- name: Configure Detox Environment, Install applesimutils
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
run: |
|
||||
# Ensure Xcode command line tools are installed and configured
|
||||
xcode-select --print-path || sudo xcode-select --reset
|
||||
sudo xcode-select -s /Applications/Xcode.app
|
||||
|
||||
# Install or update applesimutils with error handling
|
||||
if ! brew list applesimutils &>/dev/null; then
|
||||
echo 'Installing applesimutils...'
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew tap wix/brew >/dev/null
|
||||
# Homebrew now refuses to load formulae from third-party taps unless trusted
|
||||
brew trust wix/brew
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils >/dev/null || {
|
||||
echo 'Failed to install applesimutils, retrying with update...'
|
||||
brew update
|
||||
brew trust wix/brew
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils
|
||||
}
|
||||
else
|
||||
echo 'Updating applesimutils...'
|
||||
HOMEBREW_NO_AUTO_UPDATE=1 brew upgrade applesimutils || true
|
||||
fi
|
||||
|
||||
# Verify applesimutils installation
|
||||
applesimutils --version || (echo 'applesimutils installation failed' && exit 1)
|
||||
|
||||
# Configure environment for M-series Mac
|
||||
echo 'DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer' >> $GITHUB_ENV
|
||||
echo 'PLATFORM_NAME=iOS Simulator' >> $GITHUB_ENV
|
||||
|
||||
# Set additional environment variables for better debugging
|
||||
echo 'DETOX_DISABLE_TELEMETRY=1' >> $GITHUB_ENV
|
||||
echo 'DETOX_LOG_LEVEL=trace' >> $GITHUB_ENV
|
||||
|
||||
# Verify Xcode installation
|
||||
xcodebuild -version
|
||||
|
||||
timeout-minutes: 10
|
||||
continue-on-error: false
|
||||
|
||||
- name: Reset iOS Simulators
|
||||
if: ${{ matrix.os == 'macos-latest' }}
|
||||
id: reset-simulators
|
||||
run: |
|
||||
echo 'Resetting iOS Simulators...'
|
||||
|
||||
# Kill simulator processes
|
||||
sudo killall -9 com.apple.CoreSimulator.CoreSimulatorService 2>/dev/null || true
|
||||
killall 'Simulator' 2>/dev/null || true
|
||||
killall 'iOS Simulator' 2>/dev/null || true
|
||||
|
||||
# Wait for processes to terminate
|
||||
sleep 3
|
||||
|
||||
# Shutdown and erase all simulators (ignore failures)
|
||||
xcrun simctl shutdown all 2>/dev/null || true
|
||||
sleep 5
|
||||
xcrun simctl erase all 2>/dev/null || true
|
||||
|
||||
# If erase failed, try the nuclear option
|
||||
if xcrun simctl list devices | grep -q 'Booted' 2>/dev/null; then
|
||||
echo 'Standard reset failed, using nuclear option...'
|
||||
rm -rf ~/Library/Developer/CoreSimulator/Devices/* 2>/dev/null || true
|
||||
launchctl remove com.apple.CoreSimulator.CoreSimulatorService 2>/dev/null || true
|
||||
sleep 3
|
||||
fi
|
||||
|
||||
# Clean up additional directories
|
||||
rm -rf ~/Library/Developer/CoreSimulator/Caches/* 2>/dev/null || true
|
||||
rm -rf ~/Library/Logs/CoreSimulator/* 2>/dev/null || true
|
||||
rm -rf ~/Library/Developer/Xcode/DerivedData/* 2>/dev/null || true
|
||||
|
||||
echo 'Simulator reset completed'
|
||||
timeout-minutes: 5
|
||||
continue-on-error: true
|
||||
|
||||
- name: Verify Simulator Reset
|
||||
if: ${{ matrix.os == 'macos-latest' && steps.reset-simulators.outcome == 'success' }}
|
||||
run: |
|
||||
# Verify CoreSimulator service restarted
|
||||
pgrep -fl 'CoreSimulator' || (echo 'CoreSimulator service not running' && exit 1)
|
||||
|
||||
# Verify simulator runtime paths exist and are writable
|
||||
test -d ~/Library/Developer/CoreSimulator/Devices || (echo 'Simulator devices directory missing' && exit 1)
|
||||
touch ~/Library/Developer/CoreSimulator/Devices/test || (echo 'Simulator devices directory not writable' && exit 1)
|
||||
rm ~/Library/Developer/CoreSimulator/Devices/test
|
||||
timeout-minutes: 5
|
||||
|
||||
- name: Diagnose Simulator Reset Failure
|
||||
if: ${{ matrix.os == 'macos-latest' && steps.reset-simulators.outcome == 'failure' }}
|
||||
run: |
|
||||
echo 'Simulator reset failed. Collecting diagnostic information...'
|
||||
xcrun simctl list
|
||||
echo 'Checking simulator logs...'
|
||||
ls -la ~/Library/Logs/CoreSimulator/ || echo 'No simulator logs found'
|
||||
|
||||
- name: Configure git metadata (needed for lerna smoke tests)
|
||||
if: ${{ (matrix.os != 'macos-latest') || (matrix.os == 'macos-latest' && steps.reset-simulators.outcome == 'success') }}
|
||||
run: |
|
||||
git config --global user.email test@test.com
|
||||
git config --global user.name 'Test Test'
|
||||
|
||||
- name: Set starting timestamp
|
||||
if: ${{ (matrix.os != 'macos-latest') || (matrix.os == 'macos-latest' && steps.reset-simulators.outcome == 'success') }}
|
||||
id: before-e2e
|
||||
shell: bash
|
||||
run: |
|
||||
echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Run e2e tests with pnpm (Linux/Windows)
|
||||
id: e2e-run-pnpm
|
||||
if: ${{ matrix.os != 'macos-latest' }}
|
||||
run: pnpm nx run ${{ matrix.project }}:e2e-local
|
||||
shell: bash
|
||||
timeout-minutes: ${{ matrix.os_timeout }}
|
||||
env:
|
||||
NX_E2E_CI_CACHE_KEY: e2e-gha-${{ matrix.os }}-${{ matrix.node_version }}-${{ matrix.package_manager }}
|
||||
NX_DAEMON: 'true'
|
||||
NX_PERF_LOGGING: 'false'
|
||||
NX_E2E_VERBOSE_LOGGING: 'true'
|
||||
NX_NATIVE_LOGGING: 'false'
|
||||
NX_E2E_RUN_E2E: 'true'
|
||||
NX_CLOUD_NO_TIMEOUTS: 'true'
|
||||
NX_E2E_SKIP_GLOBAL_CLEANUP: 'true'
|
||||
NODE_OPTIONS: --max_old_space_size=8192
|
||||
SELECTED_PM: ${{ matrix.package_manager }}
|
||||
npm_config_registry: http://localhost:4872
|
||||
YARN_REGISTRY: http://localhost:4872
|
||||
CI: true
|
||||
|
||||
- name: Run e2e tests with npm (macOS)
|
||||
id: e2e-run-npm
|
||||
if: ${{ matrix.os == 'macos-latest' && steps.reset-simulators.outcome == 'success' }}
|
||||
run: |
|
||||
# Run the tests
|
||||
if [[ '${{ matrix.project }}' == 'e2e-detox' ]] || [[ '${{ matrix.project }}' == 'e2e-react-native' ]] || [[ '${{ matrix.project }}' == 'e2e-expo' ]]; then
|
||||
NX_E2E_VERBOSE_DEBUG=1 pnpm nx run ${{ matrix.project }}:e2e-macos-local
|
||||
else
|
||||
NX_E2E_VERBOSE_DEBUG=1 pnpm nx run ${{ matrix.project }}:e2e-local
|
||||
fi
|
||||
|
||||
env:
|
||||
NX_E2E_CI_CACHE_KEY: e2e-gha-${{ matrix.os }}-${{ matrix.node_version }}-${{ matrix.package_manager }}
|
||||
NX_PERF_LOGGING: 'false'
|
||||
NX_CI_EXECUTION_ENV: 'macos'
|
||||
NX_E2E_VERBOSE_LOGGING: 'true'
|
||||
NX_NATIVE_LOGGING: 'false'
|
||||
NX_E2E_RUN_E2E: 'true'
|
||||
NX_E2E_SKIP_GLOBAL_CLEANUP: 'true'
|
||||
NODE_OPTIONS: --max_old_space_size=8192
|
||||
SELECTED_PM: 'npm'
|
||||
npm_config_registry: http://localhost:4872
|
||||
YARN_REGISTRY: http://localhost:4872
|
||||
DEVELOPER_DIR: '/Applications/Xcode.app/Contents/Developer'
|
||||
CI: true
|
||||
|
||||
- name: Save matrix config in file
|
||||
if: ${{ always() }}
|
||||
id: save-matrix
|
||||
shell: bash
|
||||
run: |
|
||||
before=${{ steps.before-e2e.outputs.timestamp }}
|
||||
now=$(date +%s)
|
||||
delta=$(($now - $before))
|
||||
|
||||
# Determine the outcome based on which step ran
|
||||
outcome='${{ matrix.os == 'macos-latest' && steps.e2e-run-npm.outcome || steps.e2e-run-pnpm.outcome }}'
|
||||
|
||||
matrix=$((
|
||||
echo '${{ toJSON(matrix) }}'
|
||||
) | jq --argjson delta $delta -c '. + { "status": "'"$outcome"'", "duration": $delta }')
|
||||
echo "$matrix" > 'outputs/matrix.json'
|
||||
|
||||
- name: Upload matrix config
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
||||
if: ${{ always() }}
|
||||
with:
|
||||
name: ${{ matrix.os_name}}-${{ matrix.node_version}}-${{ matrix.package_manager}}-${{ matrix.project }}
|
||||
overwrite: true
|
||||
if-no-files-found: 'ignore'
|
||||
path: 'outputs/matrix.json'
|
||||
|
||||
- name: Setup tmate session
|
||||
if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled && failure() }}
|
||||
uses: mxschmitt/action-tmate@1fb8b1023602bf1fd0e2994d7f1e93015cb5bbec # v3.22
|
||||
timeout-minutes: 15
|
||||
with:
|
||||
sudo: ${{ matrix.os != 'windows-latest' }} # disable sudo for windows debugging
|
||||
|
||||
process-result:
|
||||
if: ${{ always() && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
runs-on: ubuntu-latest
|
||||
needs: e2e
|
||||
timeout-minutes: 15
|
||||
outputs:
|
||||
message: ${{ steps.process-json.outputs.slack_message }}
|
||||
proj_duration: ${{ steps.process-json.outputs.slack_proj_duration }}
|
||||
pm_duration: ${{ steps.process-json.outputs.slack_pm_duration }}
|
||||
codeowners: ${{ steps.process-json.outputs.codeowners }}
|
||||
has_golden_failures: ${{ steps.process-json.outputs.has_golden_failures }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
fetch-depth: 0
|
||||
filter: tree:0
|
||||
|
||||
- name: Prepare dir for output
|
||||
run: mkdir -p outputs
|
||||
|
||||
- name: Load outputs
|
||||
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
|
||||
with:
|
||||
path: outputs
|
||||
|
||||
- name: Join and stringify matrix configs
|
||||
id: combine-json
|
||||
run: |
|
||||
combined=$(jq -sc . outputs/*/matrix.json)
|
||||
echo "combined=$combined" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Process results and collect failure details
|
||||
id: process-json
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
echo '${{ steps.combine-json.outputs.combined }}' | npx tsx .github/workflows/nightly/process-result.ts
|
||||
|
||||
report-failure:
|
||||
if: ${{ always() && needs.process-result.outputs.has_golden_failures == 'true' && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
needs: process-result
|
||||
runs-on: ubuntu-latest
|
||||
name: Report failure
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- name: Send notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: 'failure'
|
||||
message_format: '${{ needs.process-result.outputs.message }}'
|
||||
notification_title: 'Golden Test Failure'
|
||||
footer: '<{run_url}|View Run> / Last commit <{commit_url}|{commit_sha}>'
|
||||
mention_groups: ${{ needs.process-result.outputs.codeowners }}
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
|
||||
report-success:
|
||||
if: ${{ always() && needs.process-result.outputs.has_golden_failures == 'false' && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
needs: process-result
|
||||
runs-on: ubuntu-latest
|
||||
name: Report status
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- name: Send notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: 'success'
|
||||
message_format: '${{ needs.process-result.outputs.message }}'
|
||||
notification_title: '✅ Golden Tests: All Passed!'
|
||||
footer: '<{run_url}|View Run> / Last commit <{commit_url}|{commit_sha}>'
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
|
||||
report-pm-time:
|
||||
if: ${{ always() && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
needs: process-result
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
name: Report duration per package manager
|
||||
steps:
|
||||
- name: Send notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: 'skipped'
|
||||
message_format: '${{ needs.process-result.outputs.pm_duration }}'
|
||||
notification_title: '⌛ Total duration per package manager (ubuntu only)'
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
|
||||
report-proj-time:
|
||||
if: ${{ always() && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
needs: process-result
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
name: Report duration per project
|
||||
steps:
|
||||
- name: Send notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: 'skipped'
|
||||
message_format: '${{ needs.process-result.outputs.proj_duration }}'
|
||||
notification_title: '⌛ E2E Project duration stats'
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
@@ -0,0 +1,57 @@
|
||||
name: Generate embeddings
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 5 * * 0,4" # sunday, thursday 5AM
|
||||
|
||||
jobs:
|
||||
cache-and-install:
|
||||
if: github.repository == 'nrwl/nx'
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: ['24']
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
with:
|
||||
node-version: '24'
|
||||
package-manager-cache: false
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@7088e561eb65bb68695d245aa206f005ef30921d # v4.1.0
|
||||
id: pnpm-install
|
||||
with:
|
||||
version: 11.2.2
|
||||
run_install: false
|
||||
|
||||
- name: Get pnpm store directory
|
||||
id: pnpm-cache
|
||||
shell: bash
|
||||
run: |
|
||||
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Setup pnpm cache
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --no-frozen-lockfile
|
||||
|
||||
- name: Build docs
|
||||
run: npx nx build astro-docs
|
||||
|
||||
- name: Run embeddings script
|
||||
run: node --import tsx tools/documentation/create-embeddings/src/main.mts --mode=astro
|
||||
env:
|
||||
NX_NEXT_PUBLIC_SUPABASE_URL: ${{ secrets.NX_NEXT_PUBLIC_SUPABASE_URL }}
|
||||
NX_SUPABASE_SERVICE_ROLE_KEY: ${{ secrets.NX_SUPABASE_SERVICE_ROLE_KEY }}
|
||||
NX_OPENAI_KEY: ${{ secrets.NX_OPENAI_KEY }}
|
||||
@@ -0,0 +1,69 @@
|
||||
name: Issue Statistics
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * 0"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
issues: read
|
||||
pull-requests: read
|
||||
|
||||
jobs:
|
||||
issues-report:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ubuntu-latest
|
||||
name: Report status
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- uses: pnpm/action-setup@7088e561eb65bb68695d245aa206f005ef30921d # v4.1.0
|
||||
with:
|
||||
version: 11.2.2
|
||||
|
||||
- name: Use Node.js ${{ matrix.node_version }}
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
with:
|
||||
node-version: '24'
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Cache node_modules
|
||||
id: cache-modules
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
lookup-only: true
|
||||
path: '**/node_modules'
|
||||
key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
|
||||
|
||||
- name: Install packages
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Download artifact
|
||||
id: download-artifact
|
||||
uses: dawidd6/action-download-artifact@268677152d06ba59fcec7a7f0b5d961b6ccd7e1e # v2 # Needed since we are downloading artifact from a different workflow run, official actions/download-artifact doesn't support this.
|
||||
with:
|
||||
name: cached-issue-data
|
||||
path: ${{ github.workspace }}/scripts/issues-scraper/cached
|
||||
search_artifacts: true
|
||||
allow_forks: false
|
||||
continue-on-error: true
|
||||
|
||||
- name: Collect Issue Data
|
||||
id: collect
|
||||
run: npx tsx ./scripts/issues-scraper/index.ts
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ github.token }}
|
||||
|
||||
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
||||
with:
|
||||
name: cached-issue-data
|
||||
path: ./scripts/issues-scraper/cached/data.json
|
||||
|
||||
- name: Send GitHub Action trigger data to Slack workflow
|
||||
id: slack
|
||||
uses: slackapi/slack-github-action@91efab103c0de0a537f72a35f6b8cda0ee76bf0a # v2.1.1
|
||||
with:
|
||||
webhook: ${{ secrets.SLACK_ISSUES_REPORT_URL }}
|
||||
webhook-type: incoming-webhook
|
||||
payload: ${{ steps.collect.outputs.SLACK_MESSAGE }}
|
||||
@@ -0,0 +1,31 @@
|
||||
name: "Lock Threads"
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * *" # Once a day, at midnight UTC
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: lock
|
||||
|
||||
jobs:
|
||||
action:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: dessant/lock-threads@6548363a2d763e3a4a3a0dc04ca4a10481d8e536 # v6.0.0
|
||||
id: lockthreads
|
||||
with:
|
||||
process-only: 'issues, prs'
|
||||
github-token: ${{ github.token }}
|
||||
issue-inactive-days: "30" # Lock issues after 30 days of being closed
|
||||
pr-inactive-days: "5" # Lock closed PRs after 5 days. This ensures that issues that stem from a PR are opened as issues, rather than comments on the recently merged PR.
|
||||
add-issue-labels: "outdated"
|
||||
issue-comment: >
|
||||
This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.
|
||||
pr-comment: >
|
||||
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.
|
||||
@@ -0,0 +1,415 @@
|
||||
import { exec } from 'child_process';
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
const MAX_CONCURRENCY = 8;
|
||||
|
||||
interface MatrixResult {
|
||||
project: string;
|
||||
codeowners: string;
|
||||
node_version: number | string;
|
||||
package_manager: string;
|
||||
os: string;
|
||||
os_name: string;
|
||||
os_timeout: number;
|
||||
is_golden?: boolean;
|
||||
status: 'success' | 'failure' | 'cancelled';
|
||||
duration: number;
|
||||
}
|
||||
|
||||
const REPO = process.env.GITHUB_REPOSITORY || 'nrwl/nx';
|
||||
const RUN_ID = process.env.GITHUB_RUN_ID || '0';
|
||||
|
||||
function gh(args: string): string {
|
||||
try {
|
||||
return execSync(`gh ${args}`, {
|
||||
encoding: 'utf-8',
|
||||
timeout: 60_000,
|
||||
maxBuffer: 10 * 1024 * 1024,
|
||||
stdio: ['pipe', 'pipe', 'pipe'],
|
||||
}).trim();
|
||||
} catch {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
function ghAsync(args: string): Promise<string> {
|
||||
return new Promise((resolve) => {
|
||||
exec(
|
||||
`gh ${args}`,
|
||||
{ encoding: 'utf-8', timeout: 60_000, maxBuffer: 10 * 1024 * 1024 },
|
||||
(err, stdout) => resolve(err ? '' : (stdout || '').trim())
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
async function ghParallel<T>(
|
||||
items: T[],
|
||||
fn: (item: T) => string,
|
||||
concurrency = MAX_CONCURRENCY
|
||||
): Promise<Map<T, string>> {
|
||||
const results = new Map<T, string>();
|
||||
const queue = [...items];
|
||||
|
||||
async function worker() {
|
||||
while (queue.length > 0) {
|
||||
const item = queue.shift()!;
|
||||
results.set(item, await ghAsync(fn(item)));
|
||||
}
|
||||
}
|
||||
|
||||
await Promise.all(
|
||||
Array.from({ length: Math.min(concurrency, items.length) }, () => worker())
|
||||
);
|
||||
return results;
|
||||
}
|
||||
|
||||
function extractJestBlocks(raw: string): string {
|
||||
const lines = raw
|
||||
.replace(/^\d{4}-\d{2}-\d{2}T[\d:.]+Z /gm, '')
|
||||
.replace(/\x1b\[[0-9;]*[a-zA-Z]/g, '')
|
||||
.split('\n');
|
||||
|
||||
const blocks: string[] = [];
|
||||
let capturing = false;
|
||||
for (const line of lines) {
|
||||
if (line.startsWith(' FAIL ')) capturing = true;
|
||||
if (capturing) blocks.push(line);
|
||||
if (line.startsWith('Ran all test suites')) capturing = false;
|
||||
}
|
||||
return blocks.slice(0, 50).join('\n');
|
||||
}
|
||||
|
||||
function extractTestFiles(block: string): string[] {
|
||||
const matches = block.match(/FAIL\s+\S+\s+(src\/[^\s]+\.test\.ts)/g) || [];
|
||||
return [...new Set(matches.map((m) => m.replace(/FAIL\s+\S+\s+/, '')))];
|
||||
}
|
||||
|
||||
// Extract a normalized error signature for a test file from a Jest block.
|
||||
// Used to distinguish different root causes for the same test file across runs.
|
||||
function extractErrorSignature(block: string, testFile: string): string {
|
||||
const lines = block.split('\n');
|
||||
let afterBullet = false;
|
||||
let inFile = false;
|
||||
for (const l of lines) {
|
||||
if (l.includes('FAIL') && l.includes(testFile)) { inFile = true; continue; }
|
||||
if (inFile && /●/.test(l)) { afterBullet = true; continue; }
|
||||
if (!inFile || !afterBullet) continue;
|
||||
const trimmed = l.trim();
|
||||
if (!trimmed) continue;
|
||||
// Skip generic "Command failed" and warnings — find the actual error
|
||||
if (/^Command failed:|^warning /i.test(trimmed)) continue;
|
||||
// Normalize dynamic parts
|
||||
return trimmed
|
||||
.replace(/\/tmp\/[^\s]+/g, '<tmpdir>')
|
||||
.replace(/\/Users\/[^\s]+/g, '<path>')
|
||||
.replace(/\/home\/[^\s]+/g, '<path>')
|
||||
.replace(/[a-z]+\d{5,}/gi, '<id>')
|
||||
.replace(/\d{4}-\d{2}-\d{2}T[\d:._Z-]+/g, '<ts>')
|
||||
.replace(/\d+\.\d+\.\d+/g, '<ver>')
|
||||
.trim();
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
// Extract signatures for all test files in a block
|
||||
function extractSignatures(
|
||||
block: string,
|
||||
testFiles: string[]
|
||||
): Map<string, string> {
|
||||
const sigs = new Map<string, string>();
|
||||
for (const tf of testFiles) {
|
||||
sigs.set(tf, extractErrorSignature(block, tf));
|
||||
}
|
||||
return sigs;
|
||||
}
|
||||
|
||||
function extractBlockForFile(fullBlock: string, testFile: string): string {
|
||||
const lines = fullBlock.split('\n');
|
||||
const result: string[] = [];
|
||||
let capturing = false;
|
||||
for (const line of lines) {
|
||||
if (line.includes('FAIL') && line.includes(testFile)) capturing = true;
|
||||
else if (capturing && line.match(/^ FAIL /)) capturing = false;
|
||||
if (capturing) result.push(line);
|
||||
}
|
||||
return result.slice(0, 20).join('\n');
|
||||
}
|
||||
|
||||
export interface JobLink {
|
||||
combo: string;
|
||||
url: string;
|
||||
}
|
||||
|
||||
export interface FailureDetailsResult {
|
||||
report: string;
|
||||
goldenJobLinks: Map<string, JobLink[]>; // project -> [{combo, url}]
|
||||
}
|
||||
|
||||
/**
|
||||
* Collects detailed failure information for golden projects.
|
||||
* Called by process-result.ts when golden failures exist.
|
||||
* Returns Slack mrkdwn report + job links for the summary section.
|
||||
*/
|
||||
export async function collectFailureDetails(
|
||||
combined: MatrixResult[],
|
||||
failedGoldenProjectNames: string[]
|
||||
): Promise<FailureDetailsResult> {
|
||||
const projectNames = failedGoldenProjectNames;
|
||||
if (projectNames.length === 0) {
|
||||
return { report: '', goldenJobLinks: new Map() };
|
||||
}
|
||||
|
||||
// Group failures by project for combo info
|
||||
const failuresByProject = new Map<string, MatrixResult[]>();
|
||||
for (const r of combined) {
|
||||
if (r.is_golden && (r.status === 'failure' || r.status === 'cancelled')) {
|
||||
if (!failuresByProject.has(r.project))
|
||||
failuresByProject.set(r.project, []);
|
||||
failuresByProject.get(r.project)!.push(r);
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1: Fetch failure logs (one per OS/PM combo per project)
|
||||
const failedJobsRaw = gh(
|
||||
`run view ${RUN_ID} --repo ${REPO} --json jobs --jq '[.jobs[] | select(.conclusion == "failure") | {id: .databaseId, name: .name, project: (.name | split(" ") | last), combo: (.name | split(" ")[0])}]'`
|
||||
);
|
||||
const failedJobs: Array<{
|
||||
id: number;
|
||||
name: string;
|
||||
project: string;
|
||||
combo: string;
|
||||
}> = failedJobsRaw ? JSON.parse(failedJobsRaw) : [];
|
||||
|
||||
const jobsToFetch: Array<{ id: number; project: string }> = [];
|
||||
for (const project of projectNames) {
|
||||
const seen = new Set<string>();
|
||||
for (const job of failedJobs.filter((j) => j.project === project)) {
|
||||
const key = job.combo.split('/').slice(0, 2).join('/');
|
||||
if (!seen.has(key)) {
|
||||
seen.add(key);
|
||||
jobsToFetch.push({ id: job.id, project: job.project });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const logResults = await ghParallel(
|
||||
jobsToFetch,
|
||||
(job) => `api repos/${REPO}/actions/jobs/${job.id}/logs`
|
||||
);
|
||||
|
||||
// Keep per-combo logs separate AND a merged block per project
|
||||
interface ComboLog {
|
||||
combo: string;
|
||||
block: string;
|
||||
testFiles: string[];
|
||||
signatures: Map<string, string>; // testFile -> error signature
|
||||
}
|
||||
const projectComboLogs = new Map<string, ComboLog[]>();
|
||||
const projectLogs = new Map<string, string>(); // merged block for backwards compat
|
||||
|
||||
for (const [job, raw] of logResults) {
|
||||
if (!raw) continue;
|
||||
const cleaned = raw
|
||||
.replace(/^\d{4}-\d{2}-\d{2}T[\d:.]+Z /gm, '')
|
||||
.replace(/\x1b\[[0-9;]*[a-zA-Z]/g, '');
|
||||
const block = extractJestBlocks(raw);
|
||||
const testFiles = extractTestFiles(cleaned);
|
||||
const sigs = extractSignatures(cleaned, testFiles);
|
||||
const combo =
|
||||
failedJobs.find((j) => j.id === job.id)?.combo || 'unknown';
|
||||
|
||||
if (!projectComboLogs.has(job.project))
|
||||
projectComboLogs.set(job.project, []);
|
||||
projectComboLogs.get(job.project)!.push({
|
||||
combo,
|
||||
block,
|
||||
testFiles,
|
||||
signatures: sigs,
|
||||
});
|
||||
|
||||
projectLogs.set(
|
||||
job.project,
|
||||
(projectLogs.get(job.project) || '') + '\n' + block
|
||||
);
|
||||
}
|
||||
|
||||
// Step 2: Build distinct failures per project — each (testFile, signature, combos) is a "failure"
|
||||
interface DistinctFailure {
|
||||
testFile: string;
|
||||
signature: string;
|
||||
combos: string[];
|
||||
block: string; // the Jest block from the first combo that has this signature
|
||||
}
|
||||
|
||||
const projectDistinctFailures = new Map<string, DistinctFailure[]>();
|
||||
for (const project of projectNames) {
|
||||
const comboLogs = projectComboLogs.get(project) || [];
|
||||
const seen = new Map<string, DistinctFailure>(); // "testFile|signature" -> failure
|
||||
|
||||
for (const cl of comboLogs) {
|
||||
for (const tf of cl.testFiles) {
|
||||
const sig = cl.signatures.get(tf) || '';
|
||||
const key = `${tf}|${sig}`;
|
||||
if (seen.has(key)) {
|
||||
seen.get(key)!.combos.push(cl.combo);
|
||||
} else {
|
||||
seen.set(key, {
|
||||
testFile: tf,
|
||||
signature: sig,
|
||||
combos: [cl.combo],
|
||||
block: extractBlockForFile(cl.block, tf),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
projectDistinctFailures.set(project, [...seen.values()]);
|
||||
}
|
||||
|
||||
// Step 3: Format report
|
||||
const lines: string[] = ['', '🔍 *Failure Details*', ''];
|
||||
|
||||
const sorted = [...projectNames].sort(
|
||||
(a, b) =>
|
||||
(failuresByProject.get(b)?.length || 0) -
|
||||
(failuresByProject.get(a)?.length || 0) || a.localeCompare(b)
|
||||
);
|
||||
|
||||
for (const project of sorted) {
|
||||
const projResults = failuresByProject.get(project) || [];
|
||||
const distinctFailures = projectDistinctFailures.get(project) || [];
|
||||
const block = projectLogs.get(project) || '';
|
||||
|
||||
const pms = [...new Set(projResults.map((r) => r.package_manager))];
|
||||
const pattern =
|
||||
pms.length === 1
|
||||
? `${pms[0]}-only`
|
||||
: pms.length >= 3
|
||||
? 'all PMs'
|
||||
: pms.join('+');
|
||||
|
||||
const uniqueCombos = [
|
||||
...new Set(
|
||||
failedJobs.filter((j) => j.project === project).map((j) => j.combo)
|
||||
),
|
||||
];
|
||||
|
||||
lines.push('———————————————————————————');
|
||||
lines.push(`*${project}* — ${projResults.length} combos (${pattern})`);
|
||||
lines.push('');
|
||||
|
||||
if (distinctFailures.length > 0) {
|
||||
for (const failure of distinctFailures) {
|
||||
const comboStr = failure.combos.join(', ');
|
||||
lines.push(`📋 \`${failure.testFile}\` (${comboStr})`);
|
||||
|
||||
if (failure.block) {
|
||||
lines.push('```');
|
||||
lines.push(failure.block);
|
||||
lines.push('```');
|
||||
}
|
||||
}
|
||||
|
||||
const summaryMatch = block.match(/^Test Suites:.*$/m);
|
||||
if (summaryMatch) lines.push(`_${summaryMatch[0]}_`);
|
||||
} else {
|
||||
// No Jest blocks — find which step failed and extract its error output
|
||||
const firstJob = failedJobs.find((j) => j.project === project);
|
||||
if (firstJob) {
|
||||
// Get the failed step name from the jobs API
|
||||
const stepsRaw = gh(
|
||||
`run view ${RUN_ID} --repo ${REPO} --json jobs --jq '[.jobs[] | select(.databaseId == ${firstJob.id})][0].steps[] | select(.conclusion == "failure") | .name'`
|
||||
);
|
||||
const failedStep = stepsRaw || 'unknown step';
|
||||
|
||||
// Get the log and extract error lines
|
||||
const raw = gh(`api repos/${REPO}/actions/jobs/${firstJob.id}/logs`);
|
||||
const cleaned = raw
|
||||
.split('\n')
|
||||
.map((l) => l.replace(/^\d{4}-\d{2}-\d{2}T[\d:.]+Z /, ''))
|
||||
.map((l) => l.replace(/\x1b\[[0-9;]*[a-zA-Z]/g, ''));
|
||||
|
||||
// Extract the failed Nx task output block (❌ > nx run <task> ... until next ##[group] or NX summary)
|
||||
const failedTaskBlock: string[] = [];
|
||||
let capturingTask = false;
|
||||
for (const l of cleaned) {
|
||||
if (/❌.*> nx run /i.test(l)) {
|
||||
capturingTask = true;
|
||||
failedTaskBlock.push(l);
|
||||
continue;
|
||||
}
|
||||
if (capturingTask) {
|
||||
if (/^##\[group\]|NX.*Running target/i.test(l) || failedTaskBlock.length >= 15) {
|
||||
capturingTask = false;
|
||||
} else {
|
||||
failedTaskBlock.push(l);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Extract the Nx failure summary block ("Running target...failed" + "Failed tasks:" + task list)
|
||||
const nxFailureBlock: string[] = [];
|
||||
let capturingNx = false;
|
||||
for (const l of cleaned) {
|
||||
if (/NX.*Running target.*failed/i.test(l)) capturingNx = true;
|
||||
if (capturingNx) {
|
||||
nxFailureBlock.push(l);
|
||||
if (/^Hint:/i.test(l.trim()) || nxFailureBlock.length >= 10) {
|
||||
capturingNx = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Fallback: if no Nx blocks or task blocks found, extract generic error lines
|
||||
let fallbackErrors: string[] = [];
|
||||
if (nxFailureBlock.length === 0 && failedTaskBlock.length === 0) {
|
||||
fallbackErrors = cleaned.filter((l) => {
|
||||
const t = l.trim();
|
||||
if (t.length < 10) return false;
|
||||
if (/warning|warn\b|deprecated|orphan|Node\.js 20|FORCE_JAVASCRIPT|\* \[new branch\]|\* \[new tag\]/i.test(t)) return false;
|
||||
return (
|
||||
/error TS\d+:|^Error:|^\s*error\b[:\s]|ERR!|ERESOLVE|##\[error\]/i.test(t) ||
|
||||
/Cannot find module|ENOENT|EACCES|permission denied/i.test(t) ||
|
||||
/Segmentation fault|killed|OOM|out of memory/i.test(t) ||
|
||||
/command not found|No such file or directory/i.test(t) ||
|
||||
/Process completed with exit code [^0]/i.test(t)
|
||||
);
|
||||
}).slice(0, 5);
|
||||
}
|
||||
|
||||
// Combine: Nx summary first, then task output, then fallback errors
|
||||
const relevantErrors = [
|
||||
...nxFailureBlock,
|
||||
...(failedTaskBlock.length > 0 ? ['', ...failedTaskBlock] : []),
|
||||
...(fallbackErrors.length > 0 ? ['', ...fallbackErrors] : []),
|
||||
];
|
||||
|
||||
lines.push(`⚠️ Tests did not run — failed at step: *${failedStep}*`);
|
||||
if (relevantErrors.length > 0) {
|
||||
lines.push('```');
|
||||
lines.push(relevantErrors.join('\n'));
|
||||
lines.push('```');
|
||||
}
|
||||
lines.push(`Failing combos: ${uniqueCombos.join(', ')}`);
|
||||
} else {
|
||||
lines.push('⏱️ No job data available');
|
||||
}
|
||||
}
|
||||
lines.push('');
|
||||
}
|
||||
|
||||
// Build job links for the summary section
|
||||
const runUrl = `https://github.com/${REPO}/actions/runs/${RUN_ID}`;
|
||||
const goldenJobLinks = new Map<string, JobLink[]>();
|
||||
for (const project of projectNames) {
|
||||
const projectJobs = failedJobs.filter((j) => j.project === project);
|
||||
goldenJobLinks.set(
|
||||
project,
|
||||
projectJobs.map((j) => ({
|
||||
combo: j.combo,
|
||||
url: `${runUrl}/job/${j.id}`,
|
||||
}))
|
||||
);
|
||||
}
|
||||
|
||||
return { report: lines.join('\n'), goldenJobLinks };
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
type MatrixDataProject = {
|
||||
name: string,
|
||||
codeowners: string,
|
||||
is_golden?: boolean, // true if this is a golden project, false otherwise
|
||||
};
|
||||
|
||||
type MatrixDataOS = {
|
||||
os: string, // GH runner machine name: e.g. ubuntu-latest
|
||||
os_name: string, // short name that will be printed in the report and on the action
|
||||
os_timeout: number, // 60
|
||||
package_managers: string[], // package managers to run on this OS
|
||||
node_versions: Array<number | string>, // node versions to run on this OS
|
||||
excluded?: string[], // projects to exclude from running on this OS
|
||||
};
|
||||
|
||||
type MatrixData = {
|
||||
coreProjects: MatrixDataProject[],
|
||||
projects: MatrixDataProject[],
|
||||
lowestNodeLTS: number,
|
||||
setup: MatrixDataOS[],
|
||||
}
|
||||
|
||||
export type MatrixItem = {
|
||||
project: string,
|
||||
codeowners: string,
|
||||
node_version: number | string,
|
||||
package_manager: string,
|
||||
os: string,
|
||||
os_name: string,
|
||||
os_timeout: number,
|
||||
is_golden?: boolean,
|
||||
};
|
||||
|
||||
// TODO: Extract Slack groups into named groups for easier maintenance
|
||||
const matrixData: MatrixData = {
|
||||
coreProjects: [
|
||||
{ name: 'e2e-lerna-smoke-tests', codeowners: 'S04TNCVEETS', is_golden: true },
|
||||
{ name: 'e2e-js', codeowners: 'S04SJ6HHP0X', is_golden: true },
|
||||
{ name: 'e2e-nx-init', codeowners: 'S04SYHYKGNP', is_golden: true },
|
||||
{ name: 'e2e-nx', codeowners: 'S04SYHYKGNP' },
|
||||
{ name: 'e2e-release', codeowners: 'S04SYHYKGNP' },
|
||||
{ name: 'e2e-workspace-create', codeowners: 'S04SYHYKGNP' }
|
||||
],
|
||||
projects: [
|
||||
{ name: 'e2e-cypress', codeowners: 'S04T16BTJJY', is_golden: true },
|
||||
{ name: 'e2e-docker', codeowners: 'S04SJ6HHP0X', is_golden: true },
|
||||
{ name: 'e2e-detox', codeowners: 'S04TNCNJG5N', is_golden: true },
|
||||
{ name: 'e2e-esbuild', codeowners: 'S04SJ6HHP0X', is_golden: true },
|
||||
{ name: 'e2e-gradle', codeowners: 'S04TNCNJG5N', is_golden: true },
|
||||
{ name: 'e2e-eslint', codeowners: 'S04SYJGKSCT', is_golden: true },
|
||||
{ name: 'e2e-node', codeowners: 'S04SJ6HHP0X', is_golden: true },
|
||||
{ name: 'e2e-playwright', codeowners: 'S04SVQ8H0G5', is_golden: true },
|
||||
{ name: 'e2e-remix', codeowners: 'S04SVQ8H0G5', is_golden: true },
|
||||
{ name: 'e2e-rspack', codeowners: 'S04SJ6HHP0X', is_golden: true },
|
||||
{ name: 'e2e-vite', codeowners: 'S04SJ6PL98X', is_golden: true },
|
||||
{ name: 'e2e-vue', codeowners: 'S04SJ6PL98X', is_golden: true },
|
||||
{ name: 'e2e-web', codeowners: 'S04SJ6PL98X', is_golden: true },
|
||||
{ name: 'e2e-webpack', codeowners: 'S04SJ6PL98X', is_golden: true },
|
||||
{ name: 'e2e-jest', codeowners: 'S04T16BTJJY', is_golden: true },
|
||||
{ name: 'e2e-expo', codeowners: 'S04TNCNJG5N', is_golden: true },
|
||||
{ name: 'e2e-react-native', codeowners: 'S04TNCNJG5N', is_golden: true },
|
||||
{ name: 'e2e-angular', codeowners: 'S04SS457V38' },
|
||||
{ name: 'e2e-next', codeowners: 'S04TNCNJG5N' },
|
||||
{ name: 'e2e-plugin', codeowners: 'S04SYHYKGNP' },
|
||||
{ name: 'e2e-react', codeowners: 'S04TNCNJG5N' },
|
||||
{ name: 'e2e-rollup', codeowners: 'S04SJ6PL98X' },
|
||||
{ name: 'e2e-storybook', codeowners: 'S04SVQ8H0G5' },
|
||||
{ name: 'e2e-nuxt', codeowners: 'S04SJ6PL98X' }
|
||||
],
|
||||
// Non-core plugins only run on the lowest LTS. Plugin-level changes are
|
||||
// less Node-version-sensitive than core, so single-version coverage is enough.
|
||||
lowestNodeLTS: 22,
|
||||
setup: [
|
||||
{
|
||||
os: 'ubuntu-latest',
|
||||
os_name: 'Linux',
|
||||
os_timeout: 60,
|
||||
package_managers: ['npm', 'pnpm', 'yarn'],
|
||||
// TODO: re-add '26.0.0' once playwright ships the yauzl fix for node 26 extract hang.
|
||||
// See https://github.com/microsoft/playwright/issues/40724
|
||||
node_versions: ['22.13.0', '24.0.0'],
|
||||
excluded: ['e2e-detox', 'e2e-react-native', 'e2e-expo']
|
||||
},
|
||||
// Docker is not supported on ARM-based macOS runners (no nested virtualization)
|
||||
// See: https://github.com/docker/setup-docker-action and https://github.com/douglascamata/setup-docker-macos-action
|
||||
// We may want to look into adding intel only for this docker case, at least until vm-in-vm works on latest macos
|
||||
// TODO: re-add '26.0.0' once playwright ships the yauzl fix for node 26 extract hang.
|
||||
// See https://github.com/microsoft/playwright/issues/40724
|
||||
{ os: 'macos-latest', os_name: 'MacOS', os_timeout: 90, package_managers: ['npm'], node_versions: ['24.0.0'], excluded: ['e2e-docker'] }
|
||||
// TODO (Jack): Fix Windows support as gradle fails when running nx build https://staging.nx.app/runs/LgD4vxGn8w?utm_source=pull-request&utm_medium=comment
|
||||
// { os: 'windows-latest', os_name: 'WinOS', os_timeout: 180, package_managers: ['npm'], node_versions: ['24.0.0'], excluded: ['e2e-detox', 'e2e-react-native', 'e2e-expo'] }
|
||||
]
|
||||
};
|
||||
|
||||
const matrix: Array<MatrixItem> = [];
|
||||
|
||||
function addMatrixCombo(project: MatrixDataProject, nodeVersion: number | string, pm: number, os: number) {
|
||||
matrix.push({
|
||||
project: project.name,
|
||||
codeowners: project.codeowners,
|
||||
node_version: nodeVersion,
|
||||
package_manager: matrixData.setup[os].package_managers[pm],
|
||||
os: matrixData.setup[os].os,
|
||||
os_name: matrixData.setup[os].os_name,
|
||||
os_timeout: matrixData.setup[os].os_timeout,
|
||||
is_golden: !!project.is_golden // Mark golden projects as true, others as false
|
||||
});
|
||||
}
|
||||
|
||||
function processProject(project: MatrixDataProject, nodeVersion?: number) {
|
||||
for (let os = 0; os < matrixData.setup.length; os++) {
|
||||
for (let pm = 0; pm < matrixData.setup[os].package_managers.length; pm++) {
|
||||
if (!matrixData.setup[os].excluded || !matrixData.setup[os].excluded?.includes(project.name)) {
|
||||
if (nodeVersion) {
|
||||
addMatrixCombo(project, nodeVersion, pm, os);
|
||||
} else {
|
||||
for (let n = 0; n < matrixData.setup[os].node_versions.length; n++) {
|
||||
addMatrixCombo(project, matrixData.setup[os].node_versions[n], pm, os);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// process core projects
|
||||
for (let p = 0; p < matrixData.coreProjects.length; p++) {
|
||||
processProject(matrixData.coreProjects[p]);
|
||||
}
|
||||
// process other projects
|
||||
for (let p = 0; p < matrixData.projects.length; p++) {
|
||||
processProject(matrixData.projects[p], matrixData.lowestNodeLTS);
|
||||
}
|
||||
|
||||
if (matrix.length > 256) {
|
||||
throw new Error('You have exceeded the size of the matrix. GitHub allows only 256 jobs in a matrix. Found ${matrix.length} jobs.');
|
||||
}
|
||||
|
||||
// print result to stdout for pipeline to consume
|
||||
process.stdout.write(JSON.stringify({ include: matrix }, null, 0));
|
||||
@@ -0,0 +1,229 @@
|
||||
import * as fs from 'fs';
|
||||
import { MatrixItem } from './process-matrix';
|
||||
import { collectFailureDetails, JobLink } from './analyze-failures';
|
||||
|
||||
interface MatrixResult extends MatrixItem {
|
||||
status: 'success' | 'failure' | 'cancelled';
|
||||
duration: number;
|
||||
}
|
||||
|
||||
interface ProcessedResults {
|
||||
codeowners: string;
|
||||
slack_message: string;
|
||||
slack_proj_duration: string;
|
||||
slack_pm_duration: string;
|
||||
has_golden_failures: string;
|
||||
}
|
||||
|
||||
function trimSpace(res: string): string {
|
||||
return res.split('\n').map((l) => l.trim()).join('\n');
|
||||
}
|
||||
|
||||
function humanizeDuration(num: number): string {
|
||||
let res = '';
|
||||
const hours = Math.floor(num / 3600);
|
||||
if (hours) res += `${hours}h `;
|
||||
const mins = Math.floor((num % 3600) / 60);
|
||||
if (mins) res += `${mins}m `;
|
||||
const sec = num % 60;
|
||||
if (sec) res += `${sec}s`;
|
||||
return res;
|
||||
}
|
||||
|
||||
function processResults(combined: MatrixResult[]): ProcessedResults {
|
||||
const failedProjects = combined.filter(c => c.status === 'failure' || c.status === 'cancelled').sort((a, b) => a.project.localeCompare(b.project));
|
||||
const failedGoldenProjects = failedProjects.filter(c => c.is_golden);
|
||||
const hasGoldenFailures = failedGoldenProjects.length > 0;
|
||||
const codeowners = new Set<string>();
|
||||
failedGoldenProjects.forEach(c => codeowners.add(c.codeowners));
|
||||
|
||||
let result = '';
|
||||
|
||||
const allGoldenProjects = combined.filter(c => c.is_golden);
|
||||
const uniqueGoldenProjects = new Set(allGoldenProjects.map(c => c.project));
|
||||
const uniqueFailedGoldenProjects = new Set(failedGoldenProjects.map(c => c.project));
|
||||
const goldenPassingCount = uniqueGoldenProjects.size - uniqueFailedGoldenProjects.size;
|
||||
const goldenFailingCount = uniqueFailedGoldenProjects.size;
|
||||
|
||||
const allOtherProjects = combined.filter(c => !c.is_golden);
|
||||
const uniqueOtherProjects = new Set(allOtherProjects.map(c => c.project));
|
||||
const failedRegularProjects = failedProjects.filter(c => !c.is_golden);
|
||||
const uniqueFailedOtherProjects = new Set(failedRegularProjects.map(c => c.project));
|
||||
const otherPassingCount = uniqueOtherProjects.size - uniqueFailedOtherProjects.size;
|
||||
const otherFailingCount = uniqueFailedOtherProjects.size;
|
||||
|
||||
result += `\n🌟 *Golden Projects*`;
|
||||
result += `\n✅ Passing: ${goldenPassingCount} | ❌ Failing: ${goldenFailingCount}`;
|
||||
|
||||
if (failedGoldenProjects.length > 0) {
|
||||
result += `\n\n🚨 *Failed Golden Projects*`;
|
||||
// Project names listed here — combo links added later by main() with job data
|
||||
const seenProjects = new Set<string>();
|
||||
failedGoldenProjects.forEach(matrix => {
|
||||
if (!seenProjects.has(matrix.project)) {
|
||||
seenProjects.add(matrix.project);
|
||||
result += `\n\n*${matrix.project}*`;
|
||||
// Placeholder — main() will replace with linked combos
|
||||
result += `\n {{COMBOS:${matrix.project}}}`;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (otherFailingCount > 0) {
|
||||
const otherProjectCounts = new Map<string, number>();
|
||||
failedRegularProjects.forEach(m => {
|
||||
otherProjectCounts.set(m.project, (otherProjectCounts.get(m.project) || 0) + 1);
|
||||
});
|
||||
const otherSummary = [...otherProjectCounts.entries()]
|
||||
.map(([p, c]) => `${p} (${c})`)
|
||||
.join(', ');
|
||||
result += `\n\n⚠️ *Failed Other Projects:* ${otherSummary}`;
|
||||
}
|
||||
|
||||
if (failedProjects.length === 0) {
|
||||
result = '🎉 *No test failures detected!* All systems green! 🟢';
|
||||
}
|
||||
|
||||
const timeReport: Record<string, { min: number; max: number; minEnv: string; maxEnv: string }> = {};
|
||||
const pmReport = { npm: 0, yarn: 0, pnpm: 0 };
|
||||
const macosProjects = ['e2e-detox', 'e2e-expo', 'e2e-react-native'];
|
||||
|
||||
combined.forEach(matrix => {
|
||||
const nodeVersion = parseInt(matrix.node_version.toString());
|
||||
if (matrix.os_name === 'Linux' && nodeVersion === 20 && matrix.package_manager in pmReport) {
|
||||
pmReport[matrix.package_manager as keyof typeof pmReport] += matrix.duration;
|
||||
}
|
||||
if (matrix.os_name === 'Linux' || macosProjects.includes(matrix.project)) {
|
||||
if (timeReport[matrix.project]) {
|
||||
if (matrix.duration > timeReport[matrix.project].max) {
|
||||
timeReport[matrix.project].max = matrix.duration;
|
||||
timeReport[matrix.project].maxEnv = `${matrix.os_name}, ${matrix.package_manager}`;
|
||||
}
|
||||
if (matrix.duration < timeReport[matrix.project].min) {
|
||||
timeReport[matrix.project].min = matrix.duration;
|
||||
timeReport[matrix.project].minEnv = `${matrix.os_name}, ${matrix.package_manager}`;
|
||||
}
|
||||
} else {
|
||||
timeReport[matrix.project] = {
|
||||
min: matrix.duration,
|
||||
max: matrix.duration,
|
||||
minEnv: `${matrix.os_name}, ${matrix.package_manager}`,
|
||||
maxEnv: `${matrix.os_name}, ${matrix.package_manager}`,
|
||||
};
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
let resultPkg = `
|
||||
\`\`\`
|
||||
| Project | Time |
|
||||
|--------------------------------|---------------------------|`;
|
||||
|
||||
function mapProjectTime(proj: string, section: 'min' | 'max'): string {
|
||||
return `${humanizeDuration(timeReport[proj][section])} (${timeReport[proj][`${section}Env`]})`;
|
||||
}
|
||||
|
||||
function durationIcon(proj: string, section: 'min' | 'max'): string {
|
||||
const duration = timeReport[proj][section];
|
||||
if (duration < 12 * 60) return `${section} ✅`;
|
||||
if (duration < 15 * 60) return `${section} ❗`;
|
||||
return `${section} ❌`;
|
||||
}
|
||||
|
||||
Object.keys(timeReport).forEach(proj => {
|
||||
resultPkg += `\n| ${proj.padEnd(30)} | |`;
|
||||
resultPkg += `\n| ${durationIcon(proj, 'min').padStart(29)} | ${mapProjectTime(proj, 'min').padEnd(25)} |`;
|
||||
resultPkg += `\n| ${durationIcon(proj, 'max').padStart(29)} | ${mapProjectTime(proj, 'max').padEnd(25)} |`;
|
||||
});
|
||||
resultPkg += `\`\`\``;
|
||||
|
||||
let resultPm = `
|
||||
\`\`\`
|
||||
| PM | Total time |
|
||||
|------|-------------|`;
|
||||
Object.keys(pmReport).forEach(pm => {
|
||||
resultPm += `\n| ${pm.padEnd(4)} | ${humanizeDuration(pmReport[pm as keyof typeof pmReport]).padEnd(11)} |`;
|
||||
});
|
||||
resultPm += `\`\`\``;
|
||||
|
||||
return {
|
||||
codeowners: Array.from(codeowners).join(','),
|
||||
slack_message: trimSpace(result),
|
||||
slack_proj_duration: trimSpace(resultPkg),
|
||||
slack_pm_duration: trimSpace(resultPm),
|
||||
has_golden_failures: hasGoldenFailures.toString(),
|
||||
};
|
||||
}
|
||||
|
||||
function setOutput(key: string, value: string) {
|
||||
const outputPath = process.env.GITHUB_OUTPUT;
|
||||
if (!outputPath) {
|
||||
console.warn(`GITHUB_OUTPUT not set. Skipping output for "${key}".`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (value.includes('\n')) {
|
||||
const delimiter = `EOF_${key}_${Date.now()}`;
|
||||
fs.appendFileSync(outputPath, `${key}<<${delimiter}\n${value}\n${delimiter}\n`);
|
||||
} else {
|
||||
fs.appendFileSync(outputPath, `${key}=${value}\n`);
|
||||
}
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const combinedInput = process.argv[2]
|
||||
? process.argv[2]
|
||||
: fs.readFileSync(0, 'utf-8').trim();
|
||||
|
||||
const combined: MatrixResult[] = JSON.parse(combinedInput);
|
||||
const results = processResults(combined);
|
||||
|
||||
// Collect detailed failure info if golden failures exist
|
||||
if (results.has_golden_failures === 'true') {
|
||||
try {
|
||||
const failedProjects = [
|
||||
...new Set(
|
||||
combined
|
||||
.filter((c) => c.is_golden && (c.status === 'failure' || c.status === 'cancelled'))
|
||||
.map((c) => c.project)
|
||||
),
|
||||
];
|
||||
const { report, goldenJobLinks } = await collectFailureDetails(combined, failedProjects);
|
||||
|
||||
// Replace combo placeholders in the summary with linked combos
|
||||
for (const [project, links] of goldenJobLinks) {
|
||||
const placeholder = `{{COMBOS:${project}}}`;
|
||||
const linkedCombos =
|
||||
links.length > 0
|
||||
? links.map((l) => ` · <${l.url}|${l.combo}>`).join('\n')
|
||||
: ' (no job data)';
|
||||
results.slack_message = results.slack_message.replace(
|
||||
placeholder,
|
||||
linkedCombos
|
||||
);
|
||||
}
|
||||
|
||||
// Remove any unreplaced placeholders (if collectFailureDetails didn't have data for a project)
|
||||
results.slack_message = results.slack_message.replace(
|
||||
/ \{\{COMBOS:[^}]+\}\}/g,
|
||||
' (no job data)'
|
||||
);
|
||||
|
||||
if (report) {
|
||||
results.slack_message += '\n\n' + report;
|
||||
}
|
||||
} catch (e) {
|
||||
console.error('Failed to collect failure details (brief report will still be posted):', e);
|
||||
results.slack_message += '\n\n⚠️ _Failed to collect detailed failure information_';
|
||||
}
|
||||
}
|
||||
|
||||
Object.entries(results).forEach(([key, value]) => {
|
||||
setOutput(key, value);
|
||||
});
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
console.error('Error processing results:', error);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,42 @@
|
||||
name: NPM Audit
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions: {}
|
||||
jobs:
|
||||
audit:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
permissions:
|
||||
contents: read # to fetch code (actions/checkout)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- uses: pnpm/action-setup@7088e561eb65bb68695d245aa206f005ef30921d # v4.1.0
|
||||
with:
|
||||
version: 11.2.2 # Aligned with root package.json (pnpm/action-setup will helpfully error if out of sync)
|
||||
|
||||
- name: Run a security audit
|
||||
run: pnpm dlx audit-ci --critical --report-type summary
|
||||
|
||||
report:
|
||||
if: ${{ always() && github.repository_owner == 'nrwl' && github.event_name != 'workflow_dispatch' }}
|
||||
needs: audit
|
||||
runs-on: ubuntu-latest
|
||||
name: Report status
|
||||
steps:
|
||||
- name: Send notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: ${{ needs.audit.result }}
|
||||
message_format: '{emoji} Audit has {status_message}'
|
||||
notification_title: '{workflow}'
|
||||
footer: '<{run_url}|View Run> / Last commit <{commit_url}|{commit_sha}>'
|
||||
mention_users: 'U01UELKLYF2,U9NPA6C90'
|
||||
mention_users_when: 'failure,warnings'
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
@@ -0,0 +1,30 @@
|
||||
name: PR Title Validation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, edited, synchronize, reopened]
|
||||
|
||||
permissions: read-all
|
||||
|
||||
jobs:
|
||||
validate-pr-title:
|
||||
name: Validate PR Title
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
# Ensure's validate-pr-title.js is the copy from master
|
||||
ref: master
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
with:
|
||||
node-version: 24
|
||||
package-manager-cache: false
|
||||
|
||||
- name: Validate PR title
|
||||
env:
|
||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||
PR_BODY: ${{ github.event.pull_request.body }}
|
||||
run: node ./scripts/validate-pr-title.js
|
||||
@@ -0,0 +1,714 @@
|
||||
name: publish
|
||||
|
||||
on:
|
||||
# Automated schedule - canary releases from master
|
||||
schedule:
|
||||
- cron: "0 19 * * 1-5" # Monday - Friday, at 19:00 UTC (7pm UTC)
|
||||
# Manual trigger - PR releases or dry-runs (based on workflow inputs)
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
pr:
|
||||
description: "PR Number - If set, a real release will be created for the branch associated with the given PR number. If blank, a dry-run of the currently selected branch will be performed."
|
||||
required: false
|
||||
type: number
|
||||
release:
|
||||
types: [ published ]
|
||||
|
||||
# Dynamically generate the display name for the GitHub UI based on the event type and inputs
|
||||
run-name: ${{ github.event.inputs.pr && format('PR Release for {0}', github.event.inputs.pr) || github.event_name == 'schedule' && 'Canary Release' || github.event_name == 'workflow_dispatch' && !github.event.inputs.pr && 'Release Dry-Run' || github.ref_name }}
|
||||
|
||||
env:
|
||||
DEBUG: napi:*
|
||||
NX_RUN_GROUP: ${{ github.run_id }}-${{ github.run_attempt }}
|
||||
CYPRESS_INSTALL_BINARY: 0
|
||||
NODE_VERSION: 26.3.0
|
||||
PNPM_VERSION: 11.2.2 # Aligned with root package.json (pnpm/action-setup will helpfully error if out of sync)
|
||||
NX_GRADLE_PROJECT_GRAPH_TIMEOUT: 600
|
||||
|
||||
jobs:
|
||||
# We first need to determine the version we are releasing, and if we need a custom repo or ref to use for the git checkout in subsequent steps.
|
||||
# These values depend upon the event type that triggered the workflow:
|
||||
#
|
||||
# - schedule:
|
||||
# - We are running a canary release which always comes from the master branch, we can use default ref resolution
|
||||
# in actions/checkout. The exact version will be generated within scripts/nx-release.ts.
|
||||
#
|
||||
# - release:
|
||||
# - We are running a full release which is based on the tag that triggered the release event, we can use default
|
||||
# ref resolution in actions/checkout. The exact version will be generated within scripts/nx-release.ts.
|
||||
#
|
||||
# - workflow_dispatch:
|
||||
# - We are either running a dry-run on the current branch, in which case the version will be static and we can use
|
||||
# default ref resolution in actions/checkout, or we are creating a PR release for the given PR number, in which case
|
||||
# we should generate an applicable version number within publish-resolve-data.js and use a custom ref of the PR branch name.
|
||||
resolve-required-data:
|
||||
name: Resolve Required Data
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
version: ${{ steps.script.outputs.version }}
|
||||
dry_run_flag: ${{ steps.script.outputs.dry_run_flag }}
|
||||
success_comment: ${{ steps.script.outputs.success_comment }}
|
||||
publish_branch: ${{ steps.script.outputs.publish_branch }}
|
||||
ref: ${{ steps.script.outputs.ref }}
|
||||
repo: ${{ steps.script.outputs.repo }}
|
||||
pr_number: ${{ steps.script.outputs.pr_number }}
|
||||
pr_author: ${{ steps.script.outputs.pr_author }}
|
||||
steps:
|
||||
# Default checkout on the triggering branch so that the latest publish-resolve-data.js script is available
|
||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
check-latest: true
|
||||
package-manager-cache: false
|
||||
|
||||
- name: Resolve and set checkout and version data to use for release
|
||||
id: script
|
||||
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
|
||||
env:
|
||||
PR_NUMBER: ${{ github.event.inputs.pr }}
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const script = require('${{ github.workspace }}/scripts/publish-resolve-data.js');
|
||||
await script({ github, context, core });
|
||||
|
||||
- name: (PR Release Only) Check out latest master
|
||||
if: ${{ steps.script.outputs.ref != '' }}
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
# Check out the latest master branch to get its copy of nx-release.ts
|
||||
repository: nrwl/nx
|
||||
ref: master
|
||||
path: latest-master-checkout
|
||||
|
||||
- name: (PR Release Only) Check out PR branch
|
||||
if: ${{ steps.script.outputs.ref != '' }}
|
||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
# Check out the PR branch to get its copy of nx-release.ts
|
||||
repository: ${{ steps.script.outputs.repo }}
|
||||
ref: ${{ steps.script.outputs.ref }}
|
||||
path: pr-branch-checkout
|
||||
|
||||
- name: (PR Release Only) Ensure that release scripts have not changed in the PR being released
|
||||
if: ${{ steps.script.outputs.ref != '' }}
|
||||
run: |
|
||||
# List of files that must not change in PR releases
|
||||
FILES_TO_CHECK=(
|
||||
"scripts/nx-release.ts"
|
||||
"scripts/publish-resolve-data.js"
|
||||
)
|
||||
|
||||
for FILE in "${FILES_TO_CHECK[@]}"; do
|
||||
if ! cmp -s "latest-master-checkout/$FILE" "pr-branch-checkout/$FILE"; then
|
||||
echo "🛑 Error: The file $FILE is different on the ${{ steps.script.outputs.ref }} branch on ${{ steps.script.outputs.repo }} vs latest master on nrwl/nx, cancelling workflow."
|
||||
echo "If you did not modify the file, then you likely just need to rebase/merge latest master."
|
||||
exit 1
|
||||
else
|
||||
echo "✅ The file $FILE is identical between the ${{ steps.script.outputs.ref }} branch on ${{ steps.script.outputs.repo }} and latest master on nrwl/nx."
|
||||
fi
|
||||
done
|
||||
|
||||
build:
|
||||
needs: [ resolve-required-data ]
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
settings:
|
||||
- host: macos-latest
|
||||
target: x86_64-apple-darwin
|
||||
setup: |-
|
||||
rustup target add x86_64-apple-darwin
|
||||
build: |
|
||||
pnpm nx run-many --target=build-native -- --target=x86_64-apple-darwin
|
||||
- host: windows-latest
|
||||
setup: |-
|
||||
choco install openjdk --version=21.0.0 -y
|
||||
choco install dotnet-9.0-sdk -y
|
||||
rustup target add aarch64-pc-windows-msvc
|
||||
build: |
|
||||
export JAVA_HOME="C:\Program Files\OpenJDK\jdk-21"
|
||||
export PATH="$JAVA_HOME\bin:$PATH"
|
||||
java -version
|
||||
pnpm nx run-many --target=build-native -- --target=x86_64-pc-windows-msvc
|
||||
target: x86_64-pc-windows-msvc
|
||||
# Windows 32bit (not needed)
|
||||
# - host: windows-latest
|
||||
# build: |
|
||||
# yarn nx -- run-many --target=build-native -- --target=i686-pc-windows-msvc
|
||||
# target: i686-pc-windows-msvc
|
||||
- host: ubuntu-latest
|
||||
target: x86_64-unknown-linux-gnu
|
||||
docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
|
||||
build: |
|
||||
set -e
|
||||
apt-get update
|
||||
apt-get install -y curl ca-certificates git xz-utils gpg
|
||||
|
||||
# Install mise from the signed apt repo
|
||||
install -dm 755 /etc/apt/keyrings
|
||||
curl -fsSL https://mise.jdx.dev/gpg-key.pub | gpg --dearmor -o /etc/apt/keyrings/mise-archive-keyring.gpg
|
||||
echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=$(dpkg --print-architecture)] https://mise.jdx.dev/deb stable main" > /etc/apt/sources.list.d/mise.list
|
||||
apt-get update
|
||||
apt-get install -y mise
|
||||
|
||||
# Provision Node, Java, .NET, Maven, corepack from mise.toml
|
||||
cd /build
|
||||
mise trust mise.toml
|
||||
mise install
|
||||
eval "$(mise env -s bash)"
|
||||
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
pnpm install --frozen-lockfile
|
||||
rustup target add x86_64-unknown-linux-gnu
|
||||
pnpm nx run-many --verbose --target=build-native -- --target=x86_64-unknown-linux-gnu
|
||||
- host: ubuntu-latest
|
||||
target: x86_64-unknown-linux-musl
|
||||
docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
|
||||
build: |
|
||||
bash -c "
|
||||
set -e
|
||||
# mise's core node/java backends don't ship musl binaries and fall back to
|
||||
# compile-from-source on Alpine, which fails. Install via apk + tarball instead.
|
||||
echo 'https://dl-cdn.alpinelinux.org/alpine/edge/community' >> /etc/apk/repositories
|
||||
apk add --no-cache curl xz openjdk21 build-base lld dotnet9-sdk
|
||||
|
||||
# Java 21
|
||||
export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
|
||||
export PATH=\"\$JAVA_HOME/bin:\$PATH\"
|
||||
java --version
|
||||
|
||||
# .NET 9 SDK (needed by @nx/dotnet plugin)
|
||||
dotnet --version
|
||||
|
||||
# Node.js musl build from unofficial-builds.nodejs.org
|
||||
curl -fsSL https://unofficial-builds.nodejs.org/download/release/v\${NODE_VERSION}/node-v\${NODE_VERSION}-linux-x64-musl.tar.xz -o node.tar.xz
|
||||
tar -xJf node.tar.xz
|
||||
mv node-v\${NODE_VERSION}-linux-x64-musl /usr/local/node
|
||||
export PATH=\"/usr/local/node/bin:\$PATH\"
|
||||
node --version
|
||||
|
||||
npm i -g pnpm@\${PNPM_VERSION} --force
|
||||
|
||||
# Help clang find GCC runtime (crtbeginS.o, libgcc) and use lld for jemalloc build
|
||||
GCC_DIR=\$(dirname \$(find /usr/lib/gcc -name crtbeginS.o | head -1))
|
||||
export CFLAGS=\"\${CFLAGS} -fuse-ld=lld --gcc-install-dir=\${GCC_DIR}\"
|
||||
|
||||
pnpm install --frozen-lockfile
|
||||
rustup target add x86_64-unknown-linux-musl
|
||||
pnpm nx run-many --verbose --target=build-native -- --target=x86_64-unknown-linux-musl
|
||||
"
|
||||
- host: macos-latest
|
||||
target: aarch64-apple-darwin
|
||||
setup: |-
|
||||
rustup target add aarch64-apple-darwin
|
||||
build: |
|
||||
sudo rm -Rf /Library/Developer/CommandLineTools/SDKs/*;
|
||||
export CC=$(xcrun -f clang);
|
||||
export CXX=$(xcrun -f clang++);
|
||||
SYSROOT=$(xcrun --sdk macosx --show-sdk-path);
|
||||
export CFLAGS="-isysroot $SYSROOT -isystem $SYSROOT";
|
||||
pnpm nx run-many --target=build-native -- --target=aarch64-apple-darwin
|
||||
- host: ubuntu-latest
|
||||
target: aarch64-unknown-linux-gnu
|
||||
docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian-aarch64
|
||||
build: |
|
||||
set -e
|
||||
apt-get update
|
||||
apt-get install -y curl ca-certificates git xz-utils gpg
|
||||
|
||||
# Install mise from the signed apt repo
|
||||
install -dm 755 /etc/apt/keyrings
|
||||
curl -fsSL https://mise.jdx.dev/gpg-key.pub | gpg --dearmor -o /etc/apt/keyrings/mise-archive-keyring.gpg
|
||||
echo "deb [signed-by=/etc/apt/keyrings/mise-archive-keyring.gpg arch=$(dpkg --print-architecture)] https://mise.jdx.dev/deb stable main" > /etc/apt/sources.list.d/mise.list
|
||||
apt-get update
|
||||
apt-get install -y mise
|
||||
|
||||
# Provision Node, Java, .NET, Maven, corepack from mise.toml
|
||||
cd /build
|
||||
mise trust mise.toml
|
||||
mise install
|
||||
eval "$(mise env -s bash)"
|
||||
|
||||
# Help clang find GCC runtime (crtbeginS.o, libgcc) and use lld for jemalloc build
|
||||
export CFLAGS="${CFLAGS} -fuse-ld=lld --gcc-toolchain=/usr/aarch64-unknown-linux-gnu"
|
||||
|
||||
# Build jemalloc with 64 KiB allocator page so the binary works on aarch64
|
||||
# Linux kernels with 4K/16K/64K pages (Asahi, Ampere, Graviton, etc.).
|
||||
export JEMALLOC_SYS_WITH_LG_PAGE=16
|
||||
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
pnpm install --frozen-lockfile
|
||||
rustup target add aarch64-unknown-linux-gnu
|
||||
pnpm nx run-many --verbose --target=build-native -- --target=aarch64-unknown-linux-gnu
|
||||
- host: ubuntu-latest
|
||||
target: armv7-unknown-linux-gnueabihf
|
||||
setup: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install gcc-arm-linux-gnueabihf -y
|
||||
rustup target add armv7-unknown-linux-gnueabihf
|
||||
build: |
|
||||
CARGO_TARGET_ARMV7_UNKNOWN_LINUX_GNUEABIHF_LINKER=/usr/bin/arm-linux-gnueabihf-gcc pnpm nx run-many --target=build-native -- --target=armv7-unknown-linux-gnueabihf
|
||||
# Android (not needed)
|
||||
# - host: ubuntu-latest
|
||||
# target: aarch64-linux-android
|
||||
# build: |
|
||||
# pnpm nx run-many --target=build-native -- --target=aarch64-linux-android
|
||||
# - host: ubuntu-latest
|
||||
# target: armv7-linux-androideabi
|
||||
# build: |
|
||||
# pnpm nx run-many --target=build-native -- --target=armv7-linux-androideabi
|
||||
- host: ubuntu-latest
|
||||
target: aarch64-unknown-linux-musl
|
||||
docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
|
||||
build: |
|
||||
bash -c "
|
||||
set -e
|
||||
# mise's core node/java backends don't ship musl binaries and fall back to
|
||||
# compile-from-source on Alpine, which fails. Install via apk + tarball instead.
|
||||
echo 'https://dl-cdn.alpinelinux.org/alpine/edge/community' >> /etc/apk/repositories
|
||||
apk add --no-cache curl xz openjdk21 build-base lld dotnet9-sdk
|
||||
|
||||
# Java 21
|
||||
export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
|
||||
export PATH=\"\$JAVA_HOME/bin:\$PATH\"
|
||||
java --version
|
||||
|
||||
# .NET 9 SDK (needed by @nx/dotnet plugin)
|
||||
dotnet --version
|
||||
|
||||
# Node.js musl build from unofficial-builds.nodejs.org. Container is x64;
|
||||
# rust cross-compiles to aarch64-unknown-linux-musl, so the host node binary
|
||||
# is x64-musl regardless of the build target.
|
||||
curl -fsSL https://unofficial-builds.nodejs.org/download/release/v\${NODE_VERSION}/node-v\${NODE_VERSION}-linux-x64-musl.tar.xz -o node.tar.xz
|
||||
tar -xJf node.tar.xz
|
||||
mv node-v\${NODE_VERSION}-linux-x64-musl /usr/local/node
|
||||
export PATH=\"/usr/local/node/bin:\$PATH\"
|
||||
node --version
|
||||
|
||||
npm i -g pnpm@\${PNPM_VERSION} --force
|
||||
|
||||
# Help clang find GCC runtime (crtbeginS.o, libgcc) and use lld for jemalloc build
|
||||
GCC_DIR=\$(dirname \$(find /aarch64-linux-musl-cross/lib/gcc -name crtbeginS.o | head -1))
|
||||
export CFLAGS=\"\${CFLAGS} -fuse-ld=lld --gcc-install-dir=\${GCC_DIR}\"
|
||||
|
||||
# Build jemalloc with 64 KiB allocator page so the binary works on aarch64
|
||||
# Linux kernels with 4K/16K/64K pages (Asahi, Ampere, Graviton, etc.).
|
||||
export JEMALLOC_SYS_WITH_LG_PAGE=16
|
||||
|
||||
pnpm install --frozen-lockfile
|
||||
rustup target add aarch64-unknown-linux-musl
|
||||
pnpm nx run-many --verbose --target=build-native -- --target=aarch64-unknown-linux-musl
|
||||
"
|
||||
- host: windows-latest
|
||||
target: aarch64-pc-windows-msvc
|
||||
setup: |-
|
||||
choco install openjdk --version=21.0.0 -y
|
||||
choco install dotnet-9.0-sdk -y
|
||||
rustup target add aarch64-pc-windows-msvc
|
||||
build: |
|
||||
export JAVA_HOME="C:\Program Files\OpenJDK\jdk-21"
|
||||
export PATH="$JAVA_HOME\bin:$PATH"
|
||||
java -version
|
||||
pnpm nx run-many --target=build-native -- --target=aarch64-pc-windows-msvc
|
||||
name: stable - ${{ matrix.settings.target }} - node@26.3.0
|
||||
runs-on: ${{ matrix.settings.host }}
|
||||
steps:
|
||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
repository: ${{ needs.resolve-required-data.outputs.repo || github.repository }}
|
||||
ref: ${{ needs.resolve-required-data.outputs.ref || github.ref }}
|
||||
|
||||
- name: Set verbose logging from debug mode
|
||||
if: runner.debug == '1'
|
||||
run: echo "NX_VERBOSE_LOGGING=true" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
if: ${{ !matrix.settings.docker }}
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
if: ${{ !matrix.settings.docker }}
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Cache cargo
|
||||
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
.cargo-cache
|
||||
target/
|
||||
key: ${{ matrix.settings.target }}-cargo-registry
|
||||
|
||||
- name: Setup toolchain
|
||||
run: ${{ matrix.settings.setup }}
|
||||
if: ${{ matrix.settings.setup }}
|
||||
shell: bash
|
||||
|
||||
- name: Setup node x86
|
||||
if: matrix.settings.target == 'i686-pc-windows-msvc'
|
||||
run: yarn config set supportedArchitectures.cpu "ia32"
|
||||
shell: bash
|
||||
|
||||
- name: Install dependencies
|
||||
if: ${{ !matrix.settings.docker }}
|
||||
run: pnpm install --frozen-lockfile
|
||||
timeout-minutes: 30
|
||||
|
||||
- name: Setup node x86
|
||||
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
|
||||
if: matrix.settings.target == 'i686-pc-windows-msvc'
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
check-latest: true
|
||||
cache: pnpm
|
||||
architecture: x86
|
||||
|
||||
- name: Build in docker
|
||||
if: ${{ matrix.settings.docker }}
|
||||
shell: bash
|
||||
env:
|
||||
BUILD_SCRIPT: ${{ matrix.settings.build }}
|
||||
run: |
|
||||
SCRIPT_FILE=$(mktemp)
|
||||
echo "$BUILD_SCRIPT" > "$SCRIPT_FILE"
|
||||
docker run --rm \
|
||||
--user 0:0 \
|
||||
-e NODE_VERSION \
|
||||
-e PNPM_VERSION \
|
||||
-e NX_GRADLE_PROJECT_GRAPH_TIMEOUT \
|
||||
-e NX_VERBOSE_LOGGING \
|
||||
-v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db \
|
||||
-v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache \
|
||||
-v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index \
|
||||
-v ${{ github.workspace }}:/build \
|
||||
-v "$SCRIPT_FILE:/build-script.sh" \
|
||||
-w /build \
|
||||
${{ matrix.settings.docker }} \
|
||||
bash /build-script.sh
|
||||
|
||||
- name: Build
|
||||
run: ${{ matrix.settings.build }}
|
||||
if: ${{ !matrix.settings.docker }}
|
||||
shell: bash
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
||||
with:
|
||||
name: bindings-${{ matrix.settings.target }}
|
||||
path: |
|
||||
packages/nx/src/native/*.node
|
||||
packages/nx/src/native/*.wasm
|
||||
if-no-files-found: error
|
||||
|
||||
build-freebsd:
|
||||
needs: [ resolve-required-data ]
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
runs-on: ubuntu-latest
|
||||
name: Build FreeBSD
|
||||
timeout-minutes: 45
|
||||
steps:
|
||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
repository: ${{ needs.resolve-required-data.outputs.repo || github.repository }}
|
||||
ref: ${{ needs.resolve-required-data.outputs.ref || github.ref }}
|
||||
|
||||
- name: Build
|
||||
id: build
|
||||
uses: cross-platform-actions/action@462ed697694d2ac9aa49e1225f395f7bb6dd49fe # v0.29.0
|
||||
env:
|
||||
DEBUG: napi:*
|
||||
RUSTUP_IO_THREADS: 1
|
||||
PLAYWRIGHT_BROWSERS_PATH: 0
|
||||
NODE_VERSION: 26.3.0
|
||||
NX_GRADLE_DISABLE: 'true'
|
||||
NX_DOTNET_DISABLE: 'true'
|
||||
NODE_OPTIONS: '--max-old-space-size=4096'
|
||||
with:
|
||||
operating_system: freebsd
|
||||
version: '14.0'
|
||||
architecture: x86-64
|
||||
environment_variables: DEBUG RUSTUP_IO_THREADS CI PLAYWRIGHT_BROWSERS_PATH NODE_VERSION NX_GRADLE_DISABLE NX_DOTNET_DISABLE NODE_OPTIONS
|
||||
shell: bash
|
||||
run: |
|
||||
env
|
||||
whoami
|
||||
sudo pkg install -y -f node libnghttp2 www/npm git ca_root_nss
|
||||
sudo npm install --location=global --ignore-scripts pnpm@11.2.2
|
||||
curl https://sh.rustup.rs -sSf --output rustup.sh
|
||||
sh rustup.sh -y --profile minimal --default-toolchain stable
|
||||
source "$HOME/.cargo/env"
|
||||
echo "~~~~ rustc --version ~~~~"
|
||||
rustc --version
|
||||
echo "~~~~ node -v ~~~~"
|
||||
node -v
|
||||
echo "~~~~ pnpm --version ~~~~"
|
||||
pnpm --version
|
||||
pwd
|
||||
ls -lah
|
||||
whoami
|
||||
env
|
||||
freebsd-version
|
||||
echo "Installing dependencies"
|
||||
pnpm install --frozen-lockfile --ignore-scripts
|
||||
|
||||
echo "Checking disk space before cleanup"
|
||||
df -h
|
||||
echo "Removing unnecessary preinstalled packages"
|
||||
# List all packages first to see what's installed
|
||||
sudo pkg info -a
|
||||
echo "Cleaning up to free disk space"
|
||||
# Clean package caches
|
||||
sudo pkg clean -a -y
|
||||
sudo pkg autoremove -y
|
||||
# Remove unnecessary system files
|
||||
sudo rm -rf /usr/local/lib/*.a
|
||||
sudo rm -rf /usr/local/share/doc/*
|
||||
sudo rm -rf /usr/local/share/man/*
|
||||
sudo rm -rf /usr/local/share/examples/*
|
||||
sudo rm -rf /usr/local/share/locale/*
|
||||
sudo rm -rf /usr/local/share/gtk-doc/*
|
||||
sudo rm -rf /usr/local/share/info/*
|
||||
sudo rm -rf /usr/src/*
|
||||
sudo rm -rf /usr/obj/*
|
||||
sudo rm -rf /usr/tests/*
|
||||
sudo rm -rf /usr/lib/debug/*
|
||||
# Clean var directories
|
||||
sudo rm -rf /var/cache/pkg/*
|
||||
sudo rm -rf /var/db/pkg/*.tbz
|
||||
sudo rm -rf /var/log/*.log
|
||||
sudo rm -rf /var/log/*.old
|
||||
# Clean temporary files
|
||||
sudo rm -rf /tmp/*
|
||||
sudo rm -rf /var/tmp/*
|
||||
# Remove Python cache if present
|
||||
sudo find /usr/local -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
|
||||
sudo find /usr/local -name "*.pyc" -delete 2>/dev/null || true
|
||||
sudo find /usr/local -name "*.pyo" -delete 2>/dev/null || true
|
||||
# Clean npm/pnpm caches
|
||||
npm cache clean --force || true
|
||||
pnpm store prune || true
|
||||
rm -rf ~/.npm || true
|
||||
rm -rf ~/.pnpm-store || true
|
||||
# Clean Rust extras but keep registry/git (needed for cargo to resolve deps)
|
||||
rm -rf ~/.rustup/toolchains/*/share || true
|
||||
# Remove other development tool caches
|
||||
rm -rf ~/.cache/* || true
|
||||
|
||||
# Remove unnecessary workspace directories
|
||||
rm -rf docs astro-docs nx-dev || true
|
||||
|
||||
echo "Checking disk space after cleanup"
|
||||
df -h
|
||||
|
||||
# Disable core dumps - OOM'd Node processes write multi-GB core files that fill the disk
|
||||
ulimit -c 0
|
||||
|
||||
echo "Building FreeBSD bindings"
|
||||
BUILD_EXIT=0
|
||||
pnpm nx run-many --verbose --outputStyle stream --target=build-native -- --target=x86_64-unknown-freebsd || BUILD_EXIT=$?
|
||||
|
||||
echo "=== Disk usage after build ==="
|
||||
df -h
|
||||
|
||||
if [ "$BUILD_EXIT" -ne 0 ]; then
|
||||
echo "Build failed with exit code $BUILD_EXIT"
|
||||
echo "=== Disk usage by top-level directories ==="
|
||||
du -sh /* 2>/dev/null | sort -rh | head -20
|
||||
echo "=== Disk usage in home directory ==="
|
||||
du -sh ~/* 2>/dev/null | sort -rh | head -20
|
||||
echo "=== Disk usage in workspace ==="
|
||||
du -sh /home/runner/work/nx/nx/* 2>/dev/null | sort -rh | head -20
|
||||
echo "=== Disk usage in .nx ==="
|
||||
du -sh /home/runner/work/nx/nx/.nx/* 2>/dev/null | sort -rh | head -20
|
||||
echo "=== Disk usage in cargo/rustup ==="
|
||||
du -sh ~/.cargo/* ~/.rustup/* 2>/dev/null | sort -rh | head -20
|
||||
echo "=== Core dumps ==="
|
||||
find / -name "*.core" -o -name "core.*" -o -name "core" 2>/dev/null | head -10
|
||||
exit $BUILD_EXIT
|
||||
fi
|
||||
|
||||
echo "Build succeeded"
|
||||
|
||||
echo "Cleaning up"
|
||||
pnpm nx reset
|
||||
rm -rf node_modules
|
||||
rm -rf dist
|
||||
echo "KILL ALL NODE PROCESSES"
|
||||
killall node || true
|
||||
echo "COMPLETE"
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
||||
with:
|
||||
name: bindings-freebsd
|
||||
path: |
|
||||
packages/nx/src/native/*.node
|
||||
if-no-files-found: error
|
||||
|
||||
publish:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
name: Publish
|
||||
runs-on: ubuntu-latest
|
||||
environment: npm-registry
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
needs:
|
||||
- resolve-required-data
|
||||
- build-freebsd
|
||||
- build
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
steps:
|
||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
||||
with:
|
||||
repository: ${{ needs.resolve-required-data.outputs.repo || github.repository }}
|
||||
ref: ${{ needs.resolve-required-data.outputs.ref || github.ref }}
|
||||
|
||||
- name: Set verbose logging from debug mode
|
||||
if: runner.debug == '1'
|
||||
run: echo "NX_VERBOSE_LOGGING=true" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Setup dev tools with mise
|
||||
uses: jdx/mise-action@146a28175021df8ca24f8ee1828cc2a60f980bd5 # v3
|
||||
|
||||
- name: Enable corepack and install pnpm
|
||||
run: |
|
||||
corepack enable
|
||||
corepack prepare --activate
|
||||
|
||||
- name: Use npm 11.5.2
|
||||
run: npm install -g npm@11.5.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Restore .NET packages
|
||||
run: dotnet restore nx.sln
|
||||
|
||||
- name: Download all artifacts
|
||||
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
|
||||
with:
|
||||
path: artifacts
|
||||
|
||||
# This command will appropriately fail if no artifacts are available
|
||||
- name: List artifacts
|
||||
run: ls -R artifacts
|
||||
shell: bash
|
||||
- name: Build Wasm
|
||||
run: |
|
||||
wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-23/wasi-sdk-23.0-x86_64-linux.tar.gz
|
||||
tar -xvf wasi-sdk-23.0-x86_64-linux.tar.gz
|
||||
rustup toolchain install nightly-2025-05-09
|
||||
pnpm build:wasm
|
||||
- name: Publish
|
||||
env:
|
||||
# Not named `VERSION` to avoid MSBuild adopting it as $(Version).
|
||||
NX_PUBLISH_VERSION: ${{ needs.resolve-required-data.outputs.version }}
|
||||
DRY_RUN: ${{ needs.resolve-required-data.outputs.dry_run_flag }}
|
||||
PUBLISH_BRANCH: ${{ needs.resolve-required-data.outputs.publish_branch }}
|
||||
run: |
|
||||
echo ""
|
||||
# Create and check out the publish branch
|
||||
git checkout -b $PUBLISH_BRANCH
|
||||
echo ""
|
||||
echo "Version set to: $NX_PUBLISH_VERSION"
|
||||
echo "DRY_RUN set to: $DRY_RUN"
|
||||
echo ""
|
||||
pnpm nx-release --local=false $NX_PUBLISH_VERSION $DRY_RUN
|
||||
|
||||
- name: (Stable Release Only) Trigger Docs Release
|
||||
# Publish docs only on a full release
|
||||
if: ${{ !github.event.release.prerelease && github.event_name == 'release' }}
|
||||
run: npx tsx ./scripts/release-docs.ts
|
||||
|
||||
- name: (PR Release Only) Create comment for successful PR release
|
||||
if: success() && github.event.inputs.pr
|
||||
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
|
||||
env:
|
||||
SUCCESS_COMMENT: ${{ needs.resolve-required-data.outputs.success_comment }}
|
||||
with:
|
||||
# github-token defaults to ${{ github.token }} so we don't need to specify it
|
||||
script: |
|
||||
const successComment = JSON.parse(process.env.SUCCESS_COMMENT);
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: ${{ github.event.inputs.pr }},
|
||||
body: successComment
|
||||
});
|
||||
|
||||
report-pending-publish:
|
||||
name: Report Pending Publish to Slack
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
needs:
|
||||
- resolve-required-data
|
||||
- build-freebsd
|
||||
- build
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
continue-on-error: true # Don't fail the workflow if notification fails
|
||||
steps:
|
||||
- name: Send Slack notification
|
||||
uses: ravsamhq/notify-slack-action@be814b201e233b2dc673608aa46e5447c8ab13f2 # v11
|
||||
with:
|
||||
status: ${{ job.status }}
|
||||
notification_title: >-
|
||||
${{ needs.resolve-required-data.outputs.pr_number &&
|
||||
format('📦 PR #{0} Publish Pending Review', needs.resolve-required-data.outputs.pr_number) ||
|
||||
'📦 Publish Pending Review' }}
|
||||
message_format: >-
|
||||
${{ needs.resolve-required-data.outputs.pr_number &&
|
||||
format('Version {0} from PR #{1} by @{2} is being published to NPM - manual review is required',
|
||||
needs.resolve-required-data.outputs.version,
|
||||
needs.resolve-required-data.outputs.pr_number,
|
||||
needs.resolve-required-data.outputs.pr_author) ||
|
||||
format('Version {0} is being published to NPM - manual review is required',
|
||||
needs.resolve-required-data.outputs.version) }}
|
||||
footer: '<{run_url}|View Workflow Run>'
|
||||
mention_users: 'U9NPA6C90' # Jason
|
||||
env:
|
||||
SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}
|
||||
|
||||
pr_failure_comment:
|
||||
# Run this job if it is a PR release, running on the nrwl origin, and any of the required jobs failed
|
||||
if: ${{ github.repository_owner == 'nrwl' && github.event.inputs.pr && always() && contains(needs.*.result, 'failure') }}
|
||||
needs: [ resolve-required-data, build, build-freebsd, publish ]
|
||||
name: (PR Release Failure Only) Create comment for failed PR release
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Create comment for failed PR release
|
||||
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
|
||||
with:
|
||||
# This script is intentionally kept inline (and e.g. not generated in publish-resolve-data.js)
|
||||
# to ensure that an error within the data generation itself is not missed.
|
||||
script: |
|
||||
const message = `
|
||||
Failed to publish a PR release of this pull request, triggered by @${{ github.triggering_actor }}.
|
||||
See the failed workflow run at: https://github.com/nrwl/nx/actions/runs/${{ github.run_id }}
|
||||
`;
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: ${{ github.event.inputs.pr }},
|
||||
body: message
|
||||
});
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
name: Stale Bot workflow
|
||||
|
||||
permissions: { }
|
||||
|
||||
jobs:
|
||||
build:
|
||||
if: ${{ github.repository_owner == 'nrwl' }}
|
||||
permissions:
|
||||
issues: write # to close stale issues (actions/stale)
|
||||
pull-requests: write # to close stale PRs (actions/stale)
|
||||
|
||||
name: stale
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# This handles issues that need more info
|
||||
- name: stale-more-info-needed
|
||||
id: stale-more-info-needed
|
||||
uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 7
|
||||
days-before-close: 21
|
||||
stale-issue-label: "stale"
|
||||
operations-per-run: 300
|
||||
remove-stale-when-updated: true
|
||||
only-labels: "blocked: more info needed"
|
||||
stale-issue-message: |
|
||||
This issue has been automatically marked as stale because more information has not been provided within 7 days.
|
||||
It will be closed in 21 days if no information is provided.
|
||||
If information has been provided, please reply to keep it active.
|
||||
Thanks for being a part of the Nx community! 🙏
|
||||
|
||||
# This handles PRs that need to be rebased
|
||||
- name: stale-needs-rebase
|
||||
id: stale-needs-rebase
|
||||
uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 7
|
||||
days-before-close: 21
|
||||
stale-issue-label: "stale"
|
||||
operations-per-run: 300
|
||||
remove-stale-when-updated: true
|
||||
only-labels: "blocked: needs rebased"
|
||||
stale-issue-message: |
|
||||
This PR has been automatically marked as stale because it has not been rebased in 7 days.
|
||||
It will be closed in 21 days if it is not rebased.
|
||||
If the PR has been rebased or you are working on rebasing it, please reply to keep it active.
|
||||
If you do not have time, please let us know and we can rebase it.
|
||||
Thanks for being a part of the Nx community! 🙏
|
||||
|
||||
# This handles issues that do not have a repro
|
||||
- name: stale-repro-needed
|
||||
id: stale-repro-needed
|
||||
uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 7
|
||||
days-before-close: 21
|
||||
stale-issue-label: "stale"
|
||||
operations-per-run: 300
|
||||
remove-stale-when-updated: true
|
||||
only-labels: "blocked: repro needed"
|
||||
stale-issue-message: |
|
||||
This issue has been automatically marked as stale because no reproduction was provided within 7 days.
|
||||
Please help us help you. Providing a repository exhibiting the issue helps us diagnose and fix the issue.
|
||||
Any time that we spend reproducing this issue is time taken away from addressing this issue and other issues.
|
||||
This issue will be closed in 21 days if a reproduction is not provided.
|
||||
If a reproduction has been provided, please reply to keep it active.
|
||||
Thanks for being a part of the Nx community! 🙏
|
||||
|
||||
- name: stale-retry-with-latest
|
||||
id: stale-retry-with-latest
|
||||
uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 7
|
||||
days-before-close: 21
|
||||
stale-issue-label: "stale"
|
||||
operations-per-run: 300
|
||||
remove-stale-when-updated: true
|
||||
only-labels: "blocked: retry with latest"
|
||||
stale-issue-message: |
|
||||
This issue has been automatically marked as stale because no results of retrying on the latest version of Nx was provided within 7 days.
|
||||
It will be closed in 21 days if no results are provided.
|
||||
If the issue is still present, please reply to keep it active.
|
||||
If the issue was not present, please close this issue.
|
||||
Thanks for being a part of the Nx community! 🙏
|
||||
|
||||
|
||||
# This handles issues are really old and were made with a previous major
|
||||
- name: stale-bug
|
||||
id: stale-bug
|
||||
uses: actions/stale@3a9db7e6a41a89f618792c92c0e97cc736e1b13f # v10.0.0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 180
|
||||
days-before-close: 21
|
||||
stale-issue-label: "stale"
|
||||
operations-per-run: 300
|
||||
remove-stale-when-updated: true
|
||||
stale-issue-message: |
|
||||
This issue has been automatically marked as stale because it hasn't had any activity for 6 months.
|
||||
Many things may have changed within this time. The issue may have already been fixed or it may not be relevant anymore.
|
||||
If at this point, this is still an issue, please respond with updated information.
|
||||
It will be closed in 21 days if no further activity occurs.
|
||||
Thanks for being a part of the Nx community! 🙏
|
||||
+192
@@ -0,0 +1,192 @@
|
||||
node_modules
|
||||
/.idea
|
||||
/.fleet
|
||||
/.vscode
|
||||
dist
|
||||
out-tsc
|
||||
/build
|
||||
/coverage
|
||||
./test
|
||||
.DS_Store
|
||||
tmp
|
||||
*.log
|
||||
jest.debug.config.js
|
||||
.tool-versions
|
||||
/.nx-cache
|
||||
/.nx/cache
|
||||
/.nx/workspace-data
|
||||
/.verdaccio/build/local-registry
|
||||
/graph/client/src/assets/environment.js
|
||||
/graph/client/src/assets/dev/environment.js
|
||||
/graph/client/src/assets/generated-project-graphs
|
||||
/graph/client/src/assets/generated-task-graphs
|
||||
/graph/client/src/assets/generated-task-inputs
|
||||
/graph/client/src/assets/generated-source-maps
|
||||
/nx-dev/nx-dev/public/documentation
|
||||
/nx-dev/nx-dev/public/tutorials
|
||||
/nx-dev/nx-dev/public/images/open-graph
|
||||
/nx-dev/nx-dev/public/robots.txt
|
||||
/nx-dev/nx-dev/public/sitemap-0.xml
|
||||
/nx-dev/nx-dev/public/sitemap.xml
|
||||
|
||||
# Banner JSON files are generated during static builds
|
||||
/nx-dev/nx-dev/lib/banner.json
|
||||
/astro-docs/src/content/banner.json
|
||||
**/tests/temp-db*
|
||||
|
||||
# Issues scraper creates these files, stored by github's cache
|
||||
/scripts/issues-scraper/cached
|
||||
|
||||
# We don't commit a CHANELGELOG.md file to the repo, we only create Github releases
|
||||
CHANGELOG.md
|
||||
|
||||
# Next.js
|
||||
.next
|
||||
out
|
||||
|
||||
|
||||
# Angular Cache
|
||||
.angular
|
||||
|
||||
# Astro Cache
|
||||
.astro
|
||||
|
||||
# Local dev files
|
||||
.env.local
|
||||
.bashrc
|
||||
|
||||
*.node
|
||||
|
||||
# Fix for issue when working on the repo in a dev container
|
||||
.pnpm-store
|
||||
|
||||
.cargo/.package-cache
|
||||
.cargo/bin/
|
||||
.cargo/env
|
||||
.cargo/registry/
|
||||
.local/
|
||||
.npm/
|
||||
.profile
|
||||
.rustup/
|
||||
target
|
||||
.flattened-pom.xml
|
||||
dependency-reduced-pom.xml
|
||||
*.wasm
|
||||
/wasi-sdk*
|
||||
|
||||
*.config.timestamp*
|
||||
|
||||
storybook-static
|
||||
|
||||
# Ignore Gradle project-specific cache directory
|
||||
.gradle
|
||||
.kotlin
|
||||
|
||||
.claude/settings.local.json
|
||||
.claude/scheduled_tasks.lock
|
||||
CLAUDE.local.md
|
||||
|
||||
.cursor/mcp.json
|
||||
|
||||
# Added by Claude Task Master
|
||||
# Logs
|
||||
logs
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
dev-debug.log
|
||||
# Dependency directories
|
||||
node_modules/
|
||||
# Environment variables
|
||||
.env
|
||||
!e2e/dotnet/.env
|
||||
# Editor directories and files
|
||||
.idea
|
||||
.vscode
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
!/nx.sln
|
||||
*.sw?
|
||||
.specstory/**
|
||||
.cursorindexingignore
|
||||
# OS specific
|
||||
# Task files
|
||||
/tasks.json
|
||||
/tasks
|
||||
|
||||
# Upstream docs local configuration (machine-specific)
|
||||
.upstreamdocs.local.json
|
||||
|
||||
# Netlify build artifacts
|
||||
.netlify
|
||||
|
||||
coverage
|
||||
|
||||
# Angular Rspack Specific Options
|
||||
packages/angular-rspack/coverage
|
||||
packages/angular-rspack-compiler/coverage
|
||||
|
||||
# Some Packages use a template to generate the correct README
|
||||
packages/angular-rspack/README.md
|
||||
packages/angular-rspack-compiler/README.md
|
||||
packages/dotnet/README.md
|
||||
packages/maven/README.md
|
||||
packages/nx/README.md
|
||||
packages/devkit/README.md
|
||||
packages/workspace/README.md
|
||||
packages/js/README.md
|
||||
packages/jest/README.md
|
||||
packages/eslint/README.md
|
||||
packages/eslint-plugin/README.md
|
||||
packages/vitest/README.md
|
||||
packages/cypress/README.md
|
||||
packages/playwright/README.md
|
||||
packages/vite/README.md
|
||||
packages/webpack/README.md
|
||||
packages/rollup/README.md
|
||||
packages/docker/README.md
|
||||
packages/gradle/README.md
|
||||
packages/rsbuild/README.md
|
||||
packages/web/README.md
|
||||
packages/node/README.md
|
||||
packages/module-federation/README.md
|
||||
packages/nest/README.md
|
||||
packages/rspack/README.md
|
||||
packages/storybook/README.md
|
||||
packages/react/README.md
|
||||
packages/vue/README.md
|
||||
packages/esbuild/README.md
|
||||
packages/angular/README.md
|
||||
packages/express/README.md
|
||||
packages/plugin/README.md
|
||||
packages/react-native/README.md
|
||||
packages/next/README.md
|
||||
packages/remix/README.md
|
||||
packages/detox/README.md
|
||||
packages/expo/README.md
|
||||
packages/nuxt/README.md
|
||||
packages/create-nx-workspace/README.md
|
||||
packages/create-nx-plugin/README.md
|
||||
|
||||
test-output
|
||||
test-results
|
||||
|
||||
# TypeScript build info files
|
||||
*.tsbuildinfo
|
||||
|
||||
# .NET build output
|
||||
/packages/dotnet/analyzer/bin
|
||||
/packages/dotnet/analyzer/obj
|
||||
/packages/dotnet/analyzer.Tests/bin
|
||||
/packages/dotnet/analyzer.Tests/obj
|
||||
/*.deb
|
||||
.nx/polygraph
|
||||
.claude/worktrees
|
||||
|
||||
.nx/self-healing
|
||||
e2e/**/*.d.ts
|
||||
e2e/**/*.d.ts.map
|
||||
|
||||
.nx/migrate-runs
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user