miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): fix package manager workspaces' patterns in typescript project linking concept page (#30729)

Browse Source 
## Current Behavior

The "Typescript Project Linking" concept page shows package manager
workspaces' patterns like `apps/**`. While this could be correct, it's
not what Nx generators will generate, and it can result in some nested
and non-expected directories being matched (e.g., fixtures).

## Expected Behavior

The "Typescript Project Linking" concept page should show package
manager workspaces' patterns like `apps/*` so it's aligned with what Nx
generators will generate. It would be a safer example, so it doesn't
match potentially undesired directories.

## Related Issue(s)

Fixes #
This commit is contained in:
Leosvel Pérez Espinosa 2025-04-15 17:07:02 +02:00 committed by GitHub
parent 9ce301f30c
commit 1bd105256e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/shared/concepts/typescript-project-linking.md
View File

@ -48,7 +48,7 @@ The configuration for package manager workspaces varies based on which package m
```json {% fileName="package.json" %} ```json {% fileName="package.json" %}
{ {
"workspaces": ["apps/**", "packages/**"] "workspaces": ["apps/*", "packages/*"]
} }
``` ```
@ -69,7 +69,7 @@ If you want to reference a local library project with its own `build` task, you
```json {% fileName="package.json" %} ```json {% fileName="package.json" %}
{ {
"workspaces": ["apps/**", "packages/**"] "workspaces": ["apps/*", "packages/*"]
} }
``` ```
@ -90,7 +90,7 @@ If you want to reference a local library project with its own `build` task, you
```json {% fileName="package.json" %} ```json {% fileName="package.json" %}
{ {
"workspaces": ["apps/**", "packages/**"] "workspaces": ["apps/*", "packages/*"]
} }
``` ```
@ -111,8 +111,8 @@ If you want to reference a local library project with its own `build` task, you
```yaml {% fileName="pnpm-workspace.yaml" %} ```yaml {% fileName="pnpm-workspace.yaml" %}
packages: packages:
- 'apps/**' - 'apps/*'
- 'packages/**' - 'packages/*'
``` ```
Defining the `packages` property in the root `pnpm-workspaces.yaml` file lets pnpm know to look for project `package.json` files in the specified folders. With this configuration in place, all the dependencies for the individual projects will be installed in the root `node_modules` folder when `pnpm install` is run in the root folder. Defining the `packages` property in the root `pnpm-workspaces.yaml` file lets pnpm know to look for project `package.json` files in the specified folders. With this configuration in place, all the dependencies for the individual projects will be installed in the root `node_modules` folder when `pnpm install` is run in the root folder.