Repository navigation
Expand file tree
/
Copy pathpackage-json.js
More file actions
218 lines (198 loc) · 6.58 KB
/
Copy pathpackage-json.js
File metadata and controls
218 lines (198 loc) · 6.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
import { shadcnEnabled } from './features.js';
import { sanitizePackageName } from './names.js';
/**
* Exact dependency versions rv pins in generated projects and checks with doctor/update.
* @type {Readonly<Record<string, string>>}
*/
export const TEMPLATE_VERSIONS = Object.freeze({
react: '19.2.7',
'react-dom': '19.2.7',
vite: '8.1.5',
'@vitejs/plugin-react': '6.0.3',
typescript: '6.0.3',
'@types/node': '24.13.2',
'@types/react': '19.2.17',
'@types/react-dom': '19.2.3',
tailwindcss: '4.3.3',
'@tailwindcss/vite': '4.3.3',
'react-router-dom': '7.18.1',
zustand: '5.0.14',
eslint: '10.7.0',
'@eslint/js': '10.0.1',
globals: '17.7.0',
'eslint-plugin-react-hooks': '7.1.1',
'eslint-plugin-react-refresh': '0.5.3',
prettier: '3.9.6',
'eslint-config-prettier': '10.1.8',
'typescript-eslint': '8.65.0',
'@radix-ui/react-slot': '1.3.1',
'class-variance-authority': '0.7.1',
clsx: '2.1.1',
'tailwind-merge': '3.6.0',
'tw-animate-css': '1.4.0',
});
/** Node engines range written into generated package.json files. */
export const GENERATED_NODE_ENGINES = '^20.19.0 || ^22.13.0 || >=24.0.0';
function version(/** @type {string} */ packageName) {
const value = TEMPLATE_VERSIONS[packageName];
if (!value) throw new Error(`Missing template version for ${packageName}.`);
return value;
}
function sortObject(/** @type {Record<string, string>} */ value = {}) {
return Object.fromEntries(
Object.entries(value).sort(([left], [right]) => left.localeCompare(right)),
);
}
/**
* Builds the package.json object for a new project based on the selected features.
* @param {Features} features - Map of feature key to boolean.
* @param {string} projectName - Desired package name; sanitized, falls back to "my-app".
* @returns {GeneratedPackageJson} Complete package.json contents with sorted dependency maps.
*/
export function buildGeneratedPackageJson(features, projectName) {
/** @type {Record<string, string>} */
const dependencies = {
react: version('react'),
'react-dom': version('react-dom'),
};
if (features.router) {
dependencies['react-router-dom'] = version('react-router-dom');
}
if (features.zustand) {
dependencies.zustand = version('zustand');
}
/** @type {Record<string, string>} */
const devDependencies = {
'@vitejs/plugin-react': version('@vitejs/plugin-react'),
vite: version('vite'),
};
if (features.typescript) {
Object.assign(devDependencies, {
'@types/node': version('@types/node'),
'@types/react': version('@types/react'),
'@types/react-dom': version('@types/react-dom'),
typescript: version('typescript'),
});
}
if (features.tailwind) {
Object.assign(devDependencies, {
'@tailwindcss/vite': version('@tailwindcss/vite'),
tailwindcss: version('tailwindcss'),
});
}
if (shadcnEnabled(features)) {
Object.assign(dependencies, {
'@radix-ui/react-slot': version('@radix-ui/react-slot'),
'class-variance-authority': version('class-variance-authority'),
clsx: version('clsx'),
'tailwind-merge': version('tailwind-merge'),
});
devDependencies['tw-animate-css'] = version('tw-animate-css');
}
if (features.eslint) {
Object.assign(devDependencies, {
'@eslint/js': version('@eslint/js'),
eslint: version('eslint'),
'eslint-config-prettier': version('eslint-config-prettier'),
'eslint-plugin-react-hooks': version('eslint-plugin-react-hooks'),
'eslint-plugin-react-refresh': version('eslint-plugin-react-refresh'),
globals: version('globals'),
prettier: version('prettier'),
});
if (features.typescript) {
devDependencies['typescript-eslint'] = version('typescript-eslint');
}
}
/** @type {Record<string, string>} */
const scripts = {
dev: 'vite',
build: features.typescript ? 'tsc -b && vite build' : 'vite build',
};
if (features.typescript) {
scripts.typecheck = 'tsc -b';
}
if (features.eslint) {
scripts.lint = 'eslint . --max-warnings 0';
scripts['lint:fix'] = 'eslint . --fix';
scripts.format = 'prettier --write .';
scripts['format:check'] = 'prettier --check .';
}
scripts.preview = 'vite preview';
return {
name: sanitizePackageName(projectName) || 'my-app',
private: true,
version: '0.0.0',
type: 'module',
engines: {
node: GENERATED_NODE_ENGINES,
},
scripts,
dependencies: sortObject(dependencies),
devDependencies: sortObject(devDependencies),
};
}
/**
* Merges a generated package.json into an existing one, letting generated scripts,
* engines, and dependency versions win while preserving unrelated existing fields.
* @param {PackageJson} existing - Parsed existing package.json object.
* @param {GeneratedPackageJson} generated - Output of buildGeneratedPackageJson.
* @returns {PackageJson} Merged package.json contents.
* @throws {TypeError} When existing is not a plain JSON object.
*/
export function mergePackageJson(existing, generated) {
if (!existing || typeof existing !== 'object' || Array.isArray(existing)) {
throw new TypeError('Existing package.json must contain a JSON object.');
}
const existingDependencies = { ...(existing.dependencies ?? {}) };
const existingDevDependencies = { ...(existing.devDependencies ?? {}) };
for (const packageName of Object.keys(generated.dependencies)) {
delete existingDevDependencies[packageName];
}
for (const packageName of Object.keys(generated.devDependencies)) {
delete existingDependencies[packageName];
}
const knownKeys = new Set([
'name',
'private',
'version',
'type',
'engines',
'scripts',
'dependencies',
'devDependencies',
]);
const preserved = Object.fromEntries(
Object.entries(existing).filter(([key]) => !knownKeys.has(key)),
);
return {
name: generated.name,
private: true,
version: existing.version ?? generated.version,
type: 'module',
...preserved,
engines: {
...(existing.engines ?? {}),
...generated.engines,
},
scripts: {
...(existing.scripts ?? {}),
...generated.scripts,
},
dependencies: sortObject({
...existingDependencies,
...generated.dependencies,
}),
devDependencies: sortObject({
...existingDevDependencies,
...generated.devDependencies,
}),
};
}
/**
* Serializes a package.json object with two-space indentation and a trailing newline.
* @param {PackageJson} packageJson - Package.json contents.
* @returns {string} JSON text ready to write to disk.
*/
export function serializePackageJson(packageJson) {
return `${JSON.stringify(packageJson, null, 2)}\n`;
}