Should routeTree.gen.ts be gitignored?

[psnehanshu]

I belive it should be, but I want to hear what other people are doing.

[SeanCassiere]

If you are using router-cli you could probably gitignore the file and generate it priot to a build.

This changes however if you are using the vite-plugin, since the default vite-build script has you run tsc before the build. In this scenario, your build would never get past the tsc check.

IMHO: I just check-in the file (routeTree.gen.ts) in git, because I can't be bothered solving the vite-build script.

[gual]

I used the Router CLI, created a
"router:generate": "tsr generate", in the package.json so I can use it in my build process.

[mrlubos]

@SeanCassiere has anything changed since the last year? Still the same guidance?

[SeanCassiere]

I've honestly gotten into the mindset of just saving your route-tree file in git. Purely, because the file is essential to your application running and having the typecheck phase pass correctly.

---

Updated Answer: Don't gitignore your routeTree.gen.ts file. This file is part of your application. It's simply managed by TanStack Router.

[SeanCassiere]

I'll probably create a FAQ section and chuck this in there.

[mrlubos]

FAQ would be nice! A counterpoint I can offer is that dependencies are also essential to your application running and would fail typecheck if not installed, yet we don't keep them in git. Even more similar, I work on codegen (see my profile) and the same question arises there. I went from yes to no on the same question. It's not that difficult to generate everything that's needed on postinstall or with a Vite plugin – you're doing that already anyway! In fact, I looked at the TanStack Router Vite plugin when working on mine, so I suspect it might just work™. A practical argument I hear for not committing the generated files is it makes switching between branches easier as there won't be any conflicts.

[SeanCassiere]

The FAQ is up - https://tanstack.com/router/latest/docs/framework/react/faq

@mrlubos, I get what you mean. My only argument against the conflict point is, that this isn't like your package-lock where some trailing commas pretty much always guarantee a conflict. So conflicts really should be at the minimum. The route tree also serves as an accurate point-in-time snapshot as to what TanStack Router would've used at runtime.

[gual]

I'm using GitHub Actions so I just had to add: ``` - name: Generate routes file run: | docker compose run --rm --no-deps react npm run router:generate ```

…

On Wed, Apr 24, 2024, at 8:54 AM, HappilyCoding wrote: > I used the Router CLI <https://tanstack.com/router/latest/docs/framework/react/guide/file-based-routing#router-cli>, created a `"router:generate": "tsr generate",` in the `package.json` so I can use it in my build process. > Could you please explain further? You probably modified other parts of the package.json or the docker or dockercompose files in order for tsr generate to be called automatically in the build process. It'd be awesome if you could share those changes. Also, to be frank, I'm unsure why tsr CLI is needed at all, according to the official doccumentation <https://tanstack.com/router/v1/docs/framework/react/quick-start> I don't believe it should be, specially considering since that's basically the configuration this project has. — Reply to this email directly, view it on GitHub <#1218 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAMS7NRIPY654RAYUIGO2JDY67BTTAVCNFSM6AAAAABDX27WTOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TEMJUG4ZDS>. You are receiving this because you commented.Message ID: ***@***.***>

[jessetabak]

tsc is just a compile check so I moved it after the build:

"build": "vite build && tsc"

[psnehanshu]

What's the point of building if typecheck failed? It should ideally be

"build": "tsc --noEmit && vite build"

[jessetabak]

The point is that tsc will always fail if there's no generated route-tree file, which I have git ignored.