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