docs(core): project linking concept and recipe #29652
Conversation
isaacplmann
requested review from
FrozenPandaz,
jaysoo,
AgentEnder and
a team
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
View your CI Pipeline Execution ↗ for commit e154593.
☁️ Nx Cloud last updated this comment at |
|
|
||
| ### Set Up Package Manager Workspaces | ||
|
|
||
| The configuration for package manager workspaces varies based on which package manager you're using. |
There was a problem hiding this comment.
I know you mention the package.json linking in the various tabs since PNPM has a different protocol. Can we bring it up more clearly though that for the "workspaces" based pacakge linking you need to have the dependency to the packages defined in the project's package.json?
like if A -> B then A's package.json needs to have a dependency to B.
I know in theory NPM (and maybe yarn and bun) don't strictly require this, while PNPM (and yarn pnp?) do. But I'd almost lean towards defining it so things don't go wrong.
| "compilerOptions": { | ||
| // Required compiler options | ||
| "composite": true, | ||
| "declaration": true |
There was a problem hiding this comment.
I'd also add declarationMaps: true.
| ## Project Linking with TypeScript Path Aliases | ||
|
|
||
| {% callout type="warning" title="Incompatible with TypeScript Project References" %} | ||
| You can not use TypeScript project references with this style of project linking. |
There was a problem hiding this comment.
this is technically not correct.
You can use TS path aliases with project references. The former is for the name resolution while the latter defines how TS creates "programs" for type checking/compilation.
Now, while possible, it's not what we recommend for sure. We should somewhere mention though that the recommendation goes:
- Workspaces + proj references (preferred for new workspaces)
- TS path aliases (how Nx does it now and will still be valid for a long time)
Adds two pages: