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

Add @tanstack/react-router plugin #856

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions packages/knip/fixtures/plugins/tanstack-router/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "@fixtures/tanstack-router",
"version": "*",
"devDependencies": {
"@tanstack/react-router": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"routesDirectory": "./src/routes",
"generatedRouteTree": "./src/routeTree.gen.ts",
"routeFileIgnorePrefix": "-",
"quoteStyle": "single"
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions packages/knip/fixtures/plugins/tanstack-router2/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "@fixtures/tanstack-router2",
"version": "*",
"devDependencies": {
"@tanstack/react-router": "*",
"@tanstack/router-plugin": "*",
"vite": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { defineConfig, type PluginOption } from 'vite';
import { TanStackRouterVite } from '@tanstack/router-plugin/vite';

export default defineConfig({
plugins: [TanStackRouterVite() as unknown as PluginOption],
});

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions packages/knip/fixtures/plugins/tanstack-router3/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@fixtures/tanstack-router",
"version": "*",
"devDependencies": {
"@tanstack/react-router": "*",
"@tanstack/router-plugin": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { TanStackRouterRspack } from '@tanstack/router-plugin/rspack';

export default {
plugins: [TanStackRouterRspack()],
};

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions packages/knip/fixtures/plugins/tanstack-router4/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@fixtures/tanstack-router",
"version": "*",
"devDependencies": {
"@tanstack/react-router": "*",
"@tanstack/router-plugin": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { TanStackRouterRspack } from '@tanstack/router-plugin/rspack';

export default {
tools: {
rspack: {
plugins: [TanStackRouterRspack()],
},
},
};

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions packages/knip/fixtures/plugins/tanstack-router5/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@fixtures/tanstack-router",
"version": "*",
"devDependencies": {
"@tanstack/react-router": "*",
"@tanstack/router-plugin": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { TanStackRouterWebpack } from '@tanstack/router-plugin/webpack';

export default {
plugins: [TanStackRouterWebpack()],
};
4 changes: 4 additions & 0 deletions packages/knip/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,10 @@
"title": "tailwind plugin configuration (https://knip.dev/reference/plugins/tailwind)",
"$ref": "#/definitions/plugin"
},
"tanstack-router": {
"title": "tanstack-router plugin configuration (https://knip.dev/reference/plugins/tanstack-router)",
"$ref": "#/definitions/plugin"
},
"travis": {
"title": "travis plugin configuration (https://knip.dev/reference/plugins/travis)",
"$ref": "#/definitions/plugin"
Expand Down
2 changes: 2 additions & 0 deletions packages/knip/src/plugins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ import { default as stylelint } from './stylelint/index.js';
import { default as svelte } from './svelte/index.js';
import { default as syncpack } from './syncpack/index.js';
import { default as tailwind } from './tailwind/index.js';
import { default as tanstackRouter } from './tanstack-router/index.js';
import { default as travis } from './travis/index.js';
import { default as tsNode } from './ts-node/index.js';
import { default as tsup } from './tsup/index.js';
Expand Down Expand Up @@ -154,6 +155,7 @@ export const Plugins = {
svelte,
syncpack,
tailwind,
'tanstack-router': tanstackRouter,
travis,
'ts-node': tsNode,
tsup,
Expand Down
77 changes: 77 additions & 0 deletions packages/knip/src/plugins/tanstack-router/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import type { IsPluginEnabled, Plugin, ResolveEntryPaths } from '../../types/config.js';
import { debugLogObject } from '../../util/debug.js';
import { type Input, toEntry } from '../../util/input.js';
import { hasDependency } from '../../util/plugin.js';
import { type TanstackRouterPluginConfig, tanstackRouterPluginConfigSchema } from './types.js';
import { getRsbuildPluginConfig, getRspackPluginConfig, getVitePluginConfig, getWebpackPluginConfig } from './utils.js';

// https://tanstack.com/router/latest/docs/framework/react/guide/file-based-routing

const title = 'Tanstack Router';

const enablers = ['@tanstack/react-router', '@tanstack/router-plugin', '@tanstack/router-cli'];

const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);

const config: string[] = [
'tsr.config.json',
'vite.config.{js,mjs,ts,cjs,mts,cts}',
'rs{pack,build}.config.{js,mjs,ts,cjs,mts,cts}',
'webpack.config.{js,mjs,ts,cjs,mts,cts}',
];

const entry: string[] = [];

const production: string[] = [];

const resolveEntryPaths: ResolveEntryPaths<TanstackRouterPluginConfig> = async (config, options) => {
debugLogObject('*', 'resolveEntryPaths::options', options);

let resolvedConfig: TanstackRouterPluginConfig | undefined;

if (options.configFileName === 'tsr.config.json') {
resolvedConfig = tanstackRouterPluginConfigSchema.parse(config);
}

if (options.configFileName.startsWith('vite.config.')) {
resolvedConfig = getVitePluginConfig(options.configFilePath, options.configFileName);
}

if (options.configFileName.startsWith('rspack.config')) {
resolvedConfig = getRspackPluginConfig(options.configFilePath, options.configFileName);
}

if (options.configFileName.startsWith('rsbuild.config')) {
resolvedConfig = getRsbuildPluginConfig(options.configFilePath, options.configFileName);
}

if (options.configFileName.startsWith('webpack.config')) {
resolvedConfig = getWebpackPluginConfig(options.configFilePath, options.configFileName);
}

if (resolvedConfig) {
const entries = [
toEntry(resolvedConfig.generatedRouteTree),
toEntry(`${resolvedConfig.routesDirectory}/**/${resolvedConfig.routeFilePrefix ?? ''}*`),
toEntry(`!${resolvedConfig.routesDirectory}/**/${resolvedConfig.routeFileIgnorePrefix}*`),
] satisfies Input[];

if (resolvedConfig.routeFileIgnorePattern) {
entries.push(toEntry(`!${resolvedConfig.routesDirectory}/**/*${resolvedConfig.routeFileIgnorePattern}*`));
}

return entries;
}

return [];
};

export default {
title,
enablers,
isEnabled,
config,
entry,
production,
resolveEntryPaths,
} satisfies Plugin;
17 changes: 17 additions & 0 deletions packages/knip/src/plugins/tanstack-router/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { z } from 'zod';

export const tanstackRouterPluginConfigSchema = z
.object({
routeFilePrefix: z.string().optional(),
routeFileIgnorePrefix: z.string().optional().default('-'),
routeFileIgnorePattern: z.string().optional(),
routesDirectory: z.string().default('./src/routes'),
generatedRouteTree: z.string().default('./src/routeTree.gen.ts'),
})
.default({
routesDirectory: './src/routes',
generatedRouteTree: './src/routeTree.gen.ts',
routeFileIgnorePrefix: '-',
});

export type TanstackRouterPluginConfig = z.infer<typeof tanstackRouterPluginConfigSchema>;
Loading