create-krispya 0.4.7 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2365 @@
1
+ import color from 'chalk';
2
+
3
+ const HtmlContent = `<!DOCTYPE html>
4
+ <html lang="en">
5
+ <head>
6
+ <meta charset="UTF-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
8
+ <title>$title</title>
9
+ </head>
10
+ <body style="margin: 0; overscroll-behavior: none; user-select: none; touch-action: none;">
11
+ <script type="module" src="$indexPath"><\/script>
12
+ <div style="width: 100dvw; height: 100dvh; overflow: hidden;" id="root"></div>
13
+ </body>
14
+ </html>`;
15
+ const ViteHtmlContent = `<!DOCTYPE html>
16
+ <html lang="en">
17
+ <head>
18
+ <meta charset="UTF-8">
19
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
20
+ <title>$title</title>
21
+ </head>
22
+ <body>
23
+ <div id="app"></div>
24
+ <script type="module" src="$indexPath"><\/script>
25
+ </body>
26
+ </html>`;
27
+ const IndexContent = `import { StrictMode } from 'react'
28
+ import { createRoot } from 'react-dom/client'
29
+ import { App } from './app.js'
30
+
31
+ createRoot(document.getElementById('root')!).render(
32
+ <StrictMode>
33
+ <App />
34
+ </StrictMode>,
35
+ )`;
36
+ const ViteIndexContent = `import './style.css'
37
+
38
+ document.querySelector('#app')!.innerHTML = \`
39
+ <h1>Hello Vite!</h1>
40
+ <p>Edit src/main.ts and save to see HMR in action.</p>
41
+ \``;
42
+ const ViteStyleContent = `body {
43
+ font-family: system-ui, -apple-system, sans-serif;
44
+ margin: 0;
45
+ padding: 2rem;
46
+ min-height: 100vh;
47
+ background: #1a1a1a;
48
+ color: #fff;
49
+ }
50
+
51
+ h1 {
52
+ color: #646cff;
53
+ }
54
+
55
+ a {
56
+ color: #646cff;
57
+ }`;
58
+ const GitAttributes = [
59
+ "* text eol=lf",
60
+ "*.png binary",
61
+ "*.jpg binary",
62
+ "*.jpeg binary",
63
+ "*.gif binary",
64
+ "*.ico binary",
65
+ "*.mov binary",
66
+ "*.mp4 binary",
67
+ "*.mp3 binary",
68
+ "*.flv binary",
69
+ "*.fla binary",
70
+ "*.wav binary",
71
+ "*.swf binary",
72
+ "*.gz binary",
73
+ "*.zip binary",
74
+ "*.7z binary",
75
+ "*.ttf binary",
76
+ "*.eot binary",
77
+ "*.woff binary",
78
+ "*.pyc binary",
79
+ "*.pdf binary",
80
+ "*.glb binary",
81
+ "*.gltf binary"
82
+ ].join("\n");
83
+ const defaultFormatterConfig = {
84
+ printWidth: 102,
85
+ tabWidth: 4,
86
+ useTabs: false,
87
+ semi: true,
88
+ singleQuote: true,
89
+ trailingComma: "es5",
90
+ bracketSpacing: true,
91
+ arrowParens: "always"
92
+ };
93
+ const defaultLinterConfig = {
94
+ ignorePatterns: ["dist"],
95
+ rules: {
96
+ noUnusedVars: {
97
+ level: "warn",
98
+ argsIgnorePattern: "^_",
99
+ varsIgnorePattern: "^_",
100
+ caughtErrorsIgnorePattern: "^_"
101
+ },
102
+ noUnusedExpressions: {
103
+ level: "warn",
104
+ allowShortCircuit: true
105
+ }
106
+ }
107
+ };
108
+
109
+ function generateTypescriptConfig(baseTemplateOrParams) {
110
+ const params = typeof baseTemplateOrParams === "string" ? { baseTemplate: baseTemplateOrParams } : baseTemplateOrParams;
111
+ const { baseTemplate, useConfigPackage } = params;
112
+ const isReact = baseTemplate === "react";
113
+ const isR3f = baseTemplate === "r3f";
114
+ const files = {};
115
+ const devDependencies = {};
116
+ if (isReact || isR3f) {
117
+ devDependencies["@types/react"] = "^19.0.0";
118
+ devDependencies["@types/react-dom"] = "^19.0.0";
119
+ }
120
+ if (isR3f) {
121
+ devDependencies["@types/three"] = "~0.175.0";
122
+ }
123
+ if (useConfigPackage) {
124
+ devDependencies["@config/typescript"] = "workspace:*";
125
+ const baseConfig = isReact || isR3f ? "@config/typescript/react.json" : "@config/typescript/app.json";
126
+ files["tsconfig.json"] = {
127
+ type: "text",
128
+ content: JSON.stringify(
129
+ {
130
+ $schema: "https://json.schemastore.org/tsconfig",
131
+ extends: baseConfig,
132
+ include: ["src/**/*", "tests/**/*"]
133
+ },
134
+ null,
135
+ 2
136
+ )
137
+ };
138
+ return { files, devDependencies };
139
+ }
140
+ const tsConfig = {
141
+ $schema: "https://json.schemastore.org/tsconfig",
142
+ files: [],
143
+ references: [
144
+ { path: "./.config/tsconfig.app.json" },
145
+ { path: "./.config/tsconfig.node.json" }
146
+ ]
147
+ };
148
+ files["tsconfig.json"] = {
149
+ type: "text",
150
+ content: JSON.stringify(tsConfig, null, 2)
151
+ };
152
+ const tsConfigApp = {
153
+ $schema: "https://json.schemastore.org/tsconfig",
154
+ compilerOptions: {
155
+ target: "ESNext",
156
+ module: "ESNext",
157
+ moduleResolution: "bundler",
158
+ lib: ["DOM", "DOM.Iterable", "ESNext"],
159
+ esModuleInterop: true,
160
+ allowSyntheticDefaultImports: true,
161
+ strict: true,
162
+ skipLibCheck: true,
163
+ composite: true,
164
+ rewriteRelativeImportExtensions: true,
165
+ erasableSyntaxOnly: true,
166
+ ...isReact || isR3f ? { jsx: "react-jsx" } : {}
167
+ },
168
+ include: ["../src", "../tests"]
169
+ };
170
+ files[".config/tsconfig.app.json"] = {
171
+ type: "text",
172
+ content: JSON.stringify(tsConfigApp, null, 2)
173
+ };
174
+ const tsConfigNode = {
175
+ $schema: "https://json.schemastore.org/tsconfig",
176
+ compilerOptions: {
177
+ target: "ESNext",
178
+ module: "ESNext",
179
+ moduleResolution: "bundler",
180
+ lib: ["ESNext"],
181
+ esModuleInterop: true,
182
+ allowSyntheticDefaultImports: true,
183
+ strict: true,
184
+ skipLibCheck: true,
185
+ composite: true,
186
+ rewriteRelativeImportExtensions: true,
187
+ erasableSyntaxOnly: true
188
+ },
189
+ include: ["../*.config.ts", "./*.ts"]
190
+ };
191
+ files[".config/tsconfig.node.json"] = {
192
+ type: "text",
193
+ content: JSON.stringify(tsConfigNode, null, 2)
194
+ };
195
+ return { files, devDependencies };
196
+ }
197
+
198
+ function generatePackageJson(params) {
199
+ const {
200
+ name,
201
+ language,
202
+ isLibrary,
203
+ dependencies,
204
+ devDependencies,
205
+ peerDependencies,
206
+ scripts,
207
+ options
208
+ } = params;
209
+ const files = {};
210
+ const packageManager = options.packageManager ?? "pnpm";
211
+ const isPnpm = packageManager === "pnpm";
212
+ const packageJson = {
213
+ name,
214
+ description: "Built with \u{1F339} create-krispya",
215
+ type: "module"
216
+ };
217
+ if (isLibrary) {
218
+ packageJson.main = "./dist/index.mjs";
219
+ packageJson.module = "./dist/index.mjs";
220
+ if (language === "typescript") {
221
+ packageJson.types = "./dist/index.d.ts";
222
+ }
223
+ packageJson.exports = {
224
+ ".": {
225
+ ...language === "typescript" && { types: "./dist/index.d.ts" },
226
+ import: "./dist/index.mjs",
227
+ require: "./dist/index.cjs"
228
+ }
229
+ };
230
+ packageJson.files = ["dist"];
231
+ }
232
+ const sortKeys = (obj) => Object.fromEntries(Object.entries(obj).sort(([a], [b]) => a.localeCompare(b)));
233
+ packageJson.scripts = scripts;
234
+ packageJson.dependencies = sortKeys(dependencies);
235
+ if (Object.keys(devDependencies).length > 0) {
236
+ packageJson.devDependencies = sortKeys(devDependencies);
237
+ }
238
+ if (isLibrary && Object.keys(peerDependencies).length > 0) {
239
+ packageJson.peerDependencies = sortKeys(peerDependencies);
240
+ }
241
+ const isMonorepoPackage = options.workspaceRoot != null;
242
+ if (!isMonorepoPackage) {
243
+ const engines = {};
244
+ if (isPnpm) {
245
+ const pnpmVersion = options.pnpmVersion ?? "10.11.0";
246
+ const majorVersion = pnpmVersion.split(".")[0];
247
+ engines.pnpm = `>=${majorVersion}.0.0`;
248
+ packageJson.packageManager = `pnpm@${pnpmVersion}`;
249
+ }
250
+ if (options.nodeVersion) {
251
+ const majorVersion = options.nodeVersion.split(".")[0];
252
+ engines.node = `>=${majorVersion}.0.0`;
253
+ }
254
+ if (Object.keys(engines).length > 0) {
255
+ packageJson.engines = engines;
256
+ }
257
+ }
258
+ files["package.json"] = {
259
+ type: "text",
260
+ content: JSON.stringify(packageJson, null, 2)
261
+ };
262
+ if (isPnpm && !options.workspaceRoot) {
263
+ const manageVersions = options.pnpmManageVersions ?? true;
264
+ const workspaceLines = [];
265
+ if (manageVersions) {
266
+ workspaceLines.push("manage-package-manager-versions: true", "");
267
+ }
268
+ workspaceLines.push("onlyBuiltDependencies:", " - esbuild");
269
+ files["pnpm-workspace.yaml"] = {
270
+ type: "text",
271
+ content: workspaceLines.join("\n")
272
+ };
273
+ }
274
+ return { files };
275
+ }
276
+
277
+ function generateReadme(params) {
278
+ const {
279
+ name,
280
+ baseTemplate,
281
+ isLibrary,
282
+ libraryBundler,
283
+ packageManager,
284
+ codeSnippets
285
+ } = params;
286
+ const isVanilla = baseTemplate === "vanilla";
287
+ const isReact = baseTemplate === "react";
288
+ const isR3f = baseTemplate === "r3f";
289
+ const ext = "ts";
290
+ const jsxExt = "tsx";
291
+ codeSnippets["readme-libraries"] ??= [];
292
+ codeSnippets["readme-commands"] ??= [];
293
+ if (isLibrary) ; else if (isVanilla) {
294
+ codeSnippets["readme-libraries"].unshift(
295
+ `[Vite](https://vitejs.dev/) - Next generation frontend tooling`
296
+ );
297
+ } else if (isReact) {
298
+ codeSnippets["readme-libraries"].unshift(
299
+ `[React](https://react.dev/) - A JavaScript library for building user interfaces`,
300
+ `[Vite](https://vitejs.dev/) - Next generation frontend tooling`
301
+ );
302
+ } else {
303
+ codeSnippets["readme-libraries"].unshift(
304
+ `[React](https://react.dev/) - A JavaScript library for building user interfaces`,
305
+ `[Three.js](https://threejs.org/) - JavaScript 3D library`,
306
+ `[@react-three/fiber](https://docs.pmnd.rs/react-three-fiber) - lets you create Three.js scenes using React components`
307
+ );
308
+ }
309
+ if (isLibrary) {
310
+ codeSnippets["readme-commands"].unshift(
311
+ `\`${packageManager} install\` to install the dependencies`,
312
+ `\`${packageManager} run build\` to build the library into the \`dist\` folder`,
313
+ `\`${packageManager} run test\` to run the tests`,
314
+ `\`${packageManager} run release\` to build and publish to npm`
315
+ );
316
+ } else {
317
+ codeSnippets["readme-commands"].unshift(
318
+ `\`${packageManager} install\` to install the dependencies`,
319
+ `\`${packageManager} run dev\` to run the development server and preview the app with live updates`,
320
+ `\`${packageManager} run build\` to build the app into the \`dist\` folder`,
321
+ `\`${packageManager} run test\` to run the tests`
322
+ );
323
+ }
324
+ let architectureDesc;
325
+ if (isLibrary) {
326
+ architectureDesc = [
327
+ `- \`src/index.${isReact || isR3f ? jsxExt : ext}\` is the main entry point for your library exports`,
328
+ `- Add your library code in the \`src\` folder`,
329
+ `- \`tests/\` contains your test files`
330
+ ];
331
+ } else if (isVanilla) {
332
+ architectureDesc = [
333
+ `- \`src/main.${ext}\` is the entry point for your application`,
334
+ `- \`tests/\` contains your test files`,
335
+ `- Static assets can be placed in the \`public\` folder`
336
+ ];
337
+ } else if (isReact) {
338
+ architectureDesc = [
339
+ `- \`src/app.${jsxExt}\` defines the main application component`,
340
+ `- \`src/index.${jsxExt}\` renders the React app into the DOM`,
341
+ `- \`tests/\` contains your test files`,
342
+ `- Static assets can be placed in the \`public\` folder`
343
+ ];
344
+ } else {
345
+ architectureDesc = [
346
+ `- \`app.${jsxExt}\` defines the main application component containing your 3D content`,
347
+ `- Modify the content inside the \`<Canvas>\` component to change what is visible on screen`,
348
+ `- \`tests/\` contains your test files`,
349
+ `- Static assets can be placed in the \`public\` folder`
350
+ ];
351
+ }
352
+ const bundlerDescription = isLibrary ? libraryBundler === "unbuild" ? `This library uses [unbuild](https://github.com/unjs/unbuild) for building.` : `This library uses [tsdown](https://github.com/nicepkg/tsdown) for building.` : `This project uses [Vite](https://vitejs.dev/) as the bundler for fast development and optimized production builds.`;
353
+ const content = [
354
+ `# ${name}`,
355
+ `This ${isLibrary ? "library" : "project"} was generated with create-krispya`,
356
+ ...codeSnippets["readme-start"] ?? [],
357
+ "\n",
358
+ `## Project Architecture`,
359
+ bundlerDescription,
360
+ ...architectureDesc,
361
+ "\n",
362
+ `## Libraries`,
363
+ `The following libraries are used - checkout the linked docs to learn more`,
364
+ ...(codeSnippets["readme-libraries"] ?? []).map((library) => `- ${library}`),
365
+ "\n",
366
+ codeSnippets["readme-tools"] && `## Tools`,
367
+ ...(codeSnippets["readme-tools"] ?? []).map((tool) => `- ${tool}`),
368
+ codeSnippets["readme-tools"] && `
369
+ `,
370
+ `## Development Commands`,
371
+ ...(codeSnippets["readme-commands"] ?? []).map((command) => `- ${command}`),
372
+ ...codeSnippets["readme-end"] ?? []
373
+ ].filter(Boolean).join("\n");
374
+ return { type: "text", content };
375
+ }
376
+
377
+ function generateSourceFiles(params) {
378
+ const { name, baseTemplate, language, isLibrary, codeSnippets, replacements } = params;
379
+ const files = {};
380
+ const ext = language === "typescript" ? "ts" : "js";
381
+ const jsxExt = language === "typescript" ? "tsx" : "jsx";
382
+ const isVanilla = baseTemplate === "vanilla";
383
+ const isReact = baseTemplate === "react";
384
+ const isR3f = baseTemplate === "r3f";
385
+ if (isLibrary) {
386
+ const libExt = isReact || isR3f ? jsxExt : ext;
387
+ let libContent;
388
+ if (isVanilla) {
389
+ libContent = [
390
+ `// Library entry point`,
391
+ `export function hello(name: string = "world"): string {`,
392
+ ` return \`Hello, \${name}!\``,
393
+ `}`
394
+ ].join("\n");
395
+ } else if (isReact) {
396
+ libContent = [
397
+ `// Library entry point`,
398
+ `export function MyComponent({ message = "Hello from library!" }: { message?: string }) {`,
399
+ ` return <div>{message}</div>`,
400
+ `}`
401
+ ].join("\n");
402
+ } else {
403
+ libContent = [
404
+ `// Library entry point`,
405
+ `export function MyMesh({ color = "orange" }: { color?: string }) {`,
406
+ ` return (`,
407
+ ` <mesh>`,
408
+ ` <boxGeometry />`,
409
+ ` <meshStandardMaterial color={color} />`,
410
+ ` </mesh>`,
411
+ ` )`,
412
+ `}`
413
+ ].join("\n");
414
+ }
415
+ files[`src/index.${libExt}`] = { type: "text", content: libContent };
416
+ } else if (isVanilla) {
417
+ files[`src/main.${ext}`] = { type: "text", content: ViteIndexContent };
418
+ files["src/style.css"] = { type: "text", content: ViteStyleContent };
419
+ const indexHtml = ViteHtmlContent.replace("$indexPath", `./src/main.${ext}`).replace(
420
+ "$title",
421
+ name
422
+ );
423
+ files["index.html"] = { type: "text", content: indexHtml };
424
+ } else {
425
+ files[`src/index.tsx`] = { type: "text", content: IndexContent };
426
+ const indexHtml = HtmlContent.replace(
427
+ "$indexPath",
428
+ language === "javascript" ? "./src/index.jsx" : "./src/index.tsx"
429
+ ).replace("$title", name);
430
+ files["index.html"] = { type: "text", content: indexHtml };
431
+ codeSnippets["dom-end"]?.reverse();
432
+ codeSnippets["global-end"]?.reverse();
433
+ codeSnippets["scene-end"]?.reverse();
434
+ let appCode;
435
+ if (isReact) {
436
+ appCode = [
437
+ ...codeSnippets["import"] ?? [],
438
+ ...codeSnippets["global-start"] ?? [],
439
+ `export function App() {`,
440
+ " return (",
441
+ ' <div style={{ padding: "2rem" }}>',
442
+ " <h1>Hello React!</h1>",
443
+ " <p>Edit src/app.tsx and save to see changes.</p>",
444
+ " </div>",
445
+ " )",
446
+ "}",
447
+ ...codeSnippets["global-end"] ?? []
448
+ ].join("\n");
449
+ } else {
450
+ appCode = [
451
+ ...codeSnippets["import"] ?? [],
452
+ ...codeSnippets["global-start"] ?? [],
453
+ `export function App() {`,
454
+ " return <>",
455
+ ...codeSnippets["dom-start"] ?? [],
456
+ ...codeSnippets["dom"] ?? [],
457
+ " <Canvas>",
458
+ ...codeSnippets["scene-start"] ?? [],
459
+ ...codeSnippets["scene"] ?? [],
460
+ ...codeSnippets["scene-end"] ?? [],
461
+ " </Canvas>",
462
+ ...codeSnippets["dom-end"] ?? [],
463
+ " </>",
464
+ "}",
465
+ ...codeSnippets["global-end"] ?? []
466
+ ].join("\n");
467
+ }
468
+ for (const { search, replace } of replacements) {
469
+ appCode = appCode.replace(search, replace);
470
+ }
471
+ files[`src/app.tsx`] = { type: "text", content: appCode };
472
+ }
473
+ return files;
474
+ }
475
+
476
+ function generateTestFiles(params) {
477
+ const { baseTemplate, language, isLibrary } = params;
478
+ const files = {};
479
+ const ext = language === "typescript" ? "ts" : "js";
480
+ const jsxExt = language === "typescript" ? "tsx" : "jsx";
481
+ const isVanilla = baseTemplate === "vanilla";
482
+ const isReact = baseTemplate === "react";
483
+ const isR3f = baseTemplate === "r3f";
484
+ if (isLibrary) {
485
+ const testExt = isReact || isR3f ? jsxExt : ext;
486
+ let testContent;
487
+ if (isVanilla) {
488
+ testContent = [
489
+ `import { describe, it, expect } from "vitest"`,
490
+ `import { hello } from "../src/index.js"`,
491
+ ``,
492
+ `describe("hello", () => {`,
493
+ ` it("returns greeting with default name", () => {`,
494
+ ` expect(hello()).toBe("Hello, world!")`,
495
+ ` })`,
496
+ ``,
497
+ ` it("returns greeting with custom name", () => {`,
498
+ ` expect(hello("vitest")).toBe("Hello, vitest!")`,
499
+ ` })`,
500
+ `})`
501
+ ].join("\n");
502
+ } else if (isReact) {
503
+ testContent = [
504
+ `import { describe, it, expect } from "vitest"`,
505
+ `import { render, screen } from "@testing-library/react"`,
506
+ `import { MyComponent } from "../src/index.js"`,
507
+ ``,
508
+ `describe("MyComponent", () => {`,
509
+ ` it("renders with default message", () => {`,
510
+ ` render(<MyComponent />)`,
511
+ ` expect(screen.getByText("Hello from library!")).toBeDefined()`,
512
+ ` })`,
513
+ ``,
514
+ ` it("renders with custom message", () => {`,
515
+ ` render(<MyComponent message="Custom message" />)`,
516
+ ` expect(screen.getByText("Custom message")).toBeDefined()`,
517
+ ` })`,
518
+ `})`
519
+ ].join("\n");
520
+ } else {
521
+ testContent = [
522
+ `import { describe, it, expect } from "vitest"`,
523
+ `import { MyMesh } from "../src/index.js"`,
524
+ ``,
525
+ `describe("MyMesh", () => {`,
526
+ ` it("is defined", () => {`,
527
+ ` expect(MyMesh).toBeDefined()`,
528
+ ` })`,
529
+ `})`
530
+ ].join("\n");
531
+ }
532
+ files[`tests/index.test.${testExt}`] = {
533
+ type: "text",
534
+ content: testContent
535
+ };
536
+ } else if (isVanilla) {
537
+ const testContent = [
538
+ `import { describe, it, expect } from "vitest"`,
539
+ ``,
540
+ `describe("example", () => {`,
541
+ ` it("works", () => {`,
542
+ ` expect(1 + 1).toBe(2)`,
543
+ ` })`,
544
+ `})`
545
+ ].join("\n");
546
+ files[`tests/main.test.${ext}`] = { type: "text", content: testContent };
547
+ } else if (isReact) {
548
+ const testContent = [
549
+ `import { describe, it, expect } from "vitest"`,
550
+ `import { render, screen } from "@testing-library/react"`,
551
+ `import { App } from "../src/app.js"`,
552
+ ``,
553
+ `describe("App", () => {`,
554
+ ` it("renders heading", () => {`,
555
+ ` render(<App />)`,
556
+ ` expect(screen.getByText("Hello React!")).toBeDefined()`,
557
+ ` })`,
558
+ `})`
559
+ ].join("\n");
560
+ files[`tests/app.test.${jsxExt}`] = { type: "text", content: testContent };
561
+ } else {
562
+ const testContent = [
563
+ `import { describe, it, expect } from "vitest"`,
564
+ `import { App } from "../src/app.js"`,
565
+ ``,
566
+ `describe("App", () => {`,
567
+ ` it("is defined", () => {`,
568
+ ` expect(App).toBeDefined()`,
569
+ ` })`,
570
+ `})`
571
+ ].join("\n");
572
+ files[`tests/app.test.${jsxExt}`] = { type: "text", content: testContent };
573
+ }
574
+ return files;
575
+ }
576
+
577
+ function generateVscodeFiles$1(params) {
578
+ const { codeSnippets, vscodeSettings } = params;
579
+ const files = {};
580
+ if (codeSnippets["vscode-extension-suggestion"]?.length) {
581
+ const uniqueRecommendations = [...new Set(codeSnippets["vscode-extension-suggestion"])];
582
+ files[".vscode/extensions.json"] = {
583
+ type: "text",
584
+ content: JSON.stringify(
585
+ {
586
+ recommendations: uniqueRecommendations
587
+ },
588
+ null,
589
+ 2
590
+ )
591
+ };
592
+ }
593
+ if (Object.keys(vscodeSettings).length > 0) {
594
+ files[".vscode/settings.json"] = {
595
+ type: "text",
596
+ content: JSON.stringify(vscodeSettings, null, " ")
597
+ };
598
+ }
599
+ return files;
600
+ }
601
+
602
+ function formatValue(value, indent) {
603
+ const spaces = " ".repeat(indent);
604
+ const innerSpaces = " ".repeat(indent + 1);
605
+ if (typeof value === "string") {
606
+ if (value.startsWith("$raw:")) {
607
+ return value.slice(5);
608
+ }
609
+ return JSON.stringify(value);
610
+ }
611
+ if (typeof value === "number" || typeof value === "boolean") {
612
+ return String(value);
613
+ }
614
+ if (value === null) {
615
+ return "null";
616
+ }
617
+ if (Array.isArray(value)) {
618
+ if (value.length === 0) return "[]";
619
+ const items = value.map((v) => `${innerSpaces}${formatValue(v, indent + 1)}`);
620
+ return `[
621
+ ${items.join(",\n")}
622
+ ${spaces}]`;
623
+ }
624
+ if (typeof value === "object") {
625
+ const entries = Object.entries(value);
626
+ if (entries.length === 0) return "{}";
627
+ const props = entries.map(
628
+ ([key, val]) => `${innerSpaces}${key}: ${formatValue(val, indent + 1)}`
629
+ );
630
+ return `{
631
+ ${props.join(",\n")}
632
+ ${spaces}}`;
633
+ }
634
+ return String(value);
635
+ }
636
+ function generateViteConfig(params) {
637
+ const { viteConfig, codeSnippets } = params;
638
+ const configBody = formatValue(viteConfig, 0);
639
+ const viteConfigContent = [
640
+ `import { defineConfig } from "vite"`,
641
+ ...codeSnippets["vite-config-import"] ?? [],
642
+ ``,
643
+ `export default defineConfig(${configBody})`,
644
+ ``
645
+ ].join("\n");
646
+ return { type: "text", content: viteConfigContent };
647
+ }
648
+
649
+ function generateMonorepo(params) {
650
+ const {
651
+ name,
652
+ linter,
653
+ formatter,
654
+ packageManager,
655
+ pnpmVersion,
656
+ pnpmManageVersions,
657
+ nodeVersion
658
+ } = params;
659
+ const files = {};
660
+ const isPnpm = packageManager === "pnpm";
661
+ const devDependencies = {};
662
+ if (linter === "oxlint") {
663
+ devDependencies["oxlint"] = "^1.36.0";
664
+ } else if (linter === "eslint") {
665
+ devDependencies["eslint"] = "^9.17.0";
666
+ } else if (linter === "biome") {
667
+ devDependencies["@biomejs/biome"] = "^1.9.4";
668
+ }
669
+ if (formatter === "oxfmt") {
670
+ devDependencies["oxfmt"] = "^0.21.0";
671
+ } else if (formatter === "prettier") {
672
+ devDependencies["prettier"] = "^3.4.2";
673
+ }
674
+ const rootPackageJson = {
675
+ name: "root",
676
+ version: "0.0.0",
677
+ private: true,
678
+ type: "module",
679
+ scripts: {
680
+ dev: "pnpm --filter './apps/*' run dev",
681
+ build: "pnpm --filter './packages/*' run build && pnpm --filter './apps/*' run build",
682
+ test: "pnpm -r run test",
683
+ lint: linter === "oxlint" ? "oxlint ." : linter === "biome" ? "biome check ." : "eslint .",
684
+ format: formatter === "oxfmt" ? "oxfmt ." : formatter === "biome" ? "biome format . --write" : "prettier --write ."
685
+ },
686
+ devDependencies
687
+ };
688
+ const engines = {};
689
+ if (isPnpm && pnpmVersion) {
690
+ const majorVersion = pnpmVersion.split(".")[0];
691
+ engines.pnpm = `>=${majorVersion}.0.0`;
692
+ rootPackageJson.packageManager = `pnpm@${pnpmVersion}`;
693
+ }
694
+ if (nodeVersion) {
695
+ const majorVersion = nodeVersion.split(".")[0];
696
+ engines.node = `>=${majorVersion}.0.0`;
697
+ }
698
+ if (Object.keys(engines).length > 0) {
699
+ rootPackageJson.engines = engines;
700
+ }
701
+ files["package.json"] = {
702
+ type: "text",
703
+ content: JSON.stringify(rootPackageJson, null, 2)
704
+ };
705
+ if (isPnpm) {
706
+ const workspaceLines = [];
707
+ if (pnpmManageVersions) {
708
+ workspaceLines.push("manage-package-manager-versions: true", "");
709
+ }
710
+ workspaceLines.push(
711
+ "packages:",
712
+ ' - ".config/*"',
713
+ ' - "apps/*"',
714
+ ' - "packages/*"',
715
+ ""
716
+ );
717
+ workspaceLines.push("onlyBuiltDependencies:", " - esbuild");
718
+ files["pnpm-workspace.yaml"] = {
719
+ type: "text",
720
+ content: workspaceLines.join("\n")
721
+ };
722
+ }
723
+ generateTypescriptConfigPackage(files);
724
+ if (linter === "oxlint") {
725
+ generateOxlintConfigPackage(files);
726
+ } else if (linter === "eslint") {
727
+ files["eslint.config.js"] = {
728
+ type: "text",
729
+ content: `export default [
730
+ // Add your ESLint rules here
731
+ ];
732
+ `
733
+ };
734
+ } else if (linter === "biome") {
735
+ const biomeConfig = {
736
+ $schema: "https://biomejs.dev/schemas/1.9.4/schema.json",
737
+ vcs: {
738
+ enabled: true,
739
+ clientKind: "git",
740
+ useIgnoreFile: true
741
+ },
742
+ linter: {
743
+ enabled: true,
744
+ rules: {
745
+ recommended: true
746
+ }
747
+ },
748
+ formatter: {
749
+ enabled: formatter === "biome"
750
+ }
751
+ };
752
+ files["biome.json"] = {
753
+ type: "text",
754
+ content: JSON.stringify(biomeConfig, null, 2)
755
+ };
756
+ }
757
+ if (formatter === "oxfmt") {
758
+ generateOxfmtConfigPackage(files);
759
+ } else if (formatter === "prettier") {
760
+ const prettierConfig = {
761
+ semi: true,
762
+ singleQuote: false,
763
+ trailingComma: "es5",
764
+ printWidth: 100
765
+ };
766
+ files[".prettierrc.json"] = {
767
+ type: "text",
768
+ content: JSON.stringify(prettierConfig, null, 2)
769
+ };
770
+ }
771
+ files[".gitignore"] = {
772
+ type: "text",
773
+ content: ["node_modules", "dist", "*.tsbuildinfo", ".DS_Store"].join("\n")
774
+ };
775
+ files[".gitattributes"] = {
776
+ type: "text",
777
+ content: `* text=auto eol=lf
778
+ *.{cmd,[cC][mM][dD]} text eol=crlf
779
+ *.{bat,[bB][aA][tT]} text eol=crlf
780
+ `
781
+ };
782
+ generateVscodeFiles(files, linter, formatter);
783
+ files["README.md"] = {
784
+ type: "text",
785
+ content: `# ${name}
786
+
787
+ This monorepo workspace was generated with create-krispya.
788
+
789
+ ## Structure
790
+
791
+ - \`apps/\` - Applications
792
+ - \`packages/\` - Shared packages and libraries
793
+ - \`.config/\` - Shared configuration packages
794
+
795
+ ## Development Commands
796
+
797
+ - \`${packageManager} install\` to install all dependencies
798
+ - \`${packageManager} run dev\` to run all applications in development mode
799
+ - \`${packageManager} run build\` to build all packages and applications
800
+ - \`${packageManager} run test\` to run tests across the workspace
801
+ - \`${packageManager} run lint\` to lint all code
802
+ - \`${packageManager} run format\` to format all code
803
+
804
+ ## Adding Packages
805
+
806
+ To add a new package to this workspace, run create-krispya from this directory and it will detect the monorepo.
807
+ `
808
+ };
809
+ return { files };
810
+ }
811
+ function generateTypescriptConfigPackage(files) {
812
+ const basePath = ".config/typescript";
813
+ files[`${basePath}/package.json`] = {
814
+ type: "text",
815
+ content: JSON.stringify(
816
+ {
817
+ name: "@config/typescript",
818
+ version: "0.1.0",
819
+ private: true,
820
+ files: ["base.json", "app.json", "node.json", "react.json"]
821
+ },
822
+ null,
823
+ 2
824
+ )
825
+ };
826
+ files[`${basePath}/README.md`] = {
827
+ type: "text",
828
+ content: `# \`@config/typescript\`
829
+
830
+ These are base shared \`tsconfig.json\`s from which all other \`tsconfig.json\`s inherit.
831
+
832
+ ## Usage
833
+
834
+ In your package's \`tsconfig.json\`:
835
+
836
+ \`\`\`json
837
+ {
838
+ "extends": "@config/typescript/app.json",
839
+ "include": ["src/**/*", "tests"]
840
+ }
841
+ \`\`\`
842
+
843
+ ## Available Configs
844
+
845
+ - \`base.json\` - Common TypeScript compiler options
846
+ - \`app.json\` - For browser/DOM code (extends base)
847
+ - \`node.json\` - For Node.js code (extends base)
848
+ - \`react.json\` - For React projects with JSX (extends app)
849
+ `
850
+ };
851
+ files[`${basePath}/base.json`] = {
852
+ type: "text",
853
+ content: JSON.stringify(
854
+ {
855
+ $schema: "https://json.schemastore.org/tsconfig",
856
+ compilerOptions: {
857
+ target: "ESNext",
858
+ module: "ESNext",
859
+ moduleResolution: "bundler",
860
+ esModuleInterop: true,
861
+ allowSyntheticDefaultImports: true,
862
+ strict: true,
863
+ skipLibCheck: true,
864
+ composite: true,
865
+ rewriteRelativeImportExtensions: true,
866
+ erasableSyntaxOnly: true
867
+ }
868
+ },
869
+ null,
870
+ 2
871
+ )
872
+ };
873
+ files[`${basePath}/app.json`] = {
874
+ type: "text",
875
+ content: JSON.stringify(
876
+ {
877
+ $schema: "https://json.schemastore.org/tsconfig",
878
+ extends: "./base.json",
879
+ compilerOptions: {
880
+ lib: ["DOM", "DOM.Iterable", "ESNext"]
881
+ }
882
+ },
883
+ null,
884
+ 2
885
+ )
886
+ };
887
+ files[`${basePath}/node.json`] = {
888
+ type: "text",
889
+ content: JSON.stringify(
890
+ {
891
+ $schema: "https://json.schemastore.org/tsconfig",
892
+ extends: "./base.json",
893
+ compilerOptions: {
894
+ lib: ["ESNext"]
895
+ }
896
+ },
897
+ null,
898
+ 2
899
+ )
900
+ };
901
+ files[`${basePath}/react.json`] = {
902
+ type: "text",
903
+ content: JSON.stringify(
904
+ {
905
+ $schema: "https://json.schemastore.org/tsconfig",
906
+ extends: "./app.json",
907
+ compilerOptions: {
908
+ jsx: "react-jsx"
909
+ }
910
+ },
911
+ null,
912
+ 2
913
+ )
914
+ };
915
+ }
916
+ function generateOxlintConfigPackage(files) {
917
+ const basePath = ".config/oxlint";
918
+ const { rules } = defaultLinterConfig;
919
+ files[`${basePath}/package.json`] = {
920
+ type: "text",
921
+ content: JSON.stringify(
922
+ {
923
+ name: "@config/oxlint",
924
+ version: "0.1.0",
925
+ private: true,
926
+ files: ["base.json", "react.json"]
927
+ },
928
+ null,
929
+ 2
930
+ )
931
+ };
932
+ files[`${basePath}/README.md`] = {
933
+ type: "text",
934
+ content: `# \`@config/oxlint\`
935
+
936
+ Shared oxlint configurations for the monorepo.
937
+
938
+ ## Usage
939
+
940
+ Run oxlint with a config:
941
+
942
+ \`\`\`bash
943
+ oxlint -c node_modules/@config/oxlint/base.json
944
+ \`\`\`
945
+
946
+ ## Available Configs
947
+
948
+ - \`base.json\` - Base linting rules for TypeScript projects
949
+ - \`react.json\` - Extends base with React-specific rules
950
+ `
951
+ };
952
+ files[`${basePath}/base.json`] = {
953
+ type: "text",
954
+ content: JSON.stringify(
955
+ {
956
+ $schema: "./node_modules/oxlint/configuration_schema.json",
957
+ plugins: ["unicorn", "typescript", "oxc"],
958
+ rules: {
959
+ "no-unused-vars": [
960
+ rules.noUnusedVars.level,
961
+ {
962
+ argsIgnorePattern: rules.noUnusedVars.argsIgnorePattern,
963
+ varsIgnorePattern: rules.noUnusedVars.varsIgnorePattern,
964
+ caughtErrorsIgnorePattern: rules.noUnusedVars.caughtErrorsIgnorePattern
965
+ }
966
+ ],
967
+ "no-useless-escape": "off",
968
+ "no-unused-expressions": [
969
+ rules.noUnusedExpressions.level,
970
+ { allowShortCircuit: rules.noUnusedExpressions.allowShortCircuit }
971
+ ]
972
+ },
973
+ ignorePatterns: defaultLinterConfig.ignorePatterns
974
+ },
975
+ null,
976
+ 2
977
+ )
978
+ };
979
+ files[`${basePath}/react.json`] = {
980
+ type: "text",
981
+ content: JSON.stringify(
982
+ {
983
+ $schema: "./node_modules/oxlint/configuration_schema.json",
984
+ plugins: ["unicorn", "typescript", "oxc", "react"],
985
+ rules: {
986
+ "no-unused-vars": [
987
+ rules.noUnusedVars.level,
988
+ {
989
+ argsIgnorePattern: rules.noUnusedVars.argsIgnorePattern,
990
+ varsIgnorePattern: rules.noUnusedVars.varsIgnorePattern,
991
+ caughtErrorsIgnorePattern: rules.noUnusedVars.caughtErrorsIgnorePattern
992
+ }
993
+ ],
994
+ "no-useless-escape": "off",
995
+ "no-unused-expressions": [
996
+ rules.noUnusedExpressions.level,
997
+ { allowShortCircuit: rules.noUnusedExpressions.allowShortCircuit }
998
+ ]
999
+ },
1000
+ ignorePatterns: defaultLinterConfig.ignorePatterns
1001
+ },
1002
+ null,
1003
+ 2
1004
+ )
1005
+ };
1006
+ }
1007
+ function generateVscodeFiles(files, linter, formatter) {
1008
+ const recommendations = [];
1009
+ const settings = {};
1010
+ if (linter === "oxlint") {
1011
+ recommendations.push("oxc.oxc-vscode");
1012
+ settings["oxc.enable"] = true;
1013
+ settings["eslint.enable"] = false;
1014
+ settings["biome.enabled"] = false;
1015
+ } else if (linter === "eslint") {
1016
+ recommendations.push("dbaeumer.vscode-eslint");
1017
+ settings["eslint.enable"] = true;
1018
+ settings["oxc.enable"] = false;
1019
+ settings["biome.enabled"] = false;
1020
+ } else if (linter === "biome") {
1021
+ recommendations.push("biomejs.biome");
1022
+ settings["biome.enabled"] = true;
1023
+ settings["eslint.enable"] = false;
1024
+ settings["oxc.enable"] = false;
1025
+ }
1026
+ if (formatter === "oxfmt") {
1027
+ if (!recommendations.includes("oxc.oxc-vscode")) {
1028
+ recommendations.push("oxc.oxc-vscode");
1029
+ }
1030
+ settings["editor.defaultFormatter"] = "oxc.oxc-vscode";
1031
+ settings["[json]"] = { "editor.defaultFormatter": "vscode.json-language-features" };
1032
+ settings["[jsonc]"] = { "editor.defaultFormatter": "vscode.json-language-features" };
1033
+ } else if (formatter === "prettier") {
1034
+ recommendations.push("esbenp.prettier-vscode");
1035
+ settings["editor.defaultFormatter"] = "esbenp.prettier-vscode";
1036
+ } else if (formatter === "biome") {
1037
+ if (!recommendations.includes("biomejs.biome")) {
1038
+ recommendations.push("biomejs.biome");
1039
+ }
1040
+ settings["editor.defaultFormatter"] = "biomejs.biome";
1041
+ }
1042
+ files[".vscode/extensions.json"] = {
1043
+ type: "text",
1044
+ content: JSON.stringify({ recommendations }, null, 2)
1045
+ };
1046
+ files[".vscode/settings.json"] = {
1047
+ type: "text",
1048
+ content: JSON.stringify(settings, null, " ")
1049
+ };
1050
+ }
1051
+ function generateOxfmtConfigPackage(files) {
1052
+ const basePath = ".config/oxfmt";
1053
+ files[`${basePath}/package.json`] = {
1054
+ type: "text",
1055
+ content: JSON.stringify(
1056
+ {
1057
+ name: "@config/oxfmt",
1058
+ version: "0.1.0",
1059
+ private: true,
1060
+ files: ["base.json"]
1061
+ },
1062
+ null,
1063
+ 2
1064
+ )
1065
+ };
1066
+ files[`${basePath}/README.md`] = {
1067
+ type: "text",
1068
+ content: `# \`@config/oxfmt\`
1069
+
1070
+ Shared oxfmt (formatter) configuration for the monorepo.
1071
+
1072
+ ## Usage
1073
+
1074
+ Run oxfmt with the config:
1075
+
1076
+ \`\`\`bash
1077
+ oxfmt -c node_modules/@config/oxfmt/base.json --write .
1078
+ \`\`\`
1079
+
1080
+ ## Available Configs
1081
+
1082
+ - \`base.json\` - Base formatter settings (Prettier-compatible)
1083
+ `
1084
+ };
1085
+ files[`${basePath}/base.json`] = {
1086
+ type: "text",
1087
+ content: JSON.stringify(
1088
+ {
1089
+ printWidth: defaultFormatterConfig.printWidth,
1090
+ tabWidth: defaultFormatterConfig.tabWidth,
1091
+ useTabs: defaultFormatterConfig.useTabs,
1092
+ semi: defaultFormatterConfig.semi,
1093
+ singleQuote: defaultFormatterConfig.singleQuote,
1094
+ trailingComma: defaultFormatterConfig.trailingComma,
1095
+ bracketSpacing: defaultFormatterConfig.bracketSpacing,
1096
+ arrowParens: defaultFormatterConfig.arrowParens
1097
+ },
1098
+ null,
1099
+ 2
1100
+ )
1101
+ };
1102
+ }
1103
+
1104
+ const monorepo = {
1105
+ __proto__: null,
1106
+ generateMonorepo: generateMonorepo
1107
+ };
1108
+
1109
+ function toBiomeLevel(level) {
1110
+ return level;
1111
+ }
1112
+ function generateBiome(generator, options) {
1113
+ if (options == null || !options.linter && !options.formatter) {
1114
+ return;
1115
+ }
1116
+ const version = generator.versions.biome ?? "1.9.4";
1117
+ generator.addDevDependency("@biomejs/biome", `^${version}`);
1118
+ const { rules } = defaultLinterConfig;
1119
+ const biomeConfig = {
1120
+ $schema: "https://biomejs.dev/schemas/1.9.4/schema.json",
1121
+ files: {
1122
+ ignore: defaultLinterConfig.ignorePatterns
1123
+ }
1124
+ };
1125
+ if (options.linter) {
1126
+ biomeConfig.linter = {
1127
+ enabled: true,
1128
+ rules: {
1129
+ recommended: true,
1130
+ correctness: {
1131
+ noUnusedVariables: toBiomeLevel(rules.noUnusedVars.level)
1132
+ }
1133
+ }
1134
+ };
1135
+ } else {
1136
+ biomeConfig.linter = {
1137
+ enabled: false
1138
+ };
1139
+ }
1140
+ if (options.formatter) {
1141
+ biomeConfig.formatter = {
1142
+ enabled: true,
1143
+ lineWidth: defaultFormatterConfig.printWidth,
1144
+ indentWidth: defaultFormatterConfig.tabWidth,
1145
+ indentStyle: "space"
1146
+ };
1147
+ biomeConfig.javascript = {
1148
+ formatter: {
1149
+ semicolons: "always" ,
1150
+ quoteStyle: "single" ,
1151
+ trailingCommas: defaultFormatterConfig.trailingComma,
1152
+ bracketSpacing: defaultFormatterConfig.bracketSpacing,
1153
+ arrowParentheses: "always"
1154
+ }
1155
+ };
1156
+ } else {
1157
+ biomeConfig.formatter = {
1158
+ enabled: false
1159
+ };
1160
+ }
1161
+ generator.addFile("biome.json", {
1162
+ type: "text",
1163
+ content: JSON.stringify(biomeConfig, null, 2)
1164
+ });
1165
+ if (options.linter) {
1166
+ generator.addScript("lint", "biome lint .");
1167
+ }
1168
+ if (options.formatter) {
1169
+ generator.addScript("format", "biome format --write .");
1170
+ }
1171
+ const roles = [];
1172
+ if (options.linter) roles.push("linter");
1173
+ if (options.formatter) roles.push("formatter");
1174
+ generator.inject(
1175
+ "readme-tools",
1176
+ `[Biome](https://biomejs.dev/) - Fast ${roles.join(" and ")} for JavaScript and TypeScript`
1177
+ );
1178
+ generator.inject("vscode-extension-suggestion", "biomejs.biome");
1179
+ generator.addVscodeSetting("biome.enabled", true);
1180
+ if (options.formatter) {
1181
+ generator.addVscodeSetting("editor.defaultFormatter", "biomejs.biome");
1182
+ }
1183
+ }
1184
+
1185
+ function generateDrei(generator, options) {
1186
+ if (options == null) {
1187
+ return;
1188
+ }
1189
+ generator.addDependency("@react-three/drei", "^10.0.0");
1190
+ generator.inject("import", `import { Environment } from "@react-three/drei"`);
1191
+ generator.inject("scene", '<Environment background preset="city" />');
1192
+ generator.inject(
1193
+ "readme-libraries",
1194
+ `[@react-three/drei](https://drei.docs.pmnd.rs/) - Useful helpers for @react-three/fiber`
1195
+ );
1196
+ }
1197
+
1198
+ function getLanguageFromTemplate(template) {
1199
+ return template.endsWith("-js") ? "javascript" : "typescript";
1200
+ }
1201
+ function getBaseTemplate(template) {
1202
+ return template.replace("-js", "");
1203
+ }
1204
+
1205
+ function toEslintLevel(level) {
1206
+ return level;
1207
+ }
1208
+ function generateEslint(generator, options) {
1209
+ const version = generator.versions.eslint ?? "9.17.0";
1210
+ generator.addDevDependency("eslint", `^${version}`);
1211
+ const template = generator.options.template ?? "vanilla";
1212
+ const baseTemplate = getBaseTemplate(template);
1213
+ const isTypescript = getLanguageFromTemplate(template) === "typescript";
1214
+ const isReact = baseTemplate === "react" || baseTemplate === "r3f";
1215
+ const { rules } = defaultLinterConfig;
1216
+ const imports = ['import js from "@eslint/js"'];
1217
+ const configs = ["js.configs.recommended"];
1218
+ if (isTypescript) {
1219
+ generator.addDevDependency("typescript-eslint", "^8.18.0");
1220
+ imports.push('import tseslint from "typescript-eslint"');
1221
+ configs.push("...tseslint.configs.recommended");
1222
+ }
1223
+ if (isReact) {
1224
+ generator.addDevDependency("eslint-plugin-react-hooks", "^5.1.0");
1225
+ imports.push('import reactHooks from "eslint-plugin-react-hooks"');
1226
+ }
1227
+ const ignoresArray = JSON.stringify(defaultLinterConfig.ignorePatterns);
1228
+ const unusedVarsRule = isTypescript ? "@typescript-eslint/no-unused-vars" : "no-unused-vars";
1229
+ const rulesConfig = {
1230
+ [unusedVarsRule]: [
1231
+ toEslintLevel(rules.noUnusedVars.level),
1232
+ {
1233
+ argsIgnorePattern: rules.noUnusedVars.argsIgnorePattern,
1234
+ varsIgnorePattern: rules.noUnusedVars.varsIgnorePattern,
1235
+ caughtErrorsIgnorePattern: rules.noUnusedVars.caughtErrorsIgnorePattern
1236
+ }
1237
+ ],
1238
+ "no-unused-expressions": [
1239
+ toEslintLevel(rules.noUnusedExpressions.level),
1240
+ { allowShortCircuit: rules.noUnusedExpressions.allowShortCircuit }
1241
+ ]
1242
+ };
1243
+ const rulesString = JSON.stringify(rulesConfig, null, 4).replace(/\n/g, "\n ");
1244
+ const configContent = [
1245
+ ...imports,
1246
+ "",
1247
+ "export default [",
1248
+ ` { ignores: ${ignoresArray} },`,
1249
+ ` ${configs.join(",\n ")},`,
1250
+ isReact ? ` {
1251
+ plugins: {
1252
+ "react-hooks": reactHooks,
1253
+ },
1254
+ rules: reactHooks.configs.recommended.rules,
1255
+ },` : "",
1256
+ ` {
1257
+ rules: ${rulesString},
1258
+ },`,
1259
+ "]"
1260
+ ].filter(Boolean).join("\n");
1261
+ generator.addFile("eslint.config.js", {
1262
+ type: "text",
1263
+ content: configContent
1264
+ });
1265
+ generator.addScript("lint", "eslint .");
1266
+ generator.inject(
1267
+ "readme-tools",
1268
+ "[ESLint](https://eslint.org/) - Linter for JavaScript and TypeScript"
1269
+ );
1270
+ generator.inject("vscode-extension-suggestion", "dbaeumer.vscode-eslint");
1271
+ generator.addVscodeSetting("eslint.enable", true);
1272
+ }
1273
+
1274
+ function generateFiber(generator, _options) {
1275
+ generator.inject("import", `import { Box } from "./box.js"`);
1276
+ generator.inject(
1277
+ "scene",
1278
+ [
1279
+ `<ambientLight intensity={Math.PI / 2} />`,
1280
+ `<spotLight position={[10, 10, 10]} angle={0.15} penumbra={1} decay={0} intensity={Math.PI} />`,
1281
+ `<pointLight position={[-10, -10, -10]} decay={0} intensity={Math.PI} />`,
1282
+ `<Box position={[-1.2, 0, 0]} />`,
1283
+ `<Box position={[1.2, 0, 0]} />`
1284
+ ].join("\n")
1285
+ );
1286
+ generator.addFile("src/box.tsx", {
1287
+ type: "text",
1288
+ content: `import type { Mesh } from 'three'
1289
+ import { useRef, useState } from 'react'
1290
+ import { useFrame, ThreeElements } from '@react-three/fiber'
1291
+
1292
+ export function Box(props: ThreeElements['mesh']) {
1293
+ const meshRef = useRef<Mesh>(null!)
1294
+ const [hovered, setHover] = useState(false)
1295
+ const [active, setActive] = useState(false)
1296
+ useFrame((state, delta) => (meshRef.current.rotation.x += delta))
1297
+ return (
1298
+ <mesh
1299
+ {...props}
1300
+ ref={meshRef}
1301
+ scale={active ? 1.5 : 1}
1302
+ onClick={(event) => setActive(!active)}
1303
+ onPointerOver={(event) => setHover(true)}
1304
+ onPointerOut={(event) => setHover(false)}>
1305
+ <boxGeometry args={[1, 1, 1]} />
1306
+ <meshStandardMaterial color={hovered ? 'hotpink' : '#2f74c0'} />
1307
+ </mesh>
1308
+ )
1309
+ }`
1310
+ });
1311
+ }
1312
+
1313
+ function generateGithubPages(generator, options) {
1314
+ if (options === false || (generator.options.packageManager ?? "npm") != "npm") {
1315
+ return;
1316
+ }
1317
+ generator.addFile(".github/workflows/gh-pages.yml", {
1318
+ type: "text",
1319
+ content: `name: Deploy to Github Pages
1320
+
1321
+ on:
1322
+ push:
1323
+ branches:
1324
+ - main
1325
+
1326
+ jobs:
1327
+ build-and-deploy:
1328
+ runs-on: ubuntu-latest
1329
+ permissions:
1330
+ pages: write
1331
+ contents: read
1332
+ id-token: write
1333
+
1334
+ environment:
1335
+ name: github-pages
1336
+ url: \${{ steps.deployment.outputs.page_url }}
1337
+
1338
+ steps:
1339
+ - name: Checkout code
1340
+ uses: actions/checkout@v3
1341
+
1342
+ - name: Setup Node
1343
+ uses: actions/setup-node@v3
1344
+ with:
1345
+ node-version: 20
1346
+
1347
+ - name: Install dependencies
1348
+ run: npm install
1349
+
1350
+ - name: Build project
1351
+ run: npm run build
1352
+
1353
+ - name: Upload artifact
1354
+ uses: actions/upload-pages-artifact@v3
1355
+ with:
1356
+ path: './dist'
1357
+
1358
+ - name: Deploy to GitHub Pages
1359
+ id: deployment
1360
+ uses: actions/deploy-pages@v4
1361
+ `
1362
+ });
1363
+ generator.inject(
1364
+ "readme-start",
1365
+ `A github pages deployment action is configurd.`
1366
+ );
1367
+ if (generator.options.githubUserName != null && generator.options.githubRepoName != null) {
1368
+ const address = `${generator.options.githubUserName}.github.io/${generator.options.githubRepoName}`;
1369
+ generator.inject(
1370
+ "readme-start",
1371
+ `Your app will be publish at [${address}](https://${address}) once the github action is finished.
1372
+ `
1373
+ );
1374
+ }
1375
+ }
1376
+
1377
+ function generateHandle(generator, options) {
1378
+ if (options == null) {
1379
+ return;
1380
+ }
1381
+ generator.addDependency("@react-three/handle", "^6.6.16");
1382
+ generator.inject(
1383
+ "readme-libraries",
1384
+ `[@react-three/handle](https://pmndrs.github.io/xr/docs/handles/introduction) - interactive controls and handles for your 3D objects`
1385
+ );
1386
+ }
1387
+
1388
+ function generateKoota(generator, options) {
1389
+ if (options == null) {
1390
+ return;
1391
+ }
1392
+ generator.addDependency("koota", "^0.4.0");
1393
+ generator.inject(
1394
+ "readme-libraries",
1395
+ `[koota](https://github.com/pmndrs/koota) - ECS-based state management library optimized for real-time apps, games, and XR experiences`
1396
+ );
1397
+ }
1398
+
1399
+ function generateLeva(generator, options) {
1400
+ if (options == null) {
1401
+ return;
1402
+ }
1403
+ generator.addDependency("leva", "^0.10.0");
1404
+ generator.inject(
1405
+ "readme-libraries",
1406
+ `[leva](https://github.com/pmndrs/leva) - HTML GUI panel for React with lightweight, beautiful and extensible controls`
1407
+ );
1408
+ }
1409
+
1410
+ function generateOffscreen(generator, options) {
1411
+ if (options == null) {
1412
+ return;
1413
+ }
1414
+ if (generator.options.xr != null) {
1415
+ console.info(
1416
+ color.blue("Info:"),
1417
+ "@react-three/offscreen is disabled because it is not supported with XR"
1418
+ );
1419
+ return;
1420
+ }
1421
+ generator.addDependency("@react-three/offscreen", "^0.0.8");
1422
+ generator.inject(
1423
+ "readme-libraries",
1424
+ `[@react-three/offscreen](https://github.com/pmndrs/offscreen) - Offload your scene to a worker thread for better performance`
1425
+ );
1426
+ }
1427
+
1428
+ function generateOxfmt(generator, options) {
1429
+ const isMonorepo = generator.options.workspaceRoot != null;
1430
+ if (isMonorepo) {
1431
+ generator.addDevDependency("@config/oxfmt", "workspace:*");
1432
+ const configPath = "node_modules/@config/oxfmt/base.json";
1433
+ generator.addScript("format", `oxfmt -c ${configPath} --write .`);
1434
+ generator.addVscodeSetting("oxc.fmt.configPath", configPath);
1435
+ } else {
1436
+ const version = generator.versions.oxfmt ?? "0.1.0";
1437
+ generator.addDevDependency("oxfmt", `^${version}`);
1438
+ const oxfmtConfig = {
1439
+ printWidth: defaultFormatterConfig.printWidth,
1440
+ tabWidth: defaultFormatterConfig.tabWidth,
1441
+ useTabs: defaultFormatterConfig.useTabs,
1442
+ semi: defaultFormatterConfig.semi,
1443
+ singleQuote: defaultFormatterConfig.singleQuote,
1444
+ trailingComma: defaultFormatterConfig.trailingComma,
1445
+ bracketSpacing: defaultFormatterConfig.bracketSpacing,
1446
+ arrowParens: defaultFormatterConfig.arrowParens
1447
+ };
1448
+ generator.addFile(".config/oxfmt.json", {
1449
+ type: "text",
1450
+ content: JSON.stringify(oxfmtConfig, null, 2)
1451
+ });
1452
+ generator.addScript("format", "oxfmt -c .config/oxfmt.json --write .");
1453
+ generator.addVscodeSetting("oxc.fmt.configPath", ".config/oxfmt.json");
1454
+ }
1455
+ generator.inject(
1456
+ "readme-tools",
1457
+ "[Oxfmt](https://oxc.rs/docs/guide/usage/formatter) - Fast Prettier-compatible code formatter"
1458
+ );
1459
+ generator.inject("vscode-extension-suggestion", "oxc.oxc-vscode");
1460
+ generator.addVscodeSetting("editor.defaultFormatter", "oxc.oxc-vscode");
1461
+ generator.addVscodeSetting("[json]", {
1462
+ "editor.defaultFormatter": "vscode.json-language-features"
1463
+ });
1464
+ generator.addVscodeSetting("[jsonc]", {
1465
+ "editor.defaultFormatter": "vscode.json-language-features"
1466
+ });
1467
+ }
1468
+
1469
+ function toOxlintLevel(level) {
1470
+ return level;
1471
+ }
1472
+ function generateOxlint(generator, options) {
1473
+ const template = generator.options.template ?? "vanilla";
1474
+ const baseTemplate = getBaseTemplate(template);
1475
+ const isReact = baseTemplate === "react" || baseTemplate === "r3f";
1476
+ const isMonorepo = generator.options.workspaceRoot != null;
1477
+ if (isMonorepo) {
1478
+ generator.addDevDependency("@config/oxlint", "workspace:*");
1479
+ const configPath = isReact ? "node_modules/@config/oxlint/react.json" : "node_modules/@config/oxlint/base.json";
1480
+ generator.addScript("lint", `oxlint -c ${configPath}`);
1481
+ generator.addVscodeSetting("oxc.configPath", configPath);
1482
+ } else {
1483
+ const version = generator.versions.oxlint ?? "0.16.0";
1484
+ generator.addDevDependency("oxlint", `^${version}`);
1485
+ const { rules } = defaultLinterConfig;
1486
+ const plugins = ["unicorn", "typescript", "oxc"];
1487
+ if (isReact) {
1488
+ plugins.push("react");
1489
+ }
1490
+ const oxlintConfig = {
1491
+ $schema: "../node_modules/oxlint/configuration_schema.json",
1492
+ plugins,
1493
+ rules: {
1494
+ "no-unused-vars": [
1495
+ toOxlintLevel(rules.noUnusedVars.level),
1496
+ {
1497
+ argsIgnorePattern: rules.noUnusedVars.argsIgnorePattern,
1498
+ varsIgnorePattern: rules.noUnusedVars.varsIgnorePattern,
1499
+ caughtErrorsIgnorePattern: rules.noUnusedVars.caughtErrorsIgnorePattern
1500
+ }
1501
+ ],
1502
+ "no-useless-escape": "off",
1503
+ "no-unused-expressions": [
1504
+ toOxlintLevel(rules.noUnusedExpressions.level),
1505
+ { allowShortCircuit: rules.noUnusedExpressions.allowShortCircuit }
1506
+ ]
1507
+ },
1508
+ ignorePatterns: defaultLinterConfig.ignorePatterns
1509
+ };
1510
+ generator.addFile(".config/oxlint.json", {
1511
+ type: "text",
1512
+ content: JSON.stringify(oxlintConfig, null, 2)
1513
+ });
1514
+ generator.addScript("lint", "oxlint -c .config/oxlint.json");
1515
+ generator.addVscodeSetting("oxc.configPath", ".config/oxlint.json");
1516
+ }
1517
+ generator.inject(
1518
+ "readme-tools",
1519
+ "[Oxlint](https://oxc.rs/docs/guide/usage/linter) - A fast linter for JavaScript and TypeScript"
1520
+ );
1521
+ generator.inject("vscode-extension-suggestion", "oxc.oxc-vscode");
1522
+ generator.addVscodeSetting("oxc.enable", true);
1523
+ }
1524
+
1525
+ function generatePostprocessing(generator, options) {
1526
+ if (options == null) {
1527
+ return;
1528
+ }
1529
+ if (generator.options.xr != null) {
1530
+ console.info(
1531
+ color.blue("Info:"),
1532
+ "@react-three/postprocessing is disabled because it is not supported with XR"
1533
+ );
1534
+ return;
1535
+ }
1536
+ generator.addDependency("@react-three/postprocessing", "^3.0.4");
1537
+ generator.inject(
1538
+ "readme-libraries",
1539
+ `[@react-three/postprocessing](https://react-postprocessing.docs.pmnd.rs/) - Post-processing effects for @react-three/fiber`
1540
+ );
1541
+ }
1542
+
1543
+ function generatePrettier(generator, options) {
1544
+ const version = generator.versions.prettier ?? "3.4.2";
1545
+ generator.addDevDependency("prettier", `^${version}`);
1546
+ const prettierConfig = {
1547
+ $schema: "https://json.schemastore.org/prettierrc",
1548
+ printWidth: defaultFormatterConfig.printWidth,
1549
+ tabWidth: defaultFormatterConfig.tabWidth,
1550
+ useTabs: defaultFormatterConfig.useTabs,
1551
+ semi: defaultFormatterConfig.semi,
1552
+ singleQuote: defaultFormatterConfig.singleQuote,
1553
+ trailingComma: defaultFormatterConfig.trailingComma,
1554
+ bracketSpacing: defaultFormatterConfig.bracketSpacing,
1555
+ arrowParens: defaultFormatterConfig.arrowParens
1556
+ };
1557
+ generator.addFile(".prettierrc", {
1558
+ type: "text",
1559
+ content: JSON.stringify(prettierConfig, null, 2)
1560
+ });
1561
+ generator.addScript("format", "prettier --write .");
1562
+ generator.inject("readme-tools", "[Prettier](https://prettier.io/) - Opinionated code formatter");
1563
+ generator.inject("vscode-extension-suggestion", "esbenp.prettier-vscode");
1564
+ generator.addVscodeSetting("editor.defaultFormatter", "esbenp.prettier-vscode");
1565
+ }
1566
+
1567
+ function generateRapier(generator, options) {
1568
+ if (options == null) {
1569
+ return;
1570
+ }
1571
+ generator.addDependency("@react-three/rapier", "^2.1.0");
1572
+ generator.inject(
1573
+ "readme-libraries",
1574
+ `[@react-three/rapier](https://github.com/pmndrs/react-three-rapier) - Physics based on Rapier for your @react-three/fiber scene`
1575
+ );
1576
+ }
1577
+
1578
+ function unique(...array) {
1579
+ const set = /* @__PURE__ */ new Set();
1580
+ for (const arr of array) {
1581
+ for (const item of arr) {
1582
+ set.add(item);
1583
+ }
1584
+ }
1585
+ return Array.from(set);
1586
+ }
1587
+
1588
+ function generateProvidersModule(generator) {
1589
+ const canvasProviders = [];
1590
+ const globalProviders = [];
1591
+ const providerDefs = {
1592
+ uikit: {
1593
+ type: "layout-effect",
1594
+ props: [
1595
+ {
1596
+ declaredPropDefaultValue: '"light"',
1597
+ declaredPropName: "colorMode",
1598
+ propName: "colorMode",
1599
+ propValue: "colorMode",
1600
+ declaredPropType: '"light" | "dark"'
1601
+ }
1602
+ ],
1603
+ code: `
1604
+ setPreferredColorScheme(colorMode);
1605
+ `,
1606
+ import: 'import { setPreferredColorScheme } from "@react-three/uikit"'
1607
+ },
1608
+ rapier: {
1609
+ component: "Physics",
1610
+ type: "wrapped-jsx",
1611
+ import: 'import { Physics } from "@react-three/rapier";',
1612
+ props: [
1613
+ {
1614
+ declaredPropDefaultValue: false,
1615
+ declaredPropName: "physicsEnabled",
1616
+ propName: "paused",
1617
+ propValue: "!physicsEnabled",
1618
+ declaredPropType: "boolean"
1619
+ },
1620
+ {
1621
+ declaredPropDefaultValue: true,
1622
+ declaredPropName: "debugPhysics",
1623
+ propName: "debug",
1624
+ propValue: "debugPhysics",
1625
+ declaredPropType: "boolean"
1626
+ }
1627
+ ]
1628
+ },
1629
+ postprocessing: {
1630
+ type: "inline-jsx",
1631
+ code: `
1632
+ <EffectComposer enabled={postProcessingEnabled}>
1633
+ <DepthOfField
1634
+ focusDistance={0}
1635
+ focalLength={0.02}
1636
+ bokehScale={2}
1637
+ height={480}
1638
+ />
1639
+ <Bloom luminanceThreshold={0} luminanceSmoothing={0.9} height={300} />
1640
+ </EffectComposer>
1641
+ `,
1642
+ import: 'import { Bloom, DepthOfField, EffectComposer } from "@react-three/postprocessing";',
1643
+ props: [
1644
+ {
1645
+ declaredPropDefaultValue: true,
1646
+ declaredPropName: "postProcessingEnabled",
1647
+ propName: "enabled",
1648
+ propValue: "postProcessingEnabled",
1649
+ declaredPropType: "boolean"
1650
+ }
1651
+ ]
1652
+ }
1653
+ };
1654
+ if (generator.options.rapier) {
1655
+ canvasProviders.push("rapier");
1656
+ }
1657
+ if (!!generator.options.postprocessing && !generator.options.xr) {
1658
+ canvasProviders.push("postprocessing");
1659
+ }
1660
+ if (generator.options.uikit) {
1661
+ globalProviders.push("uikit");
1662
+ }
1663
+ function generateProviderFunction(name, { jsdoc, providers }) {
1664
+ const resolvedProviders = providers.map((provider) => providerDefs[provider]);
1665
+ const providerProps = resolvedProviders.flatMap((provider) => provider.props || []);
1666
+ const providerImports = resolvedProviders.flatMap((provider) => provider.import);
1667
+ const wrappedComponents = resolvedProviders.filter(
1668
+ (provider) => provider.type === "wrapped-jsx"
1669
+ );
1670
+ const inlineComponents = resolvedProviders.filter((provider) => provider.type === "inline-jsx");
1671
+ const layoutEffects = resolvedProviders.filter((provider) => provider.type === "layout-effect");
1672
+ const declaredProps = providerProps.map((prop) => `${prop.declaredPropName} = ${prop.declaredPropDefaultValue}`).join(", ");
1673
+ const declaredTypes = providerProps.map((prop) => `${prop.declaredPropName}?: ${prop.declaredPropType}`).join("; ");
1674
+ const reactImports = ["type ReactNode"];
1675
+ if (layoutEffects.length) {
1676
+ reactImports.push("useLayoutEffect");
1677
+ }
1678
+ return {
1679
+ reactImports,
1680
+ imports: providerImports,
1681
+ code: `
1682
+ /**
1683
+ ${jsdoc.split("\n").map((line) => ` * ${line}`).join("\n")}
1684
+ */
1685
+ export function ${name}({ children, ${declaredProps} }: { children: ReactNode; ${declaredTypes} }) {
1686
+ ${layoutEffects.length ? `
1687
+ useLayoutEffect(() => {
1688
+ ${layoutEffects.map((effect) => effect.code).join("\n")}
1689
+ }, [${layoutEffects.map((effect) => effect.props?.[0]?.propValue)}]);
1690
+ ` : ""}
1691
+ return (
1692
+ <>
1693
+ ${inlineComponents.map((provider) => provider.code)}
1694
+ ${wrappedComponents.reduce((acc, provider) => {
1695
+ const props = provider.props?.map((prop) => `${prop.propName}={${prop.propValue}}`).join(" ");
1696
+ return `<${provider.component} ${props}>${acc}</${provider.component}>`;
1697
+ }, "{children}")}
1698
+ </>
1699
+ );
1700
+ }`
1701
+ };
1702
+ }
1703
+ const global = generateProviderFunction("GlobalProvider", {
1704
+ jsdoc: "The global provider is rendered at the root of your application,\nuse it to set up global configuration like themes.\nProps defined on this component appear as controls inside Triplex.\n\nSee: https://triplex.dev/docs/building-your-scene/providers#global-provider",
1705
+ providers: globalProviders
1706
+ });
1707
+ const canvas = generateProviderFunction("CanvasProvider", {
1708
+ jsdoc: "The canvas provider is rendered as a child inside the React Three Fiber canvas,\nuse it to set up canvas specific configuration like post-processing and physics.\nProps defined on this component appear as controls inside Triplex.\n\nSee: https://triplex.dev/docs/building-your-scene/providers#canvas-provider",
1709
+ providers: canvasProviders
1710
+ });
1711
+ return `
1712
+ import { ${unique(global.reactImports, canvas.reactImports).sort().join(", ")} } from "react";
1713
+ ${unique(global.imports, canvas.imports).sort().join("\n")}
1714
+
1715
+ ${global.code}
1716
+ ${canvas.code}
1717
+ `;
1718
+ }
1719
+ function generateTriplex(generator, options) {
1720
+ if (options == null) {
1721
+ return;
1722
+ }
1723
+ generator.inject("vscode-extension-suggestion", "trytriplex.triplex-vsce");
1724
+ generator.inject(
1725
+ "readme-tools",
1726
+ `[Triplex](https://triplex.dev) - Your visual workspace for React / Three Fiber. Get started by installing [Triplex for VS Code](https://triplex.dev/docs/get-started/vscode). Don't use Visual Studio Code? Download [Triplex Standalone](https://triplex.dev/docs/get-started/standalone).`
1727
+ );
1728
+ generator.addFile(".triplex/providers.tsx", {
1729
+ content: generateProvidersModule(generator),
1730
+ type: "text"
1731
+ });
1732
+ generator.addFile(".triplex/config.json", {
1733
+ content: JSON.stringify(
1734
+ {
1735
+ $schema: "https://triplex.dev/config.schema.json",
1736
+ provider: "./providers.tsx"
1737
+ },
1738
+ null,
1739
+ 2
1740
+ ),
1741
+ type: "text"
1742
+ });
1743
+ }
1744
+
1745
+ function generateTsdown(generator) {
1746
+ generator.addDevDependency("tsdown", "^0.12.0");
1747
+ const template = generator.options.template ?? "vanilla";
1748
+ const baseTemplate = getBaseTemplate(template);
1749
+ const language = getLanguageFromTemplate(template);
1750
+ const isReact = baseTemplate === "react" || baseTemplate === "r3f";
1751
+ const ext = language === "typescript" ? "ts" : "js";
1752
+ const configLines = [
1753
+ `import { defineConfig } from "tsdown"`,
1754
+ ``,
1755
+ `export default defineConfig({`,
1756
+ ` entry: ["./src/index.${ext}${isReact ? "x" : ""}"],`,
1757
+ ` format: ["esm", "cjs"],`,
1758
+ ` dts: ${language === "typescript"},`,
1759
+ ` clean: true,`
1760
+ ];
1761
+ if (isReact) {
1762
+ configLines.push(` esbuild: {`);
1763
+ configLines.push(` jsx: "automatic",`);
1764
+ configLines.push(` },`);
1765
+ }
1766
+ configLines.push(`})`);
1767
+ generator.addFile(`tsdown.config.${ext}`, {
1768
+ type: "text",
1769
+ content: configLines.join("\n")
1770
+ });
1771
+ generator.addScript("build", "tsdown");
1772
+ generator.inject(
1773
+ "readme-libraries",
1774
+ "[tsdown](https://github.com/nicepkg/tsdown) - Fast TypeScript bundler powered by esbuild"
1775
+ );
1776
+ }
1777
+
1778
+ function generateUikit(generator, options) {
1779
+ if (options == null) {
1780
+ return;
1781
+ }
1782
+ generator.addDependency("@react-three/uikit", "^0.8.15");
1783
+ generator.inject(
1784
+ "readme-libraries",
1785
+ `[@react-three/uikit](https://pmndrs.github.io/uikit/docs/) - UI primitives for React Three Fiber`
1786
+ );
1787
+ }
1788
+
1789
+ function generateUnbuild(generator) {
1790
+ generator.addDevDependency("unbuild", "^3.5.0");
1791
+ const template = generator.options.template ?? "vanilla";
1792
+ const baseTemplate = getBaseTemplate(template);
1793
+ const language = getLanguageFromTemplate(template);
1794
+ const isReact = baseTemplate === "react" || baseTemplate === "r3f";
1795
+ const ext = language === "typescript" ? "ts" : "js";
1796
+ const isMonorepo = generator.options.workspaceRoot != null;
1797
+ const buildConfigLines = [
1798
+ `import { defineBuildConfig } from "unbuild"`,
1799
+ ``,
1800
+ `export default defineBuildConfig({`,
1801
+ ` entries: ["./src/index"],`,
1802
+ ` declaration: ${language === "typescript"},`,
1803
+ ` clean: true,`,
1804
+ ` rollup: {`,
1805
+ ` emitCJS: true,`
1806
+ ];
1807
+ if (isReact) {
1808
+ buildConfigLines.push(` esbuild: {`);
1809
+ buildConfigLines.push(` jsx: "automatic",`);
1810
+ buildConfigLines.push(` },`);
1811
+ }
1812
+ buildConfigLines.push(` },`);
1813
+ buildConfigLines.push(`})`);
1814
+ if (isMonorepo) {
1815
+ generator.addFile(`build.config.${ext}`, {
1816
+ type: "text",
1817
+ content: buildConfigLines.join("\n")
1818
+ });
1819
+ generator.addScript("build", "unbuild");
1820
+ } else {
1821
+ generator.addFile(`.config/build.config.${ext}`, {
1822
+ type: "text",
1823
+ content: buildConfigLines.join("\n")
1824
+ });
1825
+ generator.addScript("build", `unbuild --config .config/build.config.${ext}`);
1826
+ }
1827
+ generator.inject(
1828
+ "readme-libraries",
1829
+ "[unbuild](https://github.com/unjs/unbuild) - Unified JavaScript build system"
1830
+ );
1831
+ }
1832
+
1833
+ function generateVitest(generator) {
1834
+ const version = generator.versions.vitest ?? "4.0.0";
1835
+ generator.addDevDependency("vitest", `^${version}`);
1836
+ const template = generator.options.template ?? "vanilla";
1837
+ const baseTemplate = getBaseTemplate(template);
1838
+ const isReact = baseTemplate === "react" || baseTemplate === "r3f";
1839
+ if (isReact) {
1840
+ generator.addDevDependency("@testing-library/react", "^16.2.0");
1841
+ generator.addDevDependency("@testing-library/dom", "^10.4.0");
1842
+ generator.addDevDependency("jsdom", "^26.0.0");
1843
+ }
1844
+ if (isReact) {
1845
+ generator.configureVite({ test: { environment: "jsdom" } });
1846
+ }
1847
+ generator.addScript("test", "vitest");
1848
+ generator.inject(
1849
+ "readme-tools",
1850
+ "[Vitest](https://vitest.dev/) - Fast unit test framework powered by Vite"
1851
+ );
1852
+ }
1853
+
1854
+ function generateViverse(generator, options) {
1855
+ if (options == null || (generator.options.packageManager ?? "npm") != "npm") {
1856
+ return;
1857
+ }
1858
+ generator.addFile(".github/workflows/viverse.yml", {
1859
+ type: "text",
1860
+ content: `name: Deploy to Viverse
1861
+
1862
+ on:
1863
+ push:
1864
+ branches:
1865
+ - main
1866
+ workflow_dispatch:
1867
+
1868
+ jobs:
1869
+ check-secrets:
1870
+ runs-on: ubuntu-latest
1871
+ outputs:
1872
+ secrets-available: \${{ steps.check.outputs.secrets-available }}
1873
+ steps:
1874
+ - id: check
1875
+ run: |
1876
+ if [[ -n "\${{ secrets.VIVERSE_EMAIL }}" && -n "\${{ secrets.VIVERSE_PASSWORD }}" ]]; then
1877
+ echo "secrets-available=true" >> $GITHUB_OUTPUT
1878
+ else
1879
+ echo "secrets-available=false" >> $GITHUB_OUTPUT
1880
+ fi
1881
+
1882
+ build-and-deploy:
1883
+ runs-on: ubuntu-latest
1884
+ needs: check-secrets
1885
+ # Only run if secrets are present
1886
+ if: needs.check-secrets.outputs.secrets-available == 'true'
1887
+ permissions:
1888
+ contents: read
1889
+
1890
+ steps:
1891
+ - name: Checkout code
1892
+ uses: actions/checkout@v3
1893
+
1894
+ - name: Setup Node
1895
+ uses: actions/setup-node@v3
1896
+ with:
1897
+ node-version: 22
1898
+
1899
+ - name: Install dependencies
1900
+ run: npm install
1901
+
1902
+ - name: Build project
1903
+ run: npm run build
1904
+
1905
+ - name: Viverse Login
1906
+ run: npx viverse-cli auth login -e \${{ secrets.VIVERSE_EMAIL }} -p \${{ secrets.VIVERSE_PASSWORD }}
1907
+
1908
+ - name: Deploy to Viverse
1909
+ run: npx viverse-cli app publish ./dist --auto-create-app --name ${generator.options.name}
1910
+
1911
+ `
1912
+ });
1913
+ generator.addDependency("@viverse/cli", "^0.9.5-beta.8");
1914
+ generator.inject(
1915
+ "readme-start",
1916
+ `A GitHub CI/CD workflow for publishing to Viverse is configured.
1917
+
1918
+ To use publish to viverse via the CI/CD workflow:
1919
+ 1. Set \`VIVERSE_EMAIL\` and \`VIVERSE_PASSWORD\` secrets in your repository settings under \`Secrets and Variables\` > \`Actions\` > \`New repository secret\`
1920
+ 2. Manually trigger the "Deploy to Viverse" workflow or push to the main branch
1921
+
1922
+ **Manual CLI Upload:**
1923
+ You can also upload your project manually using the Viverse CLI:
1924
+ \`\`\`bash
1925
+ viverse-cli auth login -e <email> -p <password>
1926
+ npm run build
1927
+ viverse-cli app publish ./dist --auto-create-app --name ${generator.options.name}
1928
+ \`\`\`
1929
+ `
1930
+ );
1931
+ }
1932
+
1933
+ function generateXr(generator, options) {
1934
+ if (options == null || options === false) {
1935
+ return;
1936
+ }
1937
+ if (options === true) {
1938
+ options = {};
1939
+ }
1940
+ generator.addDependency("@react-three/xr", "^6.6.16");
1941
+ generator.addDependency("@vitejs/plugin-basic-ssl", "^2.0.0");
1942
+ generator.inject("import", "import { XR, createXRStore } from '@react-three/xr'");
1943
+ generator.inject(
1944
+ `global-start`,
1945
+ `const store = createXRStore(${JSON.stringify(options.storeOptions ?? {})})`
1946
+ );
1947
+ generator.inject("scene-start", "<XR store={store}>");
1948
+ generator.inject("scene-end", "</XR>");
1949
+ generator.inject("vite-config-import", "import basicSsl from '@vitejs/plugin-basic-ssl'");
1950
+ generator.configureVite({
1951
+ server: {
1952
+ host: true
1953
+ },
1954
+ plugins: ["$raw:basicSsl()"]
1955
+ });
1956
+ generator.inject(
1957
+ "dom-start",
1958
+ `<div style={{
1959
+ display: "flex",
1960
+ flexDirection: "row",
1961
+ gap: "1rem",
1962
+ position: 'absolute',
1963
+ zIndex: 10000,
1964
+ background: 'black',
1965
+ borderRadius: '0.5rem',
1966
+ border: 'none',
1967
+ fontWeight: 'bold',
1968
+ color: 'white',
1969
+ cursor: 'pointer',
1970
+ fontSize: '1.5rem',
1971
+ bottom: '1rem',
1972
+ left: '50%',
1973
+ boxShadow: '0px 0px 20px rgba(0,0,0,1)',
1974
+ transform: 'translate(-50%, 0)',
1975
+ }}><button
1976
+ style={{ cursor: "pointer", padding: '1rem 2rem', fontSize: "1rem", background: "none", color: "white", border: "none" }}
1977
+ onClick={() => store.enterAR()}
1978
+ >
1979
+ Enter AR
1980
+ </button>
1981
+ <button
1982
+ style={{ cursor: "pointer", padding: '1rem 2rem', fontSize: "1rem", background: "none", color: "white", border: "none" }}
1983
+ onClick={() => store.enterVR()}
1984
+ >
1985
+ Enter VR
1986
+ </button></div>`
1987
+ );
1988
+ generator.inject(
1989
+ "readme-libraries",
1990
+ `[@react-three/xr](https://pmndrs.github.io/xr/docs/) - VR/AR support for @react-three/fiber`
1991
+ );
1992
+ }
1993
+
1994
+ function generateZustand(generator, options) {
1995
+ if (options == null) {
1996
+ return;
1997
+ }
1998
+ generator.addDependency("zustand", "^5.0.3");
1999
+ generator.inject(
2000
+ "readme-libraries",
2001
+ `[zustand](https://zustand.docs.pmnd.rs/) - small, fast and scalable state-management solution`
2002
+ );
2003
+ }
2004
+
2005
+ function merge(target, modification) {
2006
+ if (modification == null) {
2007
+ throw new Error(`Cannot merge "${modification}" modification into target "${target}"`);
2008
+ }
2009
+ if (target == null) {
2010
+ return modification;
2011
+ }
2012
+ if (Array.isArray(target)) {
2013
+ if (!Array.isArray(modification)) {
2014
+ throw new Error(
2015
+ `Cannot merge non-array modification "${modification}" into array target "${target}"`
2016
+ );
2017
+ }
2018
+ return [...target, ...modification];
2019
+ }
2020
+ if (typeof target === "object") {
2021
+ if (typeof modification != "object") {
2022
+ throw new Error(
2023
+ `Cannot merge non-object modification "${modification}" into object target "${target}"`
2024
+ );
2025
+ }
2026
+ const result = { ...target };
2027
+ for (const modificationKey in modification) {
2028
+ result[modificationKey] = merge(target[modificationKey], modification[modificationKey]);
2029
+ }
2030
+ return result;
2031
+ }
2032
+ console.warn(`target "${target}" is overwritten with modification "${modification}"`);
2033
+ return modification;
2034
+ }
2035
+
2036
+ async function getLatestNpmVersion(packageName, fallback) {
2037
+ try {
2038
+ const response = await fetch(`https://registry.npmjs.org/${packageName}/latest`);
2039
+ const data = await response.json();
2040
+ return data.version;
2041
+ } catch {
2042
+ return fallback;
2043
+ }
2044
+ }
2045
+ async function getLatestPnpmVersion() {
2046
+ return getLatestNpmVersion("pnpm", "10.11.0");
2047
+ }
2048
+ async function getLatestNodeVersion() {
2049
+ try {
2050
+ const response = await fetch("https://nodejs.org/dist/index.json");
2051
+ const data = await response.json();
2052
+ const ltsVersion = data.find((v) => v.lts);
2053
+ if (ltsVersion) {
2054
+ return ltsVersion.version.replace(/^v/, "");
2055
+ }
2056
+ return "22.0.0";
2057
+ } catch {
2058
+ return "22.0.0";
2059
+ }
2060
+ }
2061
+ function generateRandomName() {
2062
+ const adjectives = [
2063
+ "red",
2064
+ "blue",
2065
+ "green",
2066
+ "yellow",
2067
+ "purple",
2068
+ "orange",
2069
+ "pink",
2070
+ "black",
2071
+ "white",
2072
+ "tiny",
2073
+ "big",
2074
+ "small",
2075
+ "large",
2076
+ "huge",
2077
+ "giant",
2078
+ "mini",
2079
+ "mega",
2080
+ "super",
2081
+ "happy",
2082
+ "sad",
2083
+ "angry",
2084
+ "calm",
2085
+ "quiet",
2086
+ "loud",
2087
+ "silent",
2088
+ "noisy",
2089
+ "shiny",
2090
+ "dull",
2091
+ "bright",
2092
+ "dark",
2093
+ "fuzzy",
2094
+ "smooth",
2095
+ "rough",
2096
+ "soft"
2097
+ ];
2098
+ const nouns = [
2099
+ "apple",
2100
+ "banana",
2101
+ "cherry",
2102
+ "date",
2103
+ "elderberry",
2104
+ "fig",
2105
+ "grape",
2106
+ "honeydew",
2107
+ "cat",
2108
+ "dog",
2109
+ "elephant",
2110
+ "fox",
2111
+ "giraffe",
2112
+ "horse",
2113
+ "iguana",
2114
+ "jaguar",
2115
+ "mountain",
2116
+ "river",
2117
+ "ocean",
2118
+ "desert",
2119
+ "forest",
2120
+ "jungle",
2121
+ "meadow",
2122
+ "valley",
2123
+ "star",
2124
+ "moon",
2125
+ "sun",
2126
+ "planet",
2127
+ "comet",
2128
+ "asteroid",
2129
+ "galaxy",
2130
+ "universe"
2131
+ ];
2132
+ const randomAdjective = adjectives[Math.floor(Math.random() * adjectives.length)];
2133
+ const randomNoun = nouns[Math.floor(Math.random() * nouns.length)];
2134
+ return `${randomAdjective}-${randomNoun}`;
2135
+ }
2136
+
2137
+ function generate(options) {
2138
+ const clonedOptions = structuredClone(options);
2139
+ const template = clonedOptions.template ?? "vanilla";
2140
+ const baseTemplate = getBaseTemplate(template);
2141
+ const language = getLanguageFromTemplate(template);
2142
+ const isVanilla = baseTemplate === "vanilla";
2143
+ const isReact = baseTemplate === "react";
2144
+ const isR3f = baseTemplate === "r3f";
2145
+ const isLibrary = clonedOptions.projectType === "library";
2146
+ const libraryBundler = clonedOptions.libraryBundler ?? "unbuild";
2147
+ const files = {
2148
+ ...clonedOptions.files
2149
+ };
2150
+ const replacements = clonedOptions.replacements ?? [];
2151
+ const versions = clonedOptions.versions ?? {};
2152
+ const dependencies = {
2153
+ ...clonedOptions.dependencies
2154
+ };
2155
+ const devDependencies = {};
2156
+ const peerDependencies = {};
2157
+ if (!isLibrary) {
2158
+ devDependencies.vite = versions.vite ? `^${versions.vite}` : "^6.3.4";
2159
+ }
2160
+ if (isReact || isR3f) {
2161
+ if (isLibrary) {
2162
+ peerDependencies["react"] = "^18.0.0 || ^19.0.0";
2163
+ peerDependencies["react-dom"] = "^18.0.0 || ^19.0.0";
2164
+ } else {
2165
+ dependencies["react"] = "^19.0.0";
2166
+ dependencies["react-dom"] = "^19.0.0";
2167
+ devDependencies["@vitejs/plugin-react"] = "^4.4.1";
2168
+ }
2169
+ }
2170
+ if (isR3f) {
2171
+ if (isLibrary) {
2172
+ peerDependencies["three"] = ">=0.150.0";
2173
+ peerDependencies["@react-three/fiber"] = "^8.0.0 || ^9.0.0";
2174
+ } else {
2175
+ dependencies["three"] = "~0.175.0";
2176
+ dependencies["@react-three/fiber"] = "^9.0.0";
2177
+ }
2178
+ }
2179
+ if (language === "typescript") {
2180
+ const tsResult = generateTypescriptConfig({
2181
+ baseTemplate,
2182
+ useConfigPackage: clonedOptions.workspaceRoot != null
2183
+ });
2184
+ Object.assign(files, tsResult.files);
2185
+ Object.assign(devDependencies, tsResult.devDependencies);
2186
+ }
2187
+ const codeSnippets = {};
2188
+ const vscodeSettings = {};
2189
+ const scripts = isLibrary ? {} : {
2190
+ dev: "vite",
2191
+ build: "vite build"
2192
+ };
2193
+ if (!isLibrary && (isReact || isR3f)) {
2194
+ codeSnippets["vite-config-import"] = ["import react from '@vitejs/plugin-react'"];
2195
+ }
2196
+ if (!isLibrary && isR3f) {
2197
+ codeSnippets["import"] = [`import { Canvas } from "@react-three/fiber"`];
2198
+ }
2199
+ const defaultName = isVanilla ? "vanilla-app" : isReact ? "react-app" : "react-three-app";
2200
+ const name = clonedOptions.name ?? defaultName;
2201
+ let viteConfig = {
2202
+ base: "./"
2203
+ };
2204
+ if (!isLibrary && (isReact || isR3f)) {
2205
+ viteConfig.plugins = ["$raw:react()"];
2206
+ }
2207
+ if (!isLibrary && isR3f) {
2208
+ viteConfig.resolve = { dedupe: ["three"] };
2209
+ }
2210
+ const isMonorepoPackage = clonedOptions.workspaceRoot != null;
2211
+ const generator = {
2212
+ options: clonedOptions,
2213
+ versions,
2214
+ addDependency(name2, semver) {
2215
+ dependencies[name2];
2216
+ dependencies[name2] = semver;
2217
+ },
2218
+ addDevDependency(name2, semver) {
2219
+ devDependencies[name2];
2220
+ devDependencies[name2] = semver;
2221
+ },
2222
+ addFile(path, content) {
2223
+ files[path] = content;
2224
+ },
2225
+ addScript(name2, command) {
2226
+ scripts[name2] = command;
2227
+ },
2228
+ inject(location, code) {
2229
+ let entries = codeSnippets[location];
2230
+ if (entries == null) {
2231
+ codeSnippets[location] = entries = [];
2232
+ }
2233
+ entries.push(code);
2234
+ },
2235
+ replace(search, replace) {
2236
+ replacements.push({ search, replace });
2237
+ },
2238
+ configureVite(config) {
2239
+ viteConfig = merge(viteConfig, config);
2240
+ },
2241
+ addVscodeSetting(key, value) {
2242
+ vscodeSettings[key] = value;
2243
+ }
2244
+ };
2245
+ if (isR3f) {
2246
+ generateDrei(generator, clonedOptions.drei);
2247
+ generateHandle(generator, clonedOptions.handle);
2248
+ generateKoota(generator, clonedOptions.koota);
2249
+ generateLeva(generator, clonedOptions.leva);
2250
+ generateOffscreen(generator, clonedOptions.offscreen);
2251
+ generatePostprocessing(generator, clonedOptions.postprocessing);
2252
+ generateRapier(generator, clonedOptions.rapier);
2253
+ generateUikit(generator, clonedOptions.uikit);
2254
+ generateXr(generator, clonedOptions.xr);
2255
+ generateZustand(generator, clonedOptions.zustand);
2256
+ generateFiber(generator, clonedOptions.fiber);
2257
+ generateTriplex(generator, clonedOptions.triplex);
2258
+ generateViverse(generator, clonedOptions.viverse);
2259
+ }
2260
+ if (!isLibrary) {
2261
+ generateGithubPages(generator, clonedOptions.githubPages);
2262
+ }
2263
+ if (isLibrary) {
2264
+ if (libraryBundler === "unbuild") {
2265
+ generateUnbuild(generator);
2266
+ } else if (libraryBundler === "tsdown") {
2267
+ generateTsdown(generator);
2268
+ }
2269
+ const packageManager2 = clonedOptions.packageManager ?? "pnpm";
2270
+ generator.addScript("release", `${packageManager2} run build && ${packageManager2} publish`);
2271
+ }
2272
+ const testing = clonedOptions.testing ?? (isLibrary ? "vitest" : "none");
2273
+ if (testing === "vitest") {
2274
+ generateVitest(generator);
2275
+ }
2276
+ const linter = clonedOptions.linter;
2277
+ const formatter = clonedOptions.formatter;
2278
+ if (linter === "eslint") {
2279
+ generateEslint(generator);
2280
+ generator.addVscodeSetting("biome.enabled", false);
2281
+ generator.addVscodeSetting("oxc.enable", false);
2282
+ } else if (linter === "oxlint") {
2283
+ generateOxlint(generator);
2284
+ generator.addVscodeSetting("eslint.enable", false);
2285
+ generator.addVscodeSetting("biome.enabled", false);
2286
+ } else if (linter === "biome") {
2287
+ generateBiome(generator, {
2288
+ linter: true,
2289
+ formatter: formatter === "biome"
2290
+ });
2291
+ generator.addVscodeSetting("eslint.enable", false);
2292
+ generator.addVscodeSetting("oxc.enable", false);
2293
+ }
2294
+ if (formatter === "prettier") {
2295
+ generatePrettier(generator);
2296
+ } else if (formatter === "oxfmt") {
2297
+ generateOxfmt(generator);
2298
+ } else if (formatter === "biome" && linter !== "biome") {
2299
+ generateBiome(generator, { linter: false, formatter: true });
2300
+ generator.addVscodeSetting("eslint.enable", false);
2301
+ generator.addVscodeSetting("oxc.enable", false);
2302
+ }
2303
+ for (const { code, location } of clonedOptions.injections ?? []) {
2304
+ generator.inject(location, code);
2305
+ }
2306
+ if (!isLibrary) {
2307
+ files["vite.config.ts"] = generateViteConfig({ viteConfig, codeSnippets });
2308
+ }
2309
+ const packageManager = options.packageManager ?? "pnpm";
2310
+ files["README.md"] = generateReadme({
2311
+ name,
2312
+ baseTemplate,
2313
+ isLibrary,
2314
+ libraryBundler,
2315
+ packageManager,
2316
+ codeSnippets
2317
+ });
2318
+ Object.assign(
2319
+ files,
2320
+ generateSourceFiles({
2321
+ name,
2322
+ baseTemplate,
2323
+ language,
2324
+ isLibrary,
2325
+ codeSnippets,
2326
+ replacements
2327
+ })
2328
+ );
2329
+ if (testing === "vitest") {
2330
+ Object.assign(
2331
+ files,
2332
+ generateTestFiles({
2333
+ baseTemplate,
2334
+ language,
2335
+ isLibrary
2336
+ })
2337
+ );
2338
+ }
2339
+ Object.assign(
2340
+ files,
2341
+ generatePackageJson({
2342
+ name,
2343
+ language,
2344
+ isLibrary,
2345
+ dependencies,
2346
+ devDependencies,
2347
+ peerDependencies,
2348
+ scripts,
2349
+ options: clonedOptions
2350
+ }).files
2351
+ );
2352
+ if (!isMonorepoPackage) {
2353
+ Object.assign(files, generateVscodeFiles$1({ codeSnippets, vscodeSettings }));
2354
+ }
2355
+ if (!isMonorepoPackage) {
2356
+ files[".gitignore"] = {
2357
+ type: "text",
2358
+ content: ["node_modules", "dist", "*.tsbuildinfo"].join("\n")
2359
+ };
2360
+ files[".gitattributes"] = { type: "text", content: GitAttributes };
2361
+ }
2362
+ return files;
2363
+ }
2364
+
2365
+ export { getLanguageFromTemplate as a, generateRandomName as b, getLatestPnpmVersion as c, getLatestNodeVersion as d, getLatestNpmVersion as e, generate as f, getBaseTemplate as g, generateMonorepo as h, monorepo as m };