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

feat(@netlify/build-info): add React Router 7 detection #5930

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
23 changes: 23 additions & 0 deletions packages/build-info/assets/logos/react-router/dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions packages/build-info/assets/logos/react-router/light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions packages/build-info/src/frameworks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { Parcel } from './parcel.js'
import { Phenomic } from './phenomic.js'
import { Quasar } from './quasar.js'
import { Qwik } from './qwik.js'
import { ReactRouter } from './react-router.js'
import { ReactStatic } from './react-static.js'
import { CreateReactApp } from './react.js'
import { RedwoodJS } from './redwoodjs.js'
Expand Down Expand Up @@ -65,6 +66,7 @@ export const frameworks = [
Nuxt,
Phenomic,
Qwik,
ReactRouter,
ReactStatic,
RedwoodJS,
Remix,
Expand Down
75 changes: 75 additions & 0 deletions packages/build-info/src/frameworks/react-router.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { beforeEach, expect, test } from 'vitest'

import { mockFileSystem } from '../../tests/mock-file-system.js'
import { NodeFS } from '../node/file-system.js'
import { Project } from '../project.js'

beforeEach((ctx) => {
ctx.fs = new NodeFS()
})
test('detects a React Router v7 site', async ({ fs }) => {
const cwd = mockFileSystem({
'react-router.config.ts': '',
'vite.config.ts': '',
'package.json': JSON.stringify({
scripts: {
build: 'react-router build',
dev: 'react-router dev',
start: 'react-router-serve ./build/server/index.js',
typecheck: 'react-router typegen && tsc',
},
dependencies: {
'@react-router/node': '^7.0.2',
'@react-router/serve': '^7.0.2',
react: '^18.3.1',
'react-dom': '^18.3.1',
'react-router': '^7.0.2',
},
devDependencies: {
'@netlify/vite-plugin-react-router': '^1.0.0',
'@react-router/dev': '^7.0.2',
typescript: '^5.6.3',
vite: '^5.4.11',
'vite-tsconfig-paths': '^5.1.2',
},
}),
})
const detected = await new Project(fs, cwd).detectFrameworks()

const detectedFrameworks = (detected ?? []).map((framework) => framework.id)
expect(detectedFrameworks).not.toContain('remix')

expect(detected?.[0]?.id).toBe('react-router')
expect(detected?.[0]?.build?.command).toBe('react-router build')
expect(detected?.[0]?.build?.directory).toBe('build/client')
expect(detected?.[0]?.dev?.command).toBe('react-router dev')
expect(detected?.[0]?.dev?.port).toBe(5173)
})

test('does NOT detect a React Router <v7 site', async ({ fs }) => {
const cwd = mockFileSystem({
'vite.config.ts': '',
'package.json': JSON.stringify({
scripts: {
build: 'vite build',
dev: 'vite dev',
},
dependencies: {
react: '^18.2.0',
'react-dom': '^18.2.0',
'react-router-dom': '^6.15.0',
},
devDependencies: {
'@vitejs/plugin-react': '^3.0.1',
typescript: '^4.9.5',
vite: '^4.0.4',
},
}),
})
const detected = await new Project(fs, cwd).detectFrameworks()

const detectedFrameworks = (detected ?? []).map((framework) => framework.id)
expect(detectedFrameworks).not.toContain('react-router')

expect(detected?.[0]?.id).toBe('vite')
})
40 changes: 40 additions & 0 deletions packages/build-info/src/frameworks/react-router.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { lt } from 'semver'

import { BaseFramework, Category, DetectedFramework, Framework } from './framework.js'

export class ReactRouter extends BaseFramework implements Framework {
readonly id = 'react-router'
name = 'React Router'
configFiles = ['react-router.config.ts', 'react-router.config.js']
npmDependencies = ['react-router']
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to detect the plugin we built as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. We've been doing that for some of the frameworks, but I was thinking about it and couldn't come up with any reason for it, so I didn't include it. You definitely need react-router to use react-router; checking for additional dependencies won't help.

category = Category.SSG

dev = {
port: 5173,
command: 'react-router dev',
}

build = {
command: 'react-router build',
directory: 'build/client',
}

logo = {
default: '/logos/react-router/light.svg',
light: '/logos/react-router/light.svg',
dark: '/logos/react-router/dark.svg',
}

async detect(): Promise<DetectedFramework | undefined> {
await super.detect()

if (this.detected) {
// React Router wasn't a framework before v7. As of v7, it's... Remix.
if (this.version && lt(this.version, '7.0.0')) {
return
}

return this as DetectedFramework
}
}
}
Loading