Skip to content

Clarify TypeScript configuration requirements for applications in project references migration #31715

Closed
@jvskriubakken

Description

@jvskriubakken

Documentation issue

  • Reporting a typo
  • Reporting a documentation bug
  • [ x] Documentation improvement
  • Documentation feedback

Is there a specific documentation page you are reporting?

https://nx.dev/technologies/typescript/recipes/switch-to-workspaces-project-references

Additional context or description

I'm struggling to migrate my repo to use project references. I'm reading this guide again and again... and I want to mention something I think it's unclear.

In the chapter "Update Individual Project TypeScript Configuration" it says:
Each project's tsconfig.json file should extend the tsconfig.base.json file and list references to the project's dependencies.

It's unclear to be whether this applies for application projects too. As the example only shows tsconfig for a library.

Same goes for tsconfig.lib.json, it's also unclear for me how a tsconfig.app.json should look like, as the chapter only continues with lib examples. But I suspect that it applies for applications too.

I suggest to the improve the documentation with clearer examples for description on what changes are needed for application tsconfigs.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions