Skip to content

feat(create-vite): add TanStack Router commands #19573

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.

Sign up for GitHub

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

Merged
patak-cat merged 8 commits into from
Mar 20, 2025
Merged

feat(create-vite): add TanStack Router commands #19573

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1425a5d
feat(create-vite): Add TanStack Router commands
wobsoriano Mar 4, 2025
f8ba7e6
chore: use npm exec
wobsoriano Mar 4, 2025
703f9b5
chore: switch to npm create
wobsoriano Mar 4, 2025
6603622
chore: revert to npm exec to fix swapping of pkg manager
wobsoriano Mar 4, 2025
ff82d0f
chore: Remove create from command
wobsoriano Mar 4, 2025
ddef5d1
chore: add missing dashes
wobsoriano Mar 4, 2025
3d24737
chore: remove whitespace
wobsoriano Mar 4, 2025
d0b018b
chore: strip double dash in pnpm and bun
wobsoriano Mar 5, 2025
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
14 changes: 13 additions & 1 deletion packages/create-vite/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,12 @@ const FRAMEWORKS: Framework[] = [
color: cyan,
customCommand: 'npm create react-router@latest TARGET_DIR',
},
{
name: 'custom-tanstack-router',
display: 'TanStack Router ↗',
color: cyan,
customCommand: 'npm create -- tsrouter-app@latest TARGET_DIR --framework react',
Copy link
Contributor Author

@wobsoriano wobsoriano Mar 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure if the "--" will be removed when using a different package manager. Without it I'm getting this error:

"error: too many arguments. Expected 1 argument but got"

cc @patak-dev

Copy link
Member

@sapphi-red sapphi-red Mar 5, 2025

Choose a reason for hiding this comment

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

It seems this works with npm and yarn, but doesn't with pnpm and bun.
I think we can strip -- here for pnpm and bun.

vite/packages/create-vite/src/index.ts

Lines 609 to 616 in c0e68da

.replace(/^npm create /, () => {
// `bun create` uses it's own set of templates,
// the closest alternative is using `bun x` directly on the package
if (pkgManager === 'bun') {
return 'bun x create-'
}
return `${pkgManager} create `
})

Copy link
Contributor Author

@wobsoriano wobsoriano Mar 5, 2025

Choose a reason for hiding this comment

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

Thanks, updated! I used this to test the regex:

function testReplace(customCommand, pkgManager) {
  const result = customCommand.replace(/^npm create (?:-- )?/, () => {
    if (pkgManager === 'bun') {
      return 'bun x create-';
    }
    if (pkgManager === 'pnpm') {
      return 'pnpm create ';
    }
    return customCommand.startsWith('npm create -- ') 
      ? `${pkgManager} create -- ` 
      : `${pkgManager} create `;
  });
  
  return result;
}

const testCases = [
  // Regular npm create commands
  { cmd: 'npm create vue@latest TARGET_DIR', pkgManager: 'npm' },
  { cmd: 'npm create vue@latest TARGET_DIR', pkgManager: 'pnpm' },
  { cmd: 'npm create vue@latest TARGET_DIR', pkgManager: 'bun' },
  { cmd: 'npm create vue@latest TARGET_DIR', pkgManager: 'yarn' },
  
  // Commands with --
  { cmd: 'npm create -- tsrouter-app@latest TARGET_DIR --framework react', pkgManager: 'npm' },
  { cmd: 'npm create -- tsrouter-app@latest TARGET_DIR --framework react', pkgManager: 'pnpm' },
  { cmd: 'npm create -- tsrouter-app@latest TARGET_DIR --framework react', pkgManager: 'bun' },
  { cmd: 'npm create -- tsrouter-app@latest TARGET_DIR --framework react', pkgManager: 'yarn' }
];

testCases.forEach(({ cmd, pkgManager }) => {
  const result = testReplace(cmd, pkgManager);
  console.log(`\nInput: ${cmd}`);
  console.log(`Package Manager: ${pkgManager}`);
  console.log(`Result: ${result}`);
});

},
],
},
{
Expand Down Expand Up @@ -223,6 +229,12 @@ const FRAMEWORKS: Framework[] = [
display: 'JavaScript',
color: yellow,
},
{
name: 'custom-tanstack-router',
display: 'TanStack Router ↗',
color: cyan,
customCommand: 'npm create -- tsrouter-app@latest TARGET_DIR --framework solid',
},
],
},
{
Expand Down Expand Up @@ -603,7 +615,7 @@ function editFile(file: string, callback: (content: string) => string) {
function getFullCustomCommand(customCommand: string, pkgInfo?: PkgInfo) {
const pkgManager = pkgInfo ? pkgInfo.name : 'npm'
const isYarn1 = pkgManager === 'yarn' && pkgInfo?.version.startsWith('1.')

return (
customCommand
.replace(/^npm create /, () => {
Expand Down
Loading