Skip to content
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.

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

docs(how-to/route-module-type-safety): update tsconfig reference #12366

Closed
wants to merge 1 commit into from

Conversation

coryhouse
Copy link
Contributor

@coryhouse coryhouse commented Nov 24, 2024

Vite comes with 3 ts config files. The current docs assume a single tsconfig.json.

If I change the plain tsconfig.json to this:

{
  "files": [],
  "references": [
    { "path": "./tsconfig.app.json" },
    { "path": "./tsconfig.node.json" }
  ],
  "include": [".react-router/types/**/*"],
  "compilerOptions": {
    "rootDirs": [".", "./.react-router/types"]
  }
}

I get this error: Referenced project '/Users/coryhouse/Projects/react-router-7-demo/tsconfig.app.json' must have setting "composite": true.

Should these changes be applied to one of the other Vite tsconfig files?

Copy link

changeset-bot bot commented Nov 24, 2024

⚠️ No Changeset found

Latest commit: 19f5a1f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@MichaelDeBoey MichaelDeBoey changed the title Update route-module-type-safety.md docs(how-to/route-module-type-safety): update tsconfig reference Nov 24, 2024
@brookslybrand
Copy link
Contributor

I think this depends a lot on your setup. The default template just has a single tsconfig.json file

I'll defer to @pcattori here though if he thinks it'd be more clear to change the filename in this doc

@brookslybrand brookslybrand requested review from pcattori and removed request for brophdawg11 and brookslybrand November 25, 2024 15:30
@pcattori
Copy link
Contributor

Thanks @coryhouse for bringing this up! I decided to add this as a separate paragraph to keep the happy path as minimal as possible.

Superseded by #12393

@pcattori pcattori closed this Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants