Nx adapter: read the Nx project graph and run through Nx (tracking issue)

Open
#111 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript

Research direction

Start with src/ci-inference/resolve.ts and src/planner/test-command.ts, then review the tracked work in issues #112–#114. The issue describes reading Nx's project graph, selecting targets, and planning nx run-many commands, but leaves the implementation and public workspace validation as multi-step design work. Done means checks are covered, selected projects are compared with nx affected, and Nx cache hits remain intact.

Written by the indexing model from the issue text.

Description

adapter enhancement help wanted

DiffCI should work alongside Nx, not instead of it. In a repository with Nx installed, DiffCI reads Nx's project graph, adds the file-level and check edges Nx doesn't model, and hands execution back to Nx. Nx's task runner and cache still decide what actually runs.

Today. Core treats nx as an opaque wrapper (src/ci-inference/resolve.ts). A root test script that calls nx is assumed to run every package, and the plan refuses when a package can't be narrowed (src/planner/test-command.ts, runsWorkspaceScripts). nx.json is never read as data.

Plan

  • Map files and test files to Nx projects from nx graph (#112)
  • Select a project's target when a changed file matches its Nx inputs / namedInputs (#113)
  • Plan nx run-many commands for the selected projects (#114)
  • Docs: using DiffCI in an Nx workspace (extends #101)

Principles

  • Nx's edges only add reach. They never remove an edge DiffCI's own graph found.
  • The default command is project-level (nx run-many -t test -p a,b), so Nx's cache keys don't change. File-level runs (nx run a:test -- <files>) change the task hash and are only for the agent's pre-push loop.
  • If DiffCI's plan and Nx's cache disagree, the cache decides whether a task runs. DiffCI only narrows or explains.
  • When Nx can't produce a graph, DiffCI falls back to the full suite and says why.

Success. On a public Nx workspace with inferred targets: checks covered before the push, projects run compared with nx affected, and Nx cache hits left intact.

Out of scope: replacing Nx's cache, distributed execution or sharding.

Dominant language
TypeScript
Stars
0
Forks
4
Avg merge
18h 41m
Merged PRs (30d)
48

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiffCI/core

All issues in DiffCI/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.