Documentation for router-plugin?

[mkarajohn]

The reason I got this question is because I started a new router project today (v1.125.4), and I cross referenced it with an older project (v1.114.25). Both were generated with the setup tool from the installation instructions.

First thing i noticed is that the newer package exports tanStackRouterVite instead of TanStackRouterVite (the change happened here from alpha to stable, fair), however I can see that the new docs have also updated the usage examples for the tanStackRouterVite plugin.

Specifically, all the newest examples showcase using it like this:

      tanstackRouter({
        target: 'react',
        autoCodeSplitting: true,
      }),

While the older installation simply did

!isTest && TanStackRouterVite()

This made me have the following questions:

• why is the older installation only applying the plugin in non-test environments while the newer isn't?
• Why is the newer installation using the target option while the older one wasn't (even though that option existed since then), and in the end is it actually needed, especially considering that the whole config option type definition is wrapped in a Partial ? Not needed, and default is "react"
• Is there a complete documentation for the router-plugin somewhere? Best I could find was this but it only documents some of all the available options defined in the tanstacRouter type definition. For example target is not documented anywhere, as far as I could tell.

[schiller-manuel]

this is what we have in the docs about that plugin: https://tanstack.com/router/latest/docs/framework/react/routing/installation-with-vite

why is the older installation only applying the plugin in non-test environments while the newer isn't?

what does this mean?

[mkarajohn]

this is what we have in the docs about that plugin: https://tanstack.com/router/latest/docs/framework/react/routing/installation-with-vite

Hm, yeah, this ends up back to https://tanstack.com/router/latest/docs/api/file-based-routing, the same link I mentioned in the OP. Ideally I would like to see the complete documentation of tanStackRouterVite's config grouped together, in one place, somewhere. Neither of these pages documents all of the config options

what does this mean?

Yeah, I mean the old vite config looks like this:

/// <reference types="vitest/config" />
import tailwindcss from '@tailwindcss/vite';
import { TanStackRouterVite } from '@tanstack/router-plugin/vite';
import react from '@vitejs/plugin-react';
import { defineConfig } from 'vite';
import tsconfigPaths from 'vite-tsconfig-paths';

const isTest = process.env.NODE_ENV === 'test';
      ^^^^^^

// https://vite.dev/config/
export default defineConfig({
  plugins: [tsconfigPaths(), tailwindcss(), !isTest && TanStackRouterVite(), react()],
                                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  test: {},
});

But now that I had some time to look at the tanstack repo on the 1.114.25 tag, I could not find any docs that actually show anything like !isTest && TanStackRouterVite() . So now I wonder how this ended up like this (this whole config was introduced in a single commit, the initial one) 🤷‍♂️ Smells like this was copy pasted from some setup example but I cannot prove it or find out where from 😅 In any case, this doesn't seem like it came from tanstack-router docs after all and it doesn't make much sense to conditionally load the plugin if not on a test environment.

[schiller-manuel]

it doesn't make much sense to conditionally load the plugin if not on a test environment.

no this does not make sense.