feat(web/cli/docs): add lefthook options to better-t-stack

Author: therealsamyak

apps/cli/README.md

@@ -58,7 +58,8 @@ Options:
   --auth                          Include authentication
   --no-auth                       Exclude authentication
   --frontend <types...>           Frontend types (tanstack-router, react-router, tanstack-start, next, nuxt, svelte, solid, native-bare, native-uniwind, native-unistyles, none)
-  --addons <types...>             Additional addons (pwa, tauri, starlight, biome, husky, turborepo, fumadocs, ultracite, oxlint, none)
+  --addons <types...>             Additional addons (pwa, tauri, starlight, biome, turborepo, fumadocs, ultracite, oxlint, none)
+  --hooks <type>                   Git hooks manager (lefthook, husky, none)
   --examples <types...>           Examples to include (todo, ai, none)
   --git                           Initialize git repository
   --no-git                        Skip git initialization

apps/cli/src/constants.ts

@@ -24,6 +24,7 @@ export const DEFAULT_CONFIG_BASE = {
   api: "trpc",
   webDeploy: "none",
   serverDeploy: "none",
+  hooks: "none",
 } as const;
 
 export function getDefaultConfig() {
@@ -85,6 +86,7 @@ export const dependencyVersionMap = {
 
   husky: "^9.1.7",
   "lint-staged": "^16.1.2",
+  lefthook: "^2.0.8",
 
   tsx: "^4.19.2",
   "@types/node": "^22.13.11",
@@ -175,7 +177,6 @@ export const ADDON_COMPATIBILITY = {
   pwa: ["tanstack-router", "react-router", "solid", "next"],
   tauri: ["tanstack-router", "react-router", "nuxt", "svelte", "solid", "next"],
   biome: [],
-  husky: [],
   turborepo: [],
   starlight: [],
   ultracite: [],

apps/cli/src/helpers/addons/addons-setup.ts

@@ -58,24 +58,13 @@ ${pc.cyan("Docs:")} ${pc.underline("https://turborepo.com/docs")}
   }
   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);
+    await setupUltracite(config);
   } 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("oxlint")) {
@@ -123,39 +112,6 @@ export async function setupBiome(projectDir: string) {
   }
 }
 
-export async function setupHusky(projectDir: string, linter?: "biome" | "oxlint") {
-  await addPackageDependency({
-    devDependencies: ["husky", "lint-staged"],
-    projectDir,
-  });
-
-  const packageJsonPath = path.join(projectDir, "package.json");
-  if (await fs.pathExists(packageJsonPath)) {
-    const packageJson = await fs.readJson(packageJsonPath);
-
-    packageJson.scripts = {
-      ...packageJson.scripts,
-      prepare: "husky",
-    };
-
-    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 });
-  }
-}
-
 async function setupPwa(projectDir: string, frontends: Frontend[]) {
   const isCompatibleFrontend = frontends.some((f) =>
     ["react-router", "tanstack-router", "solid"].includes(f),

apps/cli/src/helpers/addons/ultracite-setup.ts

@@ -130,8 +130,8 @@ function getFrameworksFromFrontend(frontend: string[]): string[] {
   return Array.from(frameworks);
 }
 
-export async function setupUltracite(config: ProjectConfig, hasHusky: boolean) {
-  const { packageManager, projectDir, frontend } = config;
+export async function setupUltracite(config: ProjectConfig) {
+  const { packageManager, projectDir, frontend, hooks: gitHooks } = config;
 
   try {
     log.info("Setting up Ultracite...");
@@ -197,8 +197,10 @@ export async function setupUltracite(config: ProjectConfig, hasHusky: boolean) {
       ultraciteArgs.push("--hooks", ...hooks);
     }
 
-    if (hasHusky) {
+    if (gitHooks === "husky") {
       ultraciteArgs.push("--integrations", "husky", "lint-staged");
+    } else if (gitHooks === "lefthook") {
+      ultraciteArgs.push("--integrations", "lefthook");
     }
 
     const ultraciteArgsString = ultraciteArgs.join(" ");
@@ -215,11 +217,16 @@ export async function setupUltracite(config: ProjectConfig, hasHusky: boolean) {
       shell: true,
     });
 
-    if (hasHusky) {
+    if (gitHooks === "husky") {
       await addPackageDependency({
         devDependencies: ["husky", "lint-staged"],
         projectDir,
       });
+    } else if (gitHooks === "lefthook") {
+      await addPackageDependency({
+        devDependencies: ["lefthook"],
+        projectDir,
+      });
     }
 
     s.stop("Ultracite setup successfully!");

apps/cli/src/helpers/core/add-addons.ts

@@ -50,6 +50,7 @@ export async function addAddonsToProject(
       api: detectedConfig.api || "none",
       webDeploy: detectedConfig.webDeploy || "none",
       serverDeploy: detectedConfig.serverDeploy || "none",
+      hooks: input.hooks || detectedConfig.hooks || "none",
     };
 
     for (const addon of input.addons) {

apps/cli/src/helpers/core/command-handlers.ts

@@ -102,6 +102,7 @@ export async function createProjectHandler(input: CreateInput & { projectName?:
         api: "none",
         webDeploy: "none",
         serverDeploy: "none",
+        hooks: "none",
       } satisfies ProjectConfig,
       reproducibleCommand: "",
       timeScaffolded,

apps/cli/src/helpers/core/create-project.ts

@@ -12,6 +12,7 @@ import { setupDatabase } from "../core/db-setup";
 import { setupRuntime } from "../core/runtime-setup";
 import { setupServerDeploy } from "../deployment/server-deploy-setup";
 import { setupWebDeploy } from "../deployment/web-deploy-setup";
+import { setupHooks } from "../hooks/hooks-setup";
 import { setupAuth } from "./auth-setup";
 import { createReadme } from "./create-readme";
 import { setupEnvironmentVariables } from "./env-setup";
@@ -30,6 +31,7 @@ import {
   setupDockerComposeTemplates,
   setupExamplesTemplate,
   setupFrontendTemplates,
+  setupHooksTemplate,
   setupPaymentsTemplate,
 } from "./template-manager";
 
@@ -59,6 +61,7 @@ export async function createProject(options: ProjectConfig, cliInput?: { manualD
       await setupExamplesTemplate(projectDir, options);
     }
     await setupAddonsTemplate(projectDir, options);
+    await setupHooksTemplate(projectDir, options);
 
     await setupDeploymentTemplates(projectDir, options);
 
@@ -82,6 +85,10 @@ export async function createProject(options: ProjectConfig, cliInput?: { manualD
       await setupAddons(options);
     }
 
+    if (options.hooks && options.hooks !== "none") {
+      await setupHooks(options);
+    }
+
     if (options.auth && options.auth !== "none") {
       await setupAuth(options);
     }

apps/cli/src/helpers/core/create-readme.ts

@@ -8,6 +8,7 @@ import type {
   Database,
   DatabaseSetup,
   Frontend,
+  Hooks,
   ORM,
   ProjectConfig,
   Runtime,
@@ -38,6 +39,7 @@ function generateReadmeContent(options: ProjectConfig) {
     api = "trpc",
     webDeploy,
     serverDeploy,
+    hooks,
   } = options;
 
   const isConvex = backend === "convex";
@@ -65,7 +67,7 @@ This project was created with [Better-T-Stack](https://github.com/AmanVarshney01
 
 ## Features
 
-${generateFeaturesList(database, auth, addons, orm, runtime, frontend, backend, api)}
+${generateFeaturesList(database, auth, addons, orm, runtime, frontend, backend, api, hooks)}
 
 ## Getting Started
 
@@ -348,6 +350,7 @@ function generateFeaturesList(
   frontend: Frontend[],
   backend: string,
   api: API,
+  hooks?: Hooks,
 ) {
   const isConvex = backend === "convex";
   const isBackendNone = backend === "none";
@@ -459,15 +462,19 @@ function generateFeaturesList(
       addonsList.push("- **Tauri** - Build native desktop applications");
     } else if (addon === "biome") {
       addonsList.push("- **Biome** - Linting and formatting");
-    } else if (addon === "husky") {
-      addonsList.push("- **Husky** - Git hooks for code quality");
     } else if (addon === "starlight") {
       addonsList.push("- **Starlight** - Documentation site with Astro");
     } else if (addon === "turborepo") {
       addonsList.push("- **Turborepo** - Optimized monorepo build system");
     }
   }
 
+  // Add hooks information
+  if (hooks && hooks !== "none") {
+    const hooksName = hooks === "husky" ? "Husky" : "Lefthook";
+    addonsList.push(`- **${hooksName}** - Git hooks for code quality`);
+  }
+
   return addonsList.join("\n");
 }
 

apps/cli/src/helpers/core/detect-project-config.ts

@@ -23,6 +23,7 @@ export async function detectProjectConfig(projectDir: string) {
         api: btsConfig.api,
         webDeploy: btsConfig.webDeploy,
         serverDeploy: btsConfig.serverDeploy,
+        hooks: btsConfig.hooks,
       };
     }
 

apps/cli/src/helpers/core/post-installation.ts

@@ -19,14 +19,15 @@ export async function displayPostInstallInstructions(
     dbSetup,
     webDeploy,
     serverDeploy,
+    hooks,
   } = config;
 
   const isConvex = backend === "convex";
   const isBackendSelf = backend === "self";
   const runCmd =
     packageManager === "npm" ? "npm run" : packageManager === "pnpm" ? "pnpm run" : "bun run";
   const cdCmd = `cd ${relativePath}`;
-  const hasHuskyOrBiome = addons?.includes("husky") || addons?.includes("biome");
+  const hasHooksOrBiome = (hooks && hooks !== "none") || addons?.includes("biome");
 
   const databaseInstructions =
     !isConvex && database !== "none"
@@ -42,7 +43,7 @@ export async function displayPostInstallInstructions(
       : "";
 
   const tauriInstructions = addons?.includes("tauri") ? getTauriInstructions(runCmd) : "";
-  const lintingInstructions = hasHuskyOrBiome ? getLintingInstructions(runCmd) : "";
+  const lintingInstructions = hasHooksOrBiome ? getLintingInstructions(runCmd) : "";
   const nativeInstructions =
     (frontend?.includes("native-bare") ||
       frontend?.includes("native-uniwind") ||