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