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