Open History to see the last commit
1import type { Environment } from './types.js'
2
3export const SUPPORTED_PACKAGE_MANAGERS = [
4 'npm',
5 'yarn',
6 'pnpm',
7 'bun',
8 'deno',
9] as const
10export type PackageManager = (typeof SUPPORTED_PACKAGE_MANAGERS)[number]
11export const DEFAULT_PACKAGE_MANAGER: PackageManager = 'npm'
12
13export function validatePackageManagerSupport(
14 packageManager: PackageManager,
15 addOns: Array<{
16 name: string
17 supportedPackageManagers?: Array<PackageManager>
18 }>,
19) {
20 const unsupported = addOns.find(
21 (addOn) =>
22 addOn.supportedPackageManagers &&
23 !addOn.supportedPackageManagers.includes(packageManager),
24 )
25
26 const supportedPackageManagers = unsupported?.supportedPackageManagers
27 if (!unsupported || !supportedPackageManagers) return
28
29 throw new Error(
30 `${unsupported.name} does not support the ${packageManager} package manager. Choose ${supportedPackageManagers.join(', ')}.`,
31 )
32}
33
34export function getPackageManager(): PackageManager | undefined {
35 const userAgent = process.env.npm_config_user_agent
36
37 if (userAgent === undefined) {
38 return DEFAULT_PACKAGE_MANAGER
39 }
40
41 const packageManager = SUPPORTED_PACKAGE_MANAGERS.find((manager) =>
42 userAgent.startsWith(manager),
43 )
44
45 return packageManager
46}
47
48export function getPackageManagerScriptCommand(
49 packagerManager: PackageManager,
50 args: Array<string> = [],
51) {
52 switch (packagerManager) {
53 case 'yarn':
54 return { command: 'yarn', args: ['run', ...args] }
55 case 'pnpm':
56 return { command: 'pnpm', args: [...args] }
57 case 'bun':
58 return { command: 'bun', args: ['--bun', 'run', ...args] }
59 case 'deno':
60 return { command: 'deno', args: ['task', ...args] }
61 default:
62 return { command: 'npm', args: ['run', ...args] }
63 }
64}
65
66export function getPackageManagerExecuteCommand(
67 packagerManager: PackageManager,
68 pkg: string,
69 args: Array<string> = [],
70) {
71 switch (packagerManager) {
72 case 'yarn':
73 return { command: 'yarn', args: ['dlx', pkg, ...args] }
74 case 'pnpm':
75 return { command: 'pnpm', args: ['dlx', pkg, ...args] }
76 case 'bun':
77 return { command: 'bunx', args: ['--bun', pkg, ...args] }
78 case 'deno':
79 return { command: 'deno', args: ['run', `npm:${pkg}`, ...args] }
80 default:
81 return { command: 'npx', args: ['-y', pkg, ...args] }
82 }
83}
84
85export const INTENT_PACKAGE = '@tanstack/intent'
86
87export function intentCommand(
88 packageManager: PackageManager,
89 args: Array<string>,
90) {
91 const { command, args: commandArgs } = getPackageManagerExecuteCommand(
92 packageManager,
93 INTENT_PACKAGE,
94 args,
95 )
96 return [command, ...commandArgs].join(' ')
97}
98
99export function getPackageManagerInstallCommand(
100 packagerManager: PackageManager,
101 pkg?: string,
102 isDev: boolean = false,
103) {
104 if (pkg) {
105 switch (packagerManager) {
106 case 'yarn':
107 case 'pnpm':
108 return {
109 command: packagerManager,
110 args: ['add', pkg, isDev ? '--dev' : ''],
111 }
112 default:
113 return {
114 command: packagerManager,
115 args: ['install', pkg, isDev ? '-D' : ''],
116 }
117 }
118 } else {
119 return {
120 command: packagerManager,
121 args: ['install'],
122 }
123 }
124}
125
126export function packageManagerInstall(
127 environment: Environment,
128 cwd: string,
129 packagerManager: PackageManager,
130 pkg?: string,
131) {
132 const { command, args: commandArgs } = getPackageManagerInstallCommand(
133 packagerManager,
134 pkg,
135 )
136 return environment.execute(command, commandArgs, cwd)
137}
138
139export function translateExecuteCommand(
140 packageManager: PackageManager,
141 command: { command: string; args?: Array<string> },
142): { command: string; args: Array<string> } {
143 const args = command.args || []
144 const parsed = parseExecuteCommand(command.command, args)
145 if (parsed) {
146 return getPackageManagerExecuteCommand(packageManager, parsed.pkg, parsed.args)
147 }
148 return { command: command.command, args }
149}
150
151function parseExecuteCommand(
152 command: string,
153 args: Array<string>,
154): { pkg: string; args: Array<string> } | null {
155 if (command === 'npx') {
156 const filtered = args[0] === '-y' ? args.slice(1) : args
157 const [pkg, ...rest] = filtered
158 return pkg ? { pkg, args: rest } : null
159 }
160 if (command === 'pnpx' || command === 'bunx') {
161 const filtered = command === 'bunx' && args[0] === '--bun' ? args.slice(1) : args
162 const [pkg, ...rest] = filtered
163 return pkg ? { pkg, args: rest } : null
164 }
165 if ((command === 'pnpm' || command === 'yarn') && args[0] === 'dlx') {
166 const [, pkg, ...rest] = args
167 return pkg ? { pkg, args: rest } : null
168 }
169 if (command === 'deno' && args[0] === 'run' && args[1]?.startsWith('npm:')) {
170 const pkg = args[1].slice(4)
171 return pkg ? { pkg, args: args.slice(2) } : null
172 }
173 return null
174}
175
176export function packageManagerExecute(
177 environment: Environment,
178 cwd: string,
179 packagerManager: PackageManager,
180 pkg: string,
181 args: Array<string>,
182) {
183 const { command, args: commandArgs } = getPackageManagerExecuteCommand(
184 packagerManager,
185 pkg,
186 args,
187 )
188 return environment.execute(command, commandArgs, cwd)
189}