Skip to content

Documentation unclear about application package.json requirements for TypeScript project references #31714

Open
@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 "Create Individual Project package.json files" it says:
"When using package manager project linking, every project needs to have a package.json file"

I know that in Nx, a project is either an app or a library. But in the example window you only mention "Non-buildable library" and "Buildable Library", making it easy to oversee the fact (and sentence): For application projects, you only need to specify the name property. Also, when scrolling to the top of the page, this is not quite true as it says you must include an apps dependencies in it's package.json as devDependencies.

I suggest the guide also have examples of application package.json

Metadata

Metadata

Labels

priority: lowLow Priority (does not affect many people or not severely or has an easy workaround)scope: docsIssues related to generic docstype: docs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions