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