Skip to content

docs: clarify path base for project references #3514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
skdas20 wants to merge 1 commit into
base: v2
Choose a base branch
from
+3 −0
Open

docs: clarify path base for project references #3514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/documentation/copy/en/project-config/Project References.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Project references can solve all of these problems and more.
```

The `path` property of each reference can point to a directory containing a `tsconfig.json` file, or to the config file itself (which may have any name).
Reference `path` values are resolved relative to the `tsconfig.json` file they appear in.

When you reference a project, new things happen:

Expand Down
2 changes: 2 additions & 0 deletions packages/tsconfig-reference/copy/en/options/references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ oneline: "Specify an array of objects that specify paths for projects. Used in p
Project references are a way to structure your TypeScript programs into smaller pieces.
Using Project References can greatly improve build and editor interaction times, enforce logical separation between components, and organize your code in new and improved ways.

Each `path` entry in `references` is resolved relative to the `tsconfig.json` file that contains it.

You can read more about how references works in the [Project References](/docs/handbook/project-references.html) section of the handbook