feat(cli): add ultracite, oxlint, fumadocs addons (#427)

This commit is contained in:
Aman Varshney
2025-07-29 00:13:51 +05:30
committed by GitHub
parent 82a4f42eca
commit 216c242f7d
66 changed files with 794 additions and 251 deletions

View File

@@ -1,6 +1,6 @@
import path from "node:path";
import { fileURLToPath } from "node:url";
import type { Frontend, ProjectConfig } from "./types";
import type { Addons, Frontend, ProjectConfig } from "./types";
import { getUserPkgManager } from "./utils/get-package-manager";
const __filename = fileURLToPath(import.meta.url);
@@ -55,10 +55,12 @@ export const dependencyVersionMap = {
"@tauri-apps/cli": "^2.4.0",
"@biomejs/biome": "^2.0.0",
"@biomejs/biome": "^2.1.2",
oxlint: "^1.8.0",
ultracite: "5.1.1",
husky: "^9.1.7",
"lint-staged": "^15.5.0",
"lint-staged": "^16.1.2",
tsx: "^4.19.2",
"@types/node": "^22.13.11",
@@ -119,13 +121,16 @@ export const dependencyVersionMap = {
export type AvailableDependencies = keyof typeof dependencyVersionMap;
export const ADDON_COMPATIBILITY = {
export const ADDON_COMPATIBILITY: Record<Addons, readonly Frontend[]> = {
pwa: ["tanstack-router", "react-router", "solid", "next"],
tauri: ["tanstack-router", "react-router", "nuxt", "svelte", "solid"],
biome: [],
husky: [],
turborepo: [],
starlight: [],
ultracite: [],
oxlint: [],
fumadocs: [],
none: [],
} as const;

View File

@@ -5,7 +5,7 @@ import {
type EnvVariable,
} from "../project-generation/env-setup";
export async function setupCloudflareD1(config: ProjectConfig): Promise<void> {
export async function setupCloudflareD1(config: ProjectConfig) {
const { projectDir } = config;
const envPath = path.join(projectDir, "apps/server", ".env");

View File

@@ -5,7 +5,7 @@ import {
type EnvVariable,
} from "../project-generation/env-setup";
export async function setupDockerCompose(config: ProjectConfig): Promise<void> {
export async function setupDockerCompose(config: ProjectConfig) {
const { database, projectDir, projectName } = config;
if (database === "none" || database === "sqlite") {

View File

@@ -156,7 +156,7 @@ function displayManualSetupInstructions() {
DATABASE_URL="your_connection_string"`);
}
export async function setupNeonPostgres(config: ProjectConfig): Promise<void> {
export async function setupNeonPostgres(config: ProjectConfig) {
const { packageManager, projectDir } = config;
try {

View File

@@ -206,7 +206,7 @@ DATABASE_URL=your_database_url
DATABASE_AUTH_TOKEN=your_auth_token`);
}
export async function setupTurso(config: ProjectConfig): Promise<void> {
export async function setupTurso(config: ProjectConfig) {
const { orm, projectDir } = config;
const _isDrizzle = orm === "drizzle";
const setupSpinner = spinner();

View File

@@ -19,7 +19,7 @@ function exitWithError(message: string): never {
export async function addAddonsToProject(
input: AddInput & { addons: Addons[]; suppressInstallMessage?: boolean },
): Promise<void> {
) {
try {
const projectDir = input.projectDir || process.cwd();

View File

@@ -18,7 +18,7 @@ function exitWithError(message: string): never {
export async function addDeploymentToProject(
input: AddInput & { webDeploy: WebDeploy; suppressInstallMessage?: boolean },
): Promise<void> {
) {
try {
const projectDir = input.projectDir || process.cwd();

View File

@@ -136,7 +136,7 @@ export async function createProjectHandler(
}
}
export async function addAddonsHandler(input: AddInput): Promise<void> {
export async function addAddonsHandler(input: AddInput) {
try {
const projectDir = input.projectDir || process.cwd();
const detectedConfig = await detectProjectConfig(projectDir);

View File

@@ -12,7 +12,7 @@ export interface EnvVariable {
export async function addEnvVariablesToFile(
filePath: string,
variables: EnvVariable[],
): Promise<void> {
) {
await fs.ensureDir(path.dirname(filePath));
let envContent = "";
@@ -84,9 +84,7 @@ export async function addEnvVariablesToFile(
}
}
export async function setupEnvironmentVariables(
config: ProjectConfig,
): Promise<void> {
export async function setupEnvironmentVariables(config: ProjectConfig) {
const { backend, frontend, database, auth, examples, dbSetup, projectDir } =
config;

View File

@@ -2,10 +2,7 @@ import { log } from "@clack/prompts";
import { $ } from "execa";
import pc from "picocolors";
export async function initializeGit(
projectDir: string,
useGit: boolean,
): Promise<void> {
export async function initializeGit(projectDir: string, useGit: boolean) {
if (!useGit) return;
const gitVersionResult = await $({

View File

@@ -142,6 +142,10 @@ export async function displayPostInstallInstructions(
output += `${pc.cyan("•")} Docs: http://localhost:4321\n`;
}
if (addons?.includes("fumadocs")) {
output += `${pc.cyan("•")} Fumadocs: http://localhost:4000\n`;
}
if (nativeInstructions) output += `\n${nativeInstructions.trim()}\n`;
if (databaseInstructions) output += `\n${databaseInstructions.trim()}\n`;
if (tauriInstructions) output += `\n${tauriInstructions.trim()}\n`;

View File

@@ -7,7 +7,7 @@ import type { ProjectConfig } from "../../types";
export async function updatePackageConfigurations(
projectDir: string,
options: ProjectConfig,
): Promise<void> {
) {
await updateRootPackageJson(projectDir, options);
if (options.backend !== "convex") {
await updateServerPackageJson(projectDir, options);
@@ -19,7 +19,7 @@ export async function updatePackageConfigurations(
async function updateRootPackageJson(
projectDir: string,
options: ProjectConfig,
): Promise<void> {
) {
const rootPackageJsonPath = path.join(projectDir, "package.json");
if (!(await fs.pathExists(rootPackageJsonPath))) return;
@@ -185,18 +185,6 @@ async function updateRootPackageJson(
}
}
if (options.addons.includes("biome")) {
scripts.check = "biome check --write .";
}
if (options.addons.includes("husky")) {
scripts.prepare = "husky";
packageJson["lint-staged"] = {
"*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": [
"biome check --write .",
],
};
}
try {
const { stdout } = await execa(options.packageManager, ["-v"], {
cwd: projectDir,
@@ -235,7 +223,7 @@ async function updateRootPackageJson(
async function updateServerPackageJson(
projectDir: string,
options: ProjectConfig,
): Promise<void> {
) {
const serverPackageJsonPath = path.join(
projectDir,
"apps/server/package.json",
@@ -287,7 +275,7 @@ async function updateServerPackageJson(
async function updateConvexPackageJson(
projectDir: string,
options: ProjectConfig,
): Promise<void> {
) {
const convexPackageJsonPath = path.join(
projectDir,
"packages/backend/package.json",

View File

@@ -11,7 +11,7 @@ async function processAndCopyFiles(
destDir: string,
context: ProjectConfig,
overwrite = true,
): Promise<void> {
) {
const sourceFiles = await globby(sourcePattern, {
cwd: baseSourceDir,
dot: true,
@@ -54,7 +54,7 @@ async function processAndCopyFiles(
export async function copyBaseTemplate(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
const templateDir = path.join(PKG_ROOT, "templates/base");
await processAndCopyFiles(["**/*"], templateDir, projectDir, context);
}
@@ -62,7 +62,7 @@ export async function copyBaseTemplate(
export async function setupFrontendTemplates(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
const hasReactWeb = context.frontend.some((f) =>
["tanstack-router", "react-router", "tanstack-start", "next"].includes(f),
);
@@ -241,7 +241,7 @@ export async function setupFrontendTemplates(
export async function setupBackendFramework(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (context.backend === "none") {
return;
}
@@ -332,7 +332,7 @@ export async function setupBackendFramework(
export async function setupDbOrmTemplates(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (
context.backend === "convex" ||
context.orm === "none" ||
@@ -357,7 +357,7 @@ export async function setupDbOrmTemplates(
export async function setupAuthTemplate(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (context.backend === "convex" || !context.auth) return;
const serverAppDir = path.join(projectDir, "apps/server");
@@ -529,7 +529,7 @@ export async function setupAuthTemplate(
export async function setupAddonsTemplate(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (!context.addons || context.addons.length === 0) return;
for (const addon of context.addons) {
@@ -567,7 +567,7 @@ export async function setupAddonsTemplate(
export async function setupExamplesTemplate(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (
!context.examples ||
context.examples.length === 0 ||
@@ -773,10 +773,7 @@ export async function setupExamplesTemplate(
}
}
export async function handleExtras(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
export async function handleExtras(projectDir: string, context: ProjectConfig) {
const extrasDir = path.join(PKG_ROOT, "templates/extras");
const hasNativeWind = context.frontend.includes("native-nativewind");
const hasUnistyles = context.frontend.includes("native-unistyles");
@@ -790,6 +787,14 @@ export async function handleExtras(
}
}
if (context.packageManager === "bun") {
const bunfigSrc = path.join(extrasDir, "bunfig.toml");
const bunfigDest = path.join(projectDir, "bunfig.toml");
if (await fs.pathExists(bunfigSrc)) {
await fs.copy(bunfigSrc, bunfigDest);
}
}
if (
context.packageManager === "pnpm" &&
(hasNative || context.frontend.includes("nuxt"))
@@ -818,7 +823,7 @@ export async function handleExtras(
export async function setupDockerComposeTemplates(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (context.dbSetup !== "docker" || context.database === "none") {
return;
}
@@ -838,7 +843,7 @@ export async function setupDockerComposeTemplates(
export async function setupDeploymentTemplates(
projectDir: string,
context: ProjectConfig,
): Promise<void> {
) {
if (context.webDeploy === "none") {
return;
}

View File

@@ -1,15 +1,19 @@
import path from "node:path";
import { log } from "@clack/prompts";
import { execa } from "execa";
import fs from "fs-extra";
import pc from "picocolors";
import type { Frontend, ProjectConfig } from "../../types";
import type { Frontend, PackageManager, ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
import { getPackageExecutionCommand } from "../../utils/package-runner";
import { setupFumadocs } from "./fumadocs-setup";
import { setupStarlight } from "./starlight-setup";
import { setupTauri } from "./tauri-setup";
import { setupUltracite } from "./ultracite-setup";
import { addPwaToViteConfig } from "./vite-pwa-setup";
export async function setupAddons(config: ProjectConfig, isAddCommand = false) {
const { addons, frontend, projectDir } = config;
const { addons, frontend, projectDir, packageManager } = config;
const hasReactWebFrontend =
frontend.includes("react-router") ||
frontend.includes("tanstack-router") ||
@@ -53,15 +57,37 @@ ${pc.cyan("Docs:")} ${pc.underline("https://turborepo.com/docs")}
) {
await setupTauri(config);
}
if (addons.includes("biome")) {
await setupBiome(projectDir);
const hasUltracite = addons.includes("ultracite");
const hasBiome = addons.includes("biome");
const hasHusky = addons.includes("husky");
const hasOxlint = addons.includes("oxlint");
if (hasUltracite) {
await setupUltracite(config, hasHusky);
} else {
if (hasBiome) {
await setupBiome(projectDir);
}
if (hasHusky) {
let linter: "biome" | "oxlint" | undefined;
if (hasOxlint) {
linter = "oxlint";
} else if (hasBiome) {
linter = "biome";
}
await setupHusky(projectDir, linter);
}
}
if (addons.includes("husky")) {
await setupHusky(projectDir);
if (addons.includes("oxlint")) {
await setupOxlint(projectDir, packageManager);
}
if (addons.includes("starlight")) {
await setupStarlight(config);
}
if (addons.includes("fumadocs")) {
await setupFumadocs(config);
}
}
function getWebAppDir(projectDir: string, frontends: Frontend[]): string {
@@ -77,7 +103,7 @@ function getWebAppDir(projectDir: string, frontends: Frontend[]): string {
return path.join(projectDir, "apps/web");
}
async function setupBiome(projectDir: string) {
export async function setupBiome(projectDir: string) {
await addPackageDependency({
devDependencies: ["@biomejs/biome"],
projectDir,
@@ -96,7 +122,10 @@ async function setupBiome(projectDir: string) {
}
}
async function setupHusky(projectDir: string) {
export async function setupHusky(
projectDir: string,
linter?: "biome" | "oxlint",
) {
await addPackageDependency({
devDependencies: ["husky", "lint-staged"],
projectDir,
@@ -111,11 +140,21 @@ async function setupHusky(projectDir: string) {
prepare: "husky",
};
packageJson["lint-staged"] = {
"*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": [
"biome check --write .",
],
};
if (linter === "oxlint") {
packageJson["lint-staged"] = {
"**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx,vue,astro,svelte}": "oxlint",
};
} else if (linter === "biome") {
packageJson["lint-staged"] = {
"*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": [
"biome check --write .",
],
};
} else {
packageJson["lint-staged"] = {
"**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx,vue,astro,svelte}": "",
};
}
await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
}
@@ -157,3 +196,33 @@ async function setupPwa(projectDir: string, frontends: Frontend[]) {
await addPwaToViteConfig(viteConfigTs, path.basename(projectDir));
}
}
async function setupOxlint(projectDir: string, packageManager: PackageManager) {
await addPackageDependency({
devDependencies: ["oxlint"],
projectDir,
});
const packageJsonPath = path.join(projectDir, "package.json");
if (await fs.pathExists(packageJsonPath)) {
const packageJson = await fs.readJson(packageJsonPath);
packageJson.scripts = {
...packageJson.scripts,
check: "oxlint",
};
await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
}
const oxlintInitCommand = getPackageExecutionCommand(
packageManager,
"oxlint@latest --init",
);
await execa(oxlintInitCommand, {
cwd: projectDir,
env: { CI: "true" },
shell: true,
});
}

View File

@@ -4,7 +4,7 @@ import type { AvailableDependencies } from "../../constants";
import type { Frontend, ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
export async function setupApi(config: ProjectConfig): Promise<void> {
export async function setupApi(config: ProjectConfig) {
const { api, projectName, frontend, backend, packageManager, projectDir } =
config;
const isConvex = backend === "convex";

View File

@@ -5,7 +5,7 @@ import pc from "picocolors";
import type { ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
export async function setupAuth(config: ProjectConfig): Promise<void> {
export async function setupAuth(config: ProjectConfig) {
const { auth, frontend, backend, projectDir } = config;
if (backend === "convex" || !auth) {
return;

View File

@@ -3,9 +3,7 @@ import type { AvailableDependencies } from "../../constants";
import type { ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
export async function setupBackendDependencies(
config: ProjectConfig,
): Promise<void> {
export async function setupBackendDependencies(config: ProjectConfig) {
const { backend, runtime, api, projectDir } = config;
if (backend === "convex") {

View File

@@ -13,7 +13,7 @@ import { setupPrismaPostgres } from "../database-providers/prisma-postgres-setup
import { setupSupabase } from "../database-providers/supabase-setup";
import { setupTurso } from "../database-providers/turso-setup";
export async function setupDatabase(config: ProjectConfig): Promise<void> {
export async function setupDatabase(config: ProjectConfig) {
const { database, orm, dbSetup, backend, projectDir } = config;
if (backend === "convex" || database === "none") {

View File

@@ -4,7 +4,7 @@ import type { AvailableDependencies } from "../../constants";
import type { ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
export async function setupExamples(config: ProjectConfig): Promise<void> {
export async function setupExamples(config: ProjectConfig) {
const { examples, frontend, backend, projectDir } = config;
if (

View File

@@ -0,0 +1,96 @@
import path from "node:path";
import { cancel, isCancel, log, select } from "@clack/prompts";
import consola from "consola";
import { execa } from "execa";
import fs from "fs-extra";
import pc from "picocolors";
import type { ProjectConfig } from "../../types";
import { getPackageExecutionCommand } from "../../utils/package-runner";
type FumadocsTemplate =
| "next-mdx"
| "next-content-collections"
| "react-router-mdx-remote"
| "tanstack-start-mdx-remote";
const TEMPLATES = {
"next-mdx": {
label: "Next.js: Fumadocs MDX",
hint: "Recommended template with MDX support",
value: "+next+fuma-docs-mdx",
},
"next-content-collections": {
label: "Next.js: Content Collections",
hint: "Template using Next.js content collections",
value: "+next+content-collections",
},
"react-router-mdx-remote": {
label: "React Router: MDX Remote",
hint: "Template for React Router with MDX remote",
value: "react-router",
},
"tanstack-start-mdx-remote": {
label: "Tanstack Start: MDX Remote",
hint: "Template for Tanstack Start with MDX remote",
value: "tanstack-start",
},
} as const;
export async function setupFumadocs(config: ProjectConfig) {
const { packageManager, projectDir } = config;
try {
log.info("Setting up Fumadocs...");
const template = await select<FumadocsTemplate>({
message: "Choose a template",
options: Object.entries(TEMPLATES).map(([key, template]) => ({
value: key as FumadocsTemplate,
label: template.label,
hint: template.hint,
})),
initialValue: "next-mdx",
});
if (isCancel(template)) {
cancel(pc.red("Operation cancelled"));
process.exit(0);
}
const templateArg = TEMPLATES[template].value;
const commandWithArgs = `create-fumadocs-app@latest fumadocs --template ${templateArg} --src --no-install --pm ${packageManager} --no-eslint`;
const fumadocsInitCommand = getPackageExecutionCommand(
packageManager,
commandWithArgs,
);
await execa(fumadocsInitCommand, {
cwd: path.join(projectDir, "apps"),
env: { CI: "true" },
shell: true,
});
const fumadocsDir = path.join(projectDir, "apps", "fumadocs");
const packageJsonPath = path.join(fumadocsDir, "package.json");
if (await fs.pathExists(packageJsonPath)) {
const packageJson = await fs.readJson(packageJsonPath);
packageJson.name = "fumadocs";
if (packageJson.scripts?.dev) {
packageJson.scripts.dev = `${packageJson.scripts.dev} --port=4000`;
}
await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
}
log.success("Fumadocs setup successfully!");
} catch (error) {
log.error(pc.red("Failed to set up Fumadocs"));
if (error instanceof Error) {
consola.error(pc.red(error.message));
}
}
}

View File

@@ -6,7 +6,7 @@ import pc from "picocolors";
import type { Backend, ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
export async function setupRuntime(config: ProjectConfig): Promise<void> {
export async function setupRuntime(config: ProjectConfig) {
const { runtime, backend, projectDir } = config;
if (backend === "convex" || backend === "next" || runtime === "none") {
@@ -28,9 +28,7 @@ export async function setupRuntime(config: ProjectConfig): Promise<void> {
}
}
export async function generateCloudflareWorkerTypes(
config: ProjectConfig,
): Promise<void> {
export async function generateCloudflareWorkerTypes(config: ProjectConfig) {
if (config.runtime !== "workers") {
return;
}
@@ -65,10 +63,7 @@ export async function generateCloudflareWorkerTypes(
}
}
async function setupBunRuntime(
serverDir: string,
_backend: Backend,
): Promise<void> {
async function setupBunRuntime(serverDir: string, _backend: Backend) {
const packageJsonPath = path.join(serverDir, "package.json");
if (!(await fs.pathExists(packageJsonPath))) return;
@@ -88,10 +83,7 @@ async function setupBunRuntime(
});
}
async function setupNodeRuntime(
serverDir: string,
backend: Backend,
): Promise<void> {
async function setupNodeRuntime(serverDir: string, backend: Backend) {
const packageJsonPath = path.join(serverDir, "package.json");
if (!(await fs.pathExists(packageJsonPath))) return;
@@ -123,7 +115,7 @@ async function setupNodeRuntime(
}
}
async function setupWorkersRuntime(serverDir: string): Promise<void> {
async function setupWorkersRuntime(serverDir: string) {
const packageJsonPath = path.join(serverDir, "package.json");
if (!(await fs.pathExists(packageJsonPath))) return;

View File

@@ -6,7 +6,7 @@ import pc from "picocolors";
import type { ProjectConfig } from "../../types";
import { getPackageExecutionCommand } from "../../utils/package-runner";
export async function setupStarlight(config: ProjectConfig): Promise<void> {
export async function setupStarlight(config: ProjectConfig) {
const { packageManager, projectDir } = config;
const s = spinner();

View File

@@ -8,7 +8,7 @@ import type { ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
import { getPackageExecutionCommand } from "../../utils/package-runner";
export async function setupTauri(config: ProjectConfig): Promise<void> {
export async function setupTauri(config: ProjectConfig) {
const { packageManager, frontend, projectDir } = config;
const s = spinner();
const clientPackageDir = path.join(projectDir, "apps/web");

View File

@@ -0,0 +1,141 @@
import { cancel, isCancel, log, multiselect } from "@clack/prompts";
import { execa } from "execa";
import pc from "picocolors";
import type { ProjectConfig } from "../../types";
import { addPackageDependency } from "../../utils/add-package-deps";
import { getPackageExecutionCommand } from "../../utils/package-runner";
import { setupBiome } from "./addons-setup";
type UltraciteEditor = "vscode" | "zed";
type UltraciteRule =
| "vscode-copilot"
| "cursor"
| "windsurf"
| "zed"
| "claude"
| "codex";
const EDITORS = {
vscode: {
label: "VSCode / Cursor / Windsurf",
hint: "Visual Studio Code editor configuration",
},
zed: {
label: "Zed",
hint: "Zed editor configuration",
},
} as const;
const RULES = {
"vscode-copilot": {
label: "VS Code Copilot",
hint: "GitHub Copilot integration for VS Code",
},
cursor: {
label: "Cursor",
hint: "Cursor AI editor configuration",
},
windsurf: {
label: "Windsurf",
hint: "Windsurf editor configuration",
},
zed: {
label: "Zed",
hint: "Zed editor rules",
},
claude: {
label: "Claude",
hint: "Claude AI integration",
},
codex: {
label: "Codex",
hint: "Codex AI integration",
},
} as const;
export async function setupUltracite(config: ProjectConfig, hasHusky: boolean) {
const { packageManager, projectDir } = config;
try {
log.info("Setting up Ultracite...");
await setupBiome(projectDir);
const editors = await multiselect<UltraciteEditor>({
message: "Choose editors",
options: Object.entries(EDITORS).map(([key, editor]) => ({
value: key as UltraciteEditor,
label: editor.label,
hint: editor.hint,
})),
required: false,
});
if (isCancel(editors)) {
cancel(pc.red("Operation cancelled"));
process.exit(0);
}
const rules = await multiselect<UltraciteRule>({
message: "Choose rules",
options: Object.entries(RULES).map(([key, rule]) => ({
value: key as UltraciteRule,
label: rule.label,
hint: rule.hint,
})),
required: false,
});
if (isCancel(rules)) {
cancel(pc.red("Operation cancelled"));
process.exit(0);
}
const ultraciteArgs = ["init", "--pm", packageManager];
if (editors.length > 0) {
ultraciteArgs.push("--editors", ...editors);
}
if (rules.length > 0) {
ultraciteArgs.push("--rules", ...rules);
}
if (hasHusky) {
ultraciteArgs.push("--features", "husky", "lint-staged");
}
const ultraciteArgsString = ultraciteArgs.join(" ");
const commandWithArgs = `ultracite@latest ${ultraciteArgsString} --skip-install`;
const ultraciteInitCommand = getPackageExecutionCommand(
packageManager,
commandWithArgs,
);
await execa(ultraciteInitCommand, {
cwd: projectDir,
env: { CI: "true" },
shell: true,
});
if (hasHusky) {
await addPackageDependency({
devDependencies: ["husky", "lint-staged"],
projectDir,
});
}
await addPackageDependency({
devDependencies: ["ultracite"],
projectDir,
});
log.success("Ultracite setup successfully!");
} catch (error) {
log.error(pc.red("Failed to set up Ultracite"));
if (error instanceof Error) {
console.error(pc.red(error.message));
}
}
}

View File

@@ -9,7 +9,7 @@ import { ensureArrayProperty, tsProject } from "../../utils/ts-morph";
export async function addPwaToViteConfig(
viteConfigPath: string,
projectName: string,
): Promise<void> {
) {
const sourceFile = tsProject.addSourceFileAtPathIfExists(viteConfigPath);
if (!sourceFile) {
throw new Error("vite config not found");

View File

@@ -7,7 +7,7 @@ import { setupSvelteWorkersDeploy } from "./workers-svelte-setup";
import { setupTanstackStartWorkersDeploy } from "./workers-tanstack-start-setup";
import { setupWorkersVitePlugin } from "./workers-vite-setup";
export async function setupWebDeploy(config: ProjectConfig): Promise<void> {
export async function setupWebDeploy(config: ProjectConfig) {
const { webDeploy, frontend, projectDir } = config;
const { packageManager } = config;
@@ -39,7 +39,7 @@ export async function setupWebDeploy(config: ProjectConfig): Promise<void> {
async function setupWorkersWebDeploy(
projectDir: string,
pkgManager: PackageManager,
): Promise<void> {
) {
const webAppDir = path.join(projectDir, "apps/web");
if (!(await fs.pathExists(webAppDir))) {
@@ -65,7 +65,7 @@ async function setupWorkersWebDeploy(
async function setupNextWorkersDeploy(
projectDir: string,
_packageManager: PackageManager,
): Promise<void> {
) {
const webAppDir = path.join(projectDir, "apps/web");
if (!(await fs.pathExists(webAppDir))) return;

View File

@@ -15,7 +15,7 @@ import { tsProject } from "../../utils/ts-morph";
export async function setupNuxtWorkersDeploy(
projectDir: string,
packageManager: PackageManager,
): Promise<void> {
) {
const webAppDir = path.join(projectDir, "apps/web");
if (!(await fs.pathExists(webAppDir))) return;

View File

@@ -8,7 +8,7 @@ import { tsProject } from "../../utils/ts-morph";
export async function setupSvelteWorkersDeploy(
projectDir: string,
packageManager: PackageManager,
): Promise<void> {
) {
const webAppDir = path.join(projectDir, "apps/web");
if (!(await fs.pathExists(webAppDir))) return;

View File

@@ -13,7 +13,7 @@ import { ensureArrayProperty, tsProject } from "../../utils/ts-morph";
export async function setupTanstackStartWorkersDeploy(
projectDir: string,
packageManager: PackageManager,
): Promise<void> {
) {
const webAppDir = path.join(projectDir, "apps/web");
if (!(await fs.pathExists(webAppDir))) return;

View File

@@ -9,9 +9,7 @@ import {
import { addPackageDependency } from "../../utils/add-package-deps";
import { ensureArrayProperty, tsProject } from "../../utils/ts-morph";
export async function setupWorkersVitePlugin(
projectDir: string,
): Promise<void> {
export async function setupWorkersVitePlugin(projectDir: string) {
const webAppDir = path.join(projectDir, "apps/web");
const viteConfigPath = path.join(webAppDir, "vite.config.ts");

View File

@@ -1,4 +1,4 @@
import { cancel, isCancel, multiselect } from "@clack/prompts";
import { cancel, groupMultiselect, isCancel } from "@clack/prompts";
import pc from "picocolors";
import { DEFAULT_CONFIG } from "../constants";
import { type Addons, AddonsSchema, type Frontend } from "../types";
@@ -13,45 +13,61 @@ type AddonOption = {
hint: string;
};
function getAddonDisplay(
addon: Addons,
isRecommended = false,
): { label: string; hint: string } {
function getAddonDisplay(addon: Addons): { label: string; hint: string } {
let label: string;
let hint: string;
if (addon === "turborepo") {
label = isRecommended ? "Turborepo (Recommended)" : "Turborepo";
hint = "High-performance build system for JavaScript and TypeScript";
} else if (addon === "pwa") {
label = "PWA (Progressive Web App)";
hint = "Make your app installable and work offline";
} else if (addon === "tauri") {
label = isRecommended ? "Tauri Desktop App" : "Tauri";
hint = "Build native desktop apps from your web frontend";
} else if (addon === "biome") {
label = "Biome";
hint = isRecommended
? "Add Biome for linting and formatting"
: "Fast formatter and linter for JavaScript, TypeScript, JSX";
} else if (addon === "husky") {
label = "Husky";
hint = isRecommended
? "Add Git hooks with Husky, lint-staged (requires Biome)"
: "Git hooks made easy";
} else if (addon === "starlight") {
label = "Starlight";
hint = isRecommended
? "Add Astro Starlight documentation site"
: "Documentation site with Astro";
} else {
label = addon;
hint = `Add ${addon}`;
switch (addon) {
case "turborepo":
label = "Turborepo";
hint = "High-performance build system";
break;
case "pwa":
label = "PWA (Progressive Web App)";
hint = "Make your app installable and work offline";
break;
case "tauri":
label = "Tauri";
hint = "Build native desktop apps from your web frontend";
break;
case "biome":
label = "Biome";
hint = "Format, lint, and more";
break;
case "oxlint":
label = "Oxlint";
hint = "Rust-powered linter";
break;
case "ultracite":
label = "Ultracite";
hint = "Zero-config Biome preset with AI integration";
break;
case "husky":
label = "Husky";
hint = "Modern native Git hooks made easy";
break;
case "starlight":
label = "Starlight";
hint = "Build stellar docs with astro";
break;
case "fumadocs":
label = "Fumadocs";
hint = "Build excellent documentation site";
break;
default:
label = addon;
hint = `Add ${addon}`;
}
return { label, hint };
}
const ADDON_GROUPS = {
Documentation: ["starlight", "fumadocs"],
Linting: ["biome", "oxlint", "ultracite"],
Other: ["turborepo", "pwa", "tauri", "husky"],
};
export async function getAddonsChoice(
addons?: Addons[],
frontends?: Frontend[],
@@ -59,38 +75,48 @@ export async function getAddonsChoice(
if (addons !== undefined) return addons;
const allAddons = AddonsSchema.options.filter((addon) => addon !== "none");
const groupedOptions: Record<string, AddonOption[]> = {
Documentation: [],
Linting: [],
Other: [],
};
const allPossibleOptions: AddonOption[] = [];
const frontendsArray = frontends || [];
for (const addon of allAddons) {
const { isCompatible } = validateAddonCompatibility(addon, frontends || []);
const { isCompatible } = validateAddonCompatibility(addon, frontendsArray);
if (!isCompatible) continue;
if (isCompatible) {
const { label, hint } = getAddonDisplay(addon, true);
const { label, hint } = getAddonDisplay(addon);
const option = { value: addon, label, hint };
allPossibleOptions.push({
value: addon,
label,
hint,
});
if (ADDON_GROUPS.Documentation.includes(addon)) {
groupedOptions.Documentation.push(option);
} else if (ADDON_GROUPS.Linting.includes(addon)) {
groupedOptions.Linting.push(option);
} else if (ADDON_GROUPS.Other.includes(addon)) {
groupedOptions.Other.push(option);
}
}
const options = allPossibleOptions.sort((a, b) => {
if (a.value === "turborepo") return -1;
if (b.value === "turborepo") return 1;
return 0;
Object.keys(groupedOptions).forEach((group) => {
if (groupedOptions[group].length === 0) {
delete groupedOptions[group];
}
});
const initialValues = DEFAULT_CONFIG.addons.filter((addonValue) =>
options.some((opt) => opt.value === addonValue),
Object.values(groupedOptions).some((options) =>
options.some((opt) => opt.value === addonValue),
),
);
const response = await multiselect({
const response = await groupMultiselect<Addons>({
message: "Select addons",
options: options,
options: groupedOptions,
initialValues: initialValues,
required: false,
selectableGroups: false,
});
if (isCancel(response)) {
@@ -98,10 +124,6 @@ export async function getAddonsChoice(
process.exit(0);
}
if (response.includes("husky") && !response.includes("biome")) {
response.push("biome");
}
return response;
}
@@ -109,34 +131,48 @@ export async function getAddonsToAdd(
frontend: Frontend[],
existingAddons: Addons[] = [],
): Promise<Addons[]> {
const options: AddonOption[] = [];
const groupedOptions: Record<string, AddonOption[]> = {
Documentation: [],
Linting: [],
Other: [],
};
const allAddons = AddonsSchema.options.filter((addon) => addon !== "none");
const frontendArray = frontend || [];
const compatibleAddons = getCompatibleAddons(
allAddons,
frontend,
AddonsSchema.options.filter((addon) => addon !== "none"),
frontendArray,
existingAddons,
);
for (const addon of compatibleAddons) {
const { label, hint } = getAddonDisplay(addon, false);
const { label, hint } = getAddonDisplay(addon);
const option = { value: addon, label, hint };
options.push({
value: addon,
label,
hint,
});
if (ADDON_GROUPS.Documentation.includes(addon)) {
groupedOptions.Documentation.push(option);
} else if (ADDON_GROUPS.Linting.includes(addon)) {
groupedOptions.Linting.push(option);
} else if (ADDON_GROUPS.Other.includes(addon)) {
groupedOptions.Other.push(option);
}
}
if (options.length === 0) {
Object.keys(groupedOptions).forEach((group) => {
if (groupedOptions[group].length === 0) {
delete groupedOptions[group];
}
});
if (Object.keys(groupedOptions).length === 0) {
return [];
}
const response = await multiselect<Addons>({
message: "Select addons",
options: options,
const response = await groupMultiselect<Addons>({
message: "Select addons to add",
options: groupedOptions,
required: false,
selectableGroups: false,
});
if (isCancel(response)) {

View File

@@ -10,7 +10,7 @@ export async function getFrontendChoice(
if (frontendOptions !== undefined) return frontendOptions;
const frontendTypes = await multiselect({
message: "Select platforms to develop for",
message: "Select project type",
options: [
{
value: "web",

View File

@@ -39,7 +39,18 @@ export const FrontendSchema = z
export type Frontend = z.infer<typeof FrontendSchema>;
export const AddonsSchema = z
.enum(["pwa", "tauri", "starlight", "biome", "husky", "turborepo", "none"])
.enum([
"pwa",
"tauri",
"starlight",
"biome",
"husky",
"turborepo",
"fumadocs",
"ultracite",
"oxlint",
"none",
])
.describe("Additional addons");
export type Addons = z.infer<typeof AddonsSchema>;

View File

@@ -7,7 +7,7 @@ export const addPackageDependency = async (opts: {
dependencies?: AvailableDependencies[];
devDependencies?: AvailableDependencies[];
projectDir: string;
}): Promise<void> => {
}) => {
const { dependencies = [], devDependencies = [], projectDir } = opts;
const pkgJsonPath = path.join(projectDir, "package.json");

View File

@@ -6,9 +6,7 @@ import { isTelemetryEnabled } from "./telemetry";
const POSTHOG_API_KEY = process.env.POSTHOG_API_KEY || "";
const POSTHOG_HOST = process.env.POSTHOG_HOST;
export async function trackProjectCreation(
config: ProjectConfig,
): Promise<void> {
export async function trackProjectCreation(config: ProjectConfig) {
const posthog = new PostHog(POSTHOG_API_KEY, {
host: POSTHOG_HOST,
flushAt: 1,

View File

@@ -6,9 +6,7 @@ import { getLatestCLIVersion } from "./get-latest-cli-version";
const BTS_CONFIG_FILE = "bts.jsonc";
export async function writeBtsConfig(
projectConfig: ProjectConfig,
): Promise<void> {
export async function writeBtsConfig(projectConfig: ProjectConfig) {
const btsConfig: BetterTStackConfig = {
version: getLatestCLIVersion(),
createdAt: new Date().toISOString(),
@@ -94,7 +92,7 @@ export async function readBtsConfig(
export async function updateBtsConfig(
projectDir: string,
updates: Partial<Pick<BetterTStackConfig, "addons" | "webDeploy">>,
): Promise<void> {
) {
try {
const configPath = path.join(projectDir, BTS_CONFIG_FILE);

View File

@@ -1,7 +1,7 @@
import { log } from "@clack/prompts";
import { execa } from "execa";
export async function openUrl(url: string): Promise<void> {
export async function openUrl(url: string) {
const platform = process.platform;
let command: string;
let args: string[] = [];

View File

@@ -34,7 +34,7 @@ export async function fetchSponsors(
return sponsors;
}
export function displaySponsors(sponsors: SponsorEntry[]): void {
export function displaySponsors(sponsors: SponsorEntry[]) {
if (sponsors.length === 0) {
log.info("No sponsors found. You can be the first one! ✨");
outro(

View File

@@ -14,7 +14,7 @@ export async function processTemplate(
srcPath: string,
destPath: string,
context: ProjectConfig,
): Promise<void> {
) {
try {
const templateContent = await fs.readFile(srcPath, "utf-8");
const template = handlebars.compile(templateContent);

View File

@@ -500,9 +500,7 @@ export function processAndValidateFlags(
return config;
}
export function validateConfigCompatibility(
config: Partial<ProjectConfig>,
): void {
export function validateConfigCompatibility(config: Partial<ProjectConfig>) {
const effectiveDatabase = config.database;
const effectiveBackend = config.backend;
const effectiveFrontend = config.frontend;
@@ -607,11 +605,6 @@ export function validateConfigCompatibility(
process.exit(1);
}
if (config.addons.includes("husky") && !config.addons.includes("biome")) {
consola.warn(
"Husky addon is recommended to be used with Biome for lint-staged configuration.",
);
}
config.addons = [...new Set(config.addons)];
}

View File

@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
"$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
"vcs": {
"enabled": false,
"clientKind": "git",
@@ -20,7 +20,8 @@
"!**/.nuxt",
"!bts.jsonc",
"!**/.expo",
"!**/.wrangler"
"!**/.wrangler",
"!**/.source"
]
},
"formatter": {

View File

@@ -0,0 +1,22 @@
{
"$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
"files": {
"ignoreUnknown": false,
"includes": [
"**",
"!**/.next",
"!**/dist",
"!**/.turbo",
"!**/dev-dist",
"!**/.zed",
"!**/.vscode",
"!**/routeTree.gen.ts",
"!**/src-tauri",
"!**/.nuxt",
"!bts.jsonc",
"!**/.expo",
"!**/.wrangler",
"!**/.source"
]
}
}

View File

@@ -58,7 +58,7 @@ export default function SignInForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -61,7 +61,7 @@ export default function SignUpForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -58,7 +58,7 @@ export default function SignInForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -61,7 +61,7 @@ export default function SignUpForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -62,7 +62,7 @@ export default function SignInForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -65,7 +65,7 @@ export default function SignUpForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -62,7 +62,7 @@ export default function SignInForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -65,7 +65,7 @@ export default function SignUpForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
className="space-y-4"
>

View File

@@ -53,7 +53,7 @@ export default function SignInForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
class="space-y-4"
>

View File

@@ -56,7 +56,7 @@ export default function SignUpForm({
onSubmit={(e) => {
e.preventDefault();
e.stopPropagation();
void form.handleSubmit();
form.handleSubmit();
}}
class="space-y-4"
>

View File

@@ -0,0 +1,2 @@
[install]
linker = "isolated"

View File

@@ -10,17 +10,6 @@
"start": "vite",
"check-types": "tsc --noEmit"
},
"devDependencies": {
"@tanstack/react-router-devtools": "^1.114.27",
"@tanstack/router-plugin": "^1.114.27",
"@types/node": "^22.13.13",
"@types/react": "^19.0.12",
"@types/react-dom": "^19.0.4",
"@vitejs/plugin-react": "^4.3.4",
"postcss": "^8.5.3",
"tailwindcss": "^4.0.15",
"vite": "^6.2.2"
},
"dependencies": {
"@hookform/resolvers": "^5.1.1",
"radix-ui": "^1.4.2",
@@ -37,5 +26,17 @@
"tailwind-merge": "^3.3.1",
"tw-animate-css": "^1.2.5",
"zod": "^4.0.2"
},
"devDependencies": {
"@tanstack/react-router-devtools": "^1.114.27",
"@tanstack/router-plugin": "^1.114.27",
"@types/node": "^22.13.13",
"@types/react": "^19.0.12",
"@types/react-dom": "^19.0.4",
"@vitejs/plugin-react": "^4.3.4",
"postcss": "^8.5.3",
"typescript": "^5.8.3",
"tailwindcss": "^4.0.15",
"vite": "^6.2.2"
}
}