feat: Add lefthook; refactor out Git hooks to their own section #711
Conversation
|
@therealsamyak is attempting to deploy a commit to the Better T Stack Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughMoves Husky out of the Addons list into a new Git Hooks feature; adds Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant TemplateMgr as Template Manager
participant FS as File System
participant PM as Package Manager
User->>CLI: init --git-hooks=<lefthook|husky|none>
CLI->>CLI: validate flags & assemble ProjectConfig (includes gitHooks)
CLI->>TemplateMgr: scaffold templates (addons, ultracite, etc.)
TemplateMgr->>FS: copy template files
CLI->>CLI: invoke setupGitHooks(ProjectConfig)
alt ultracite manages hooks OR gitHooks == "none"
CLI-->>PM: skip hook installation
else gitHooks == "husky"
CLI->>PM: install devDeps ["husky","lint-staged"]
CLI->>FS: update package.json (prepare script, lint-staged)
CLI->>FS: write husky configs (if any)
else gitHooks == "lefthook"
CLI->>PM: install devDep ["lefthook"]
CLI->>FS: render lefthook.yml from template (biome/oxlint flags)
CLI->>FS: update package.json (prepare script for lefthook)
end
CLI->>User: complete scaffolding
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
apps/web/src/lib/stack-url-keys.ts (1)
17-17: Consider abbreviating the URL parameter for consistency.While functionally correct, the mapping
gitHooks: "gitHooks"uses the full property name as the URL parameter. Most other mappings use abbreviations (e.g.,webFrontend: "fe-w",runtime: "rt",backend: "be"). Consider using an abbreviated form likegitHooks: "gh"to maintain consistency and reduce URL length.apps/web/src/lib/stack-utils.ts (1)
18-18: Verify the position of gitHooks in CATEGORY_ORDER.The gitHooks category is placed after packageManager and before addons. While this ordering seems reasonable, consider whether it should be grouped closer to the "git" option (line 21) since they're conceptually related.
Consider this alternative ordering if you want to group Git-related options together:
"packageManager", + "git", + "gitHooks", - "gitHooks", "addons", "examples", - "git", "install",apps/cli/src/helpers/git-hooks/git-hooks-setup.ts (1)
87-97: Consider adding error handling for template operations.If the Handlebars template file is missing or unreadable, this will throw an unhandled error with a potentially cryptic message. Consider wrapping in try-catch with a descriptive error, consistent with the pattern in
createReadme(line 24 in create-readme.ts).+ try { // Read and compile Handlebars template const templatePath = path.join(PKG_ROOT, "templates/git-hooks/lefthook/lefthook.yml.hbs"); const templateContent = await fs.readFile(templatePath, "utf-8"); const template = Handlebars.compile(templateContent); // Generate lefthook.yml content using template const lefthookYmlContent = template({ biome, oxlint }); const lefthookYmlPath = path.join(projectDir, "lefthook.yml"); await fs.writeFile(lefthookYmlPath, lefthookYmlContent); + } catch (error) { + throw new Error(`Failed to setup lefthook configuration: ${error}`); + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (41)
README.md(1 hunks)apps/cli/README.md(3 hunks)apps/cli/src/constants.ts(2 hunks)apps/cli/src/helpers/addons/addons-setup.ts(1 hunks)apps/cli/src/helpers/addons/ultracite-setup.ts(3 hunks)apps/cli/src/helpers/core/add-addons.ts(1 hunks)apps/cli/src/helpers/core/command-handlers.ts(1 hunks)apps/cli/src/helpers/core/create-project.ts(4 hunks)apps/cli/src/helpers/core/create-readme.ts(5 hunks)apps/cli/src/helpers/core/detect-project-config.ts(1 hunks)apps/cli/src/helpers/core/post-installation.ts(2 hunks)apps/cli/src/helpers/core/template-manager.ts(1 hunks)apps/cli/src/helpers/git-hooks/git-hooks-setup.ts(1 hunks)apps/cli/src/index.ts(3 hunks)apps/cli/src/prompts/addons.ts(2 hunks)apps/cli/src/prompts/config-prompts.ts(5 hunks)apps/cli/src/prompts/git-hooks.ts(1 hunks)apps/cli/src/types.ts(5 hunks)apps/cli/src/utils/bts-config.ts(2 hunks)apps/cli/src/utils/config-processing.ts(2 hunks)apps/cli/src/utils/display-config.ts(1 hunks)apps/cli/src/validation.ts(1 hunks)apps/cli/templates/addons/ruler/.ruler/bts.md.hbs(1 hunks)apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs(1 hunks)apps/cli/test/addons.test.ts(2 hunks)apps/cli/test/backend-runtime.test.ts(1 hunks)apps/cli/test/benchmark.test.ts(1 hunks)apps/cli/test/git-hooks.test.ts(1 hunks)apps/cli/test/integration.test.ts(4 hunks)apps/cli/test/test-utils.ts(2 hunks)apps/web/content/docs/cli/index.mdx(1 hunks)apps/web/content/docs/cli/options.mdx(2 hunks)apps/web/content/docs/cli/programmatic-api.mdx(1 hunks)apps/web/content/docs/index.mdx(1 hunks)apps/web/content/docs/project-structure.mdx(1 hunks)apps/web/src/lib/constant.ts(9 hunks)apps/web/src/lib/stack-url-keys.ts(1 hunks)apps/web/src/lib/stack-url-state.client.ts(1 hunks)apps/web/src/lib/stack-url-state.ts(1 hunks)apps/web/src/lib/stack-utils.ts(2 hunks)apps/web/src/lib/types.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
Define functions using the standard function declaration syntax, not arrow functions
Files:
apps/web/src/lib/types.tsapps/cli/src/prompts/addons.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/validation.tsapps/cli/src/helpers/core/add-addons.tsapps/cli/src/index.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/utils/display-config.tsapps/cli/test/benchmark.test.tsapps/cli/src/prompts/config-prompts.tsapps/cli/test/test-utils.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/git-hooks.tsapps/cli/test/addons.test.tsapps/cli/src/helpers/git-hooks/git-hooks-setup.tsapps/cli/src/constants.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/types.tsapps/cli/test/git-hooks.test.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-utils.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/stack-url-state.tsapps/cli/src/helpers/core/detect-project-config.tsapps/cli/src/helpers/core/command-handlers.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/src/utils/bts-config.tsapps/cli/src/helpers/core/create-project.tsapps/cli/src/utils/config-processing.tsapps/web/src/lib/constant.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
**/*.{ts,tsx}: Use TypeScript type aliases instead of interface declarations
Do not use explicit return types
Files:
apps/web/src/lib/types.tsapps/cli/src/prompts/addons.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/validation.tsapps/cli/src/helpers/core/add-addons.tsapps/cli/src/index.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/utils/display-config.tsapps/cli/test/benchmark.test.tsapps/cli/src/prompts/config-prompts.tsapps/cli/test/test-utils.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/git-hooks.tsapps/cli/test/addons.test.tsapps/cli/src/helpers/git-hooks/git-hooks-setup.tsapps/cli/src/constants.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/types.tsapps/cli/test/git-hooks.test.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-utils.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/stack-url-state.tsapps/cli/src/helpers/core/detect-project-config.tsapps/cli/src/helpers/core/command-handlers.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/src/utils/bts-config.tsapps/cli/src/helpers/core/create-project.tsapps/cli/src/utils/config-processing.tsapps/web/src/lib/constant.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.{ts,tsx,js,jsx}: Usebun <file>instead ofnode <file>orts-node <file>for running TypeScript/JavaScript files
Bun automatically loads .env files, so don't use the dotenv package
UseBun.serve()which supports WebSockets, HTTPS, and routes instead ofexpress
Usebun:sqlitemodule for SQLite instead ofbetter-sqlite3
UseBun.redisfor Redis instead ofioredis
UseBun.sqlfor Postgres instead ofpgorpostgres.js
Use built-inWebSocketinstead of thewspackage
PreferBun.fileovernode:fsreadFile/writeFile methods
UseBun.$template literal syntax instead ofexecafor shell command execution
Import .css files directly in TypeScript/JavaScript files; Bun's CSS bundler will handle bundling
Run server withbun --hot <file>to enable hot reloading during development
Files:
apps/web/src/lib/types.tsapps/cli/src/prompts/addons.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/validation.tsapps/cli/src/helpers/core/add-addons.tsapps/cli/src/index.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/utils/display-config.tsapps/cli/test/benchmark.test.tsapps/cli/src/prompts/config-prompts.tsapps/cli/test/test-utils.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/git-hooks.tsapps/cli/test/addons.test.tsapps/cli/src/helpers/git-hooks/git-hooks-setup.tsapps/cli/src/constants.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/types.tsapps/cli/test/git-hooks.test.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-utils.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/stack-url-state.tsapps/cli/src/helpers/core/detect-project-config.tsapps/cli/src/helpers/core/command-handlers.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/src/utils/bts-config.tsapps/cli/src/helpers/core/create-project.tsapps/cli/src/utils/config-processing.tsapps/web/src/lib/constant.ts
**/*.{ts,tsx,js,jsx,css}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use
bun build <file>instead ofwebpackoresbuildfor bundling TypeScript, JavaScript, and CSS files
Files:
apps/web/src/lib/types.tsapps/cli/src/prompts/addons.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/validation.tsapps/cli/src/helpers/core/add-addons.tsapps/cli/src/index.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/utils/display-config.tsapps/cli/test/benchmark.test.tsapps/cli/src/prompts/config-prompts.tsapps/cli/test/test-utils.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/git-hooks.tsapps/cli/test/addons.test.tsapps/cli/src/helpers/git-hooks/git-hooks-setup.tsapps/cli/src/constants.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/types.tsapps/cli/test/git-hooks.test.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-utils.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/stack-url-state.tsapps/cli/src/helpers/core/detect-project-config.tsapps/cli/src/helpers/core/command-handlers.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/src/utils/bts-config.tsapps/cli/src/helpers/core/create-project.tsapps/cli/src/utils/config-processing.tsapps/web/src/lib/constant.ts
**/*.{html,tsx,ts,jsx,js}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use HTML imports with
Bun.serve()for frontend instead of Vite
Files:
apps/web/src/lib/types.tsapps/cli/src/prompts/addons.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/validation.tsapps/cli/src/helpers/core/add-addons.tsapps/cli/src/index.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/utils/display-config.tsapps/cli/test/benchmark.test.tsapps/cli/src/prompts/config-prompts.tsapps/cli/test/test-utils.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/git-hooks.tsapps/cli/test/addons.test.tsapps/cli/src/helpers/git-hooks/git-hooks-setup.tsapps/cli/src/constants.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/types.tsapps/cli/test/git-hooks.test.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-utils.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/stack-url-state.tsapps/cli/src/helpers/core/detect-project-config.tsapps/cli/src/helpers/core/command-handlers.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/src/utils/bts-config.tsapps/cli/src/helpers/core/create-project.tsapps/cli/src/utils/config-processing.tsapps/web/src/lib/constant.ts
**/*.hbs
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
**/*.hbs: In Handlebars templates, avoid generic if/else blocks. Write explicit conditions, such as: use if (eq orm "prisma") for Prisma, and else if (eq orm "drizzle") for Drizzle
Escape the '{{' in Handlebars templates like '{{'
Files:
apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs
**/*.test.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.test.{ts,tsx,js,jsx}: Usebun testinstead ofjestorvitestfor running tests
Usebun:testmodule withtestandexpectfunctions for writing tests
Files:
apps/cli/test/backend-runtime.test.tsapps/cli/test/benchmark.test.tsapps/cli/test/addons.test.tsapps/cli/test/git-hooks.test.tsapps/cli/test/integration.test.ts
🧠 Learnings (4)
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun:test` module with `test` and `expect` functions for writing tests
Applied to files:
apps/cli/test/test-utils.tsapps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun test` instead of `jest` or `vitest` for running tests
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:14.703Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/convex_rules.mdc:0-0
Timestamp: 2025-12-03T07:48:14.703Z
Learning: Applies to convex/**/*.ts : Use the api object from convex/_generated/api.ts to call public functions registered with query, mutation, or action
Applied to files:
apps/cli/src/helpers/core/create-readme.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to {package.json,bun.lockb} : Use `bun install` instead of `npm install`, `yarn install`, or `pnpm install`
Applied to files:
apps/web/content/docs/cli/index.mdx
🧬 Code graph analysis (10)
apps/web/src/lib/stack-url-state.client.ts (1)
apps/web/src/lib/constant.ts (2)
StackState(740-761)DEFAULT_STACK(763-784)
apps/cli/src/index.ts (1)
apps/cli/src/types.ts (1)
GitHooksSchema(88-88)
apps/cli/src/prompts/git-hooks.ts (3)
apps/cli/src/types.ts (1)
GitHooks(89-89)apps/cli/src/constants.ts (1)
DEFAULT_CONFIG(41-41)apps/cli/src/utils/errors.ts (1)
exitCancelled(17-23)
apps/cli/src/helpers/addons/ultracite-setup.ts (2)
apps/cli/src/types.ts (1)
ProjectConfig(167-188)apps/cli/src/utils/add-package-deps.ts (1)
addPackageDependency(6-57)
apps/cli/src/types.ts (1)
apps/cli/src/index.ts (1)
GitHooks(256-256)
apps/cli/test/git-hooks.test.ts (1)
apps/cli/src/types.ts (1)
GitHooks(89-89)
apps/cli/src/helpers/core/create-readme.ts (2)
apps/cli/src/index.ts (1)
GitHooks(256-256)apps/cli/src/types.ts (1)
GitHooks(89-89)
apps/web/src/lib/stack-url-state.ts (1)
apps/web/src/lib/constant.ts (2)
StackState(740-761)DEFAULT_STACK(763-784)
apps/cli/src/helpers/core/template-manager.ts (2)
apps/cli/src/types.ts (1)
ProjectConfig(167-188)apps/cli/src/constants.ts (1)
PKG_ROOT(7-7)
apps/cli/src/helpers/core/create-project.ts (2)
apps/cli/src/helpers/core/template-manager.ts (1)
setupGitHooksTemplate(599-610)apps/cli/src/helpers/git-hooks/git-hooks-setup.ts (1)
setupGitHooks(8-34)
🔇 Additional comments (58)
apps/cli/templates/addons/ruler/.ruler/bts.md.hbs (1)
119-119: LGTM!The removal of Husky from the addons list aligns with the PR's objective to move Git hooks to a dedicated section. The documentation now accurately reflects the new structure.
README.md (1)
47-48: LGTM!The updated documentation clearly reflects the architectural change, separating Git hooks management from addons. The addition of Lefthook as an option alongside Husky provides users with flexibility.
apps/cli/src/helpers/core/post-installation.ts (3)
22-22: LGTM!The addition of
gitHooksto the destructured config properly integrates the new Git hooks feature into the post-installation flow.
30-30: LGTM!The renamed condition
hasHooksOrBiomecorrectly handles the newgitHooksconfiguration. The logic properly evaluates totruewhengitHooksis set to either "husky" or "lefthook", andfalsewhen it's "none", while maintaining the fallback check for Biome.
46-46: LGTM!The updated reference to
hasHooksOrBiomeensures linting instructions are displayed when either Git hooks or Biome is configured.apps/cli/src/helpers/core/command-handlers.ts (1)
105-105: LGTM!The addition of
gitHooks: "none"to the error path configuration properly satisfies the updatedProjectConfigtype. Using "none" as the default is appropriate for error scenarios.apps/cli/src/constants.ts (1)
27-27: LGTM!Setting
gitHooks: "none"as the default is appropriate, making Git hooks management opt-in rather than forced upon users.apps/cli/src/prompts/git-hooks.ts (1)
1-34: LGTM!The implementation follows best practices:
- Uses standard function declaration syntax as per coding guidelines
- Implements efficient early return when
gitHooksis already defined- Provides clear, descriptive labels and hints for each option
- Properly handles user cancellation
- Uses the appropriate default from
DEFAULT_CONFIG.gitHooksapps/cli/src/validation.ts (1)
21-21: Verify flag name consistency.The addition of "hooks" to
CORE_STACK_FLAGSshould match the actual CLI flag name. Other entries in this set use the full config property names (e.g., "database", "backend", "gitHooks"). Please verify whether the CLI flag is defined as--hooksor--git-hooksand ensure consistency.apps/cli/src/prompts/addons.ts (1)
66-66: LGTM! Clean removal of Husky from addons.The removal of "husky" from the Other addons group is consistent with the PR's refactoring of Git hooks into a dedicated feature. The change aligns with the new --git-hooks option.
apps/web/content/docs/cli/programmatic-api.mdx (1)
163-163: LGTM! Clear documentation of the new gitHooks option.The documentation clearly describes the new gitHooks field with its allowed values, following the established pattern for other CreateInput fields.
apps/cli/test/addons.test.ts (1)
7-7: LGTM! Test updates align with the Git hooks refactoring.The removal of "husky" from the universalAddons and multiple addons test cases correctly reflects the architectural change where Husky is now part of the dedicated gitHooks feature rather than an addon.
Also applies to: 178-178
apps/cli/src/utils/display-config.ts (1)
46-48: LGTM! Consistent implementation for displaying gitHooks.The implementation follows the established pattern used for other configuration options, with proper undefined checking and String() conversion.
apps/cli/src/index.ts (1)
28-29: LGTM! Clean integration of GitHooks into the public API.The GitHooks type and schema are properly imported, integrated into the input schema as an optional field, and exported for programmatic usage. The implementation follows the established pattern used for other CLI options.
Also applies to: 90-90, 256-256
apps/cli/test/test-utils.ts (1)
7-7: LGTM! Appropriate default value for test utilities.The addition of
gitHooks: "none"to coreStackDefaults ensures tests have a sensible default value when gitHooks is not explicitly specified, preventing test failures while maintaining consistency with the new Git hooks feature.Also applies to: 113-113
apps/cli/test/benchmark.test.ts (1)
430-431: LGTM! Correctly demonstrates the Git hooks refactoring.The change from
addons: ["turborepo", "biome", "husky"]toaddons: ["turborepo", "biome"]with the addition ofgitHooks: "husky"clearly demonstrates the architectural change where Husky is now configured through the dedicated gitHooks option rather than as an addon.apps/web/src/lib/stack-utils.ts (2)
104-116: LGTM! Husky correctly removed from addons filter.The removal of "husky" from the allowed addons filter list (it's no longer included) is consistent with the refactoring where Husky is now configured through the gitHooks option instead.
96-96: Verify that stack.gitHooks is always defined.The template literal
--git-hooks ${stack.gitHooks}assumes stack.gitHooks is always defined. If it can be undefined, this would generate--git-hooks undefinedin the command string. Verify that StackState type always provides a default value for gitHooks or add a fallback value (e.g.,${stack.gitHooks ?? ''}).apps/cli/test/backend-runtime.test.ts (1)
40-40: LGTM!The addition of
gitHooks: "none"to the test configuration is consistent with the new Git Hooks feature being introduced across the CLI.apps/cli/src/helpers/core/add-addons.ts (1)
53-53: LGTM!The
gitHooksfield assignment follows the established pattern with proper fallback precedence: input → detected config → default value.apps/web/src/lib/stack-url-state.client.ts (1)
35-37: LGTM!The
gitHooksparser implementation is consistent with other string enum parsers in the file, properly usinggetValidIdsand defaulting toDEFAULT_STACK.gitHooks.apps/cli/src/helpers/core/template-manager.ts (1)
599-610: LGTM!The
setupGitHooksTemplatefunction follows the established pattern of other template setup functions in this file, including:
- Early returns for "none" and ultracite scenarios
- Path existence verification before copying
- Standard async function declaration per coding guidelines
apps/cli/src/helpers/core/detect-project-config.ts (1)
26-26: LGTM!The addition of
gitHooks: btsConfig.gitHooksis consistent with the pattern used for all other config fields in the detected config object.apps/web/content/docs/index.mdx (1)
313-314: LGTM!The documentation correctly reflects the refactoring of Git Hooks into a dedicated configuration option. Moving Husky from addons to the
--hooksflag aligns with the PR objectives and provides better separation of concerns.apps/web/content/docs/cli/index.mdx (1)
30-30: LGTM!The
--git-hooksoption documentation is clear, well-positioned after the Git initialization option, and consistent with the format used for other CLI flags.apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs (1)
1-12: The Lefthook placeholder syntax{staged_files}is correct and matches official documentation. No changes needed. The template properly uses this syntax for both biome and oxlint commands.Likely an incorrect or invalid review comment.
apps/cli/test/integration.test.ts (2)
38-39: LGTM! Test correctly uses new gitHooks field.The migration of Husky from
addonsto the dedicatedgitHooksfield aligns with the PR's architectural change.Consider adding a test case with
gitHooks: "lefthook"to ensure coverage of the newly introduced option.
186-187: Consistent gitHooks migration across test cases.All test configurations correctly separate Husky into the
gitHooksfield while keeping other addons inaddonsarray.Also applies to: 273-274, 472-473
apps/cli/src/prompts/config-prompts.ts (2)
113-113: LGTM! gitHooks prompt integration follows established patterns.The
gitHooksprompt is correctly wired into the config group without dependencies, which aligns with the PR behavior notes that git hooks selection is independent of other choices.
56-56: Type and return value properly extended.The
PromptGroupResultstype and returned configuration object are correctly updated to includegitHooks.Also applies to: 141-141
apps/cli/src/utils/config-processing.ts (1)
90-92: LGTM! Flag processing follows established pattern.The
gitHooksflag processing mirrors the existing approach for other single-value options likeapi,backend, anddatabase.apps/web/src/lib/types.ts (1)
15-15: LGTM! TechCategory type correctly extended.The
gitHookscategory is appropriately added to the union type, enabling type-safe handling of git hooks in the web interface.apps/web/src/lib/stack-url-state.ts (1)
49-51: LGTM! Server-side parser correctly implemented.The
gitHooksparser follows the established pattern used forpackageManagerand other enum fields, with proper validation viagetValidIdsand appropriate defaulting.apps/cli/src/utils/bts-config.ts (1)
27-27: LGTM! BTS config correctly extended with gitHooks.The
gitHooksproperty is properly added to both the internal config object and the serialized output, ensuring the configuration is persisted inbts.jsonc.Also applies to: 48-48
apps/web/content/docs/cli/options.mdx (2)
239-253: LGTM! Clear documentation for the new Git Hooks feature.The new Git Hooks section provides clear documentation for the
--git-hooksoption with appropriate examples. The default value ofnoneis clearly stated.
273-273: LGTM! Addons example correctly updated.The example command correctly reflects that Husky has been moved from addons to the dedicated Git Hooks option.
apps/web/content/docs/project-structure.mdx (1)
257-258: LGTM! Configuration schema correctly updated.The Better-T-Stack configuration schema accurately reflects the changes:
- Husky removed from addons list
- New
hooksfield added with appropriate valuesapps/cli/src/helpers/core/create-project.ts (3)
15-15: LGTM! Imports correctly added.The new Git Hooks setup imports are properly added and follow the existing pattern for other setup features.
Also applies to: 34-34
64-64: LGTM! Template setup correctly positioned.The Git Hooks template setup is appropriately placed after addons template setup, maintaining consistency with the project scaffolding flow.
88-90: LGTM! Git Hooks setup logic is correct.The conditional setup correctly checks for non-"none" gitHooks values before invoking the setup function, following the same pattern as auth and payments setup.
apps/cli/src/helpers/addons/addons-setup.ts (1)
63-63: LGTM! Ultracite setup call correctly simplified.The setupUltracite call now passes only the config parameter, correctly reflecting the refactored function signature where Git Hooks logic is handled within the config itself rather than as a separate boolean flag.
apps/cli/test/git-hooks.test.ts (1)
5-212: LGTM! Comprehensive test coverage for Git Hooks.The test suite provides excellent coverage:
- Individual git hook options (lefthook, husky, none)
- Linter integrations (biome, oxlint)
- Multiple addon combinations
- Default behavior validation
Once the import issue is fixed, these tests will properly validate the Git Hooks functionality.
apps/cli/src/helpers/addons/ultracite-setup.ts (3)
133-134: LGTM! Function signature correctly refactored.The function signature has been properly simplified to remove the
hasHuskyboolean parameter in favor of extractinggitHooksdirectly from the config. This is a cleaner design that allows Ultracite to support both Lefthook and Husky.
200-202: LGTM! Integration logic correctly updated.The logic now correctly checks
gitHooks !== "none"to determine whether to enable Git Hooks integration, replacing the previous boolean flag approach. This allows Ultracite to support multiple Git Hooks managers.
218-223: LGTM! Dependency installation correctly updated.The dependency installation logic correctly:
- Guards installation with
gitHooks !== "none"- Uses the
gitHooksvalue directly as the package name (which is valid since both "husky" and "lefthook" are real package names)- Installs "lint-staged" alongside the selected Git Hooks manager
apps/cli/README.md (3)
43-45: LGTM! Features table correctly updated.The features table has been properly updated:
- New Git Hooks row added with Lefthook, Husky, and None options
- Husky removed from the Addons row
This clearly communicates that Git Hooks are now a separate feature category.
63-63: LGTM! CLI usage documentation updated.The
--git-hooksoption is properly documented in the usage section with clear parameter descriptions.
197-197: LGTM! Compatibility note correctly updated.The compatibility note for addons "none" has been updated to reflect that Husky is no longer part of the addons list.
apps/cli/src/types.ts (5)
88-89: LGTM! Git Hooks schema properly defined.The
GitHooksSchemaandGitHookstype are correctly defined using Zod's enum with appropriate values ("husky", "lefthook", "none") and a clear description.
150-150: LGTM! CreateInput type correctly extended.The
gitHooksfield is properly added as an optional property toCreateInput, following the same pattern as other optional configuration fields.
160-160: LGTM! AddInput type correctly extended.The
gitHooksfield is properly added as an optional property toAddInput, allowing Git Hooks to be configured during the add command.
187-187: LGTM! ProjectConfig interface correctly extended.The
gitHooksfield is properly added as a required property toProjectConfig, ensuring that all resolved project configurations include a Git Hooks value (even if it's "none").
207-207: LGTM! BetterTStackConfig interface correctly extended.The
gitHooksfield is properly added toBetterTStackConfig, ensuring that the persisted configuration includes the Git Hooks setting.apps/cli/src/helpers/core/create-readme.ts (1)
472-476: LGTM!The git hooks feature integration is clean. The optional parameter handling and name mapping logic correctly handle both
undefinedand"none"cases, following the existing pattern used for other features.apps/cli/src/helpers/git-hooks/git-hooks-setup.ts (1)
8-16: LGTM!The skip logic correctly handles the ultracite case (where ultracite manages its own hooks) and the "none" case. The linter detection logic properly checks addons before delegating to the appropriate setup function.
apps/web/src/lib/constant.ts (3)
472-497: LGTM!The gitHooks category is well-structured with appropriate options (lefthook, husky, none). The default is correctly set to
nonefor the category, matching the conservative approach of not imposing git hooks by default.
752-752: LGTM!The
gitHooksfield is properly added to theStackStatetype, maintaining consistency with the type alias pattern used throughout the file.
646-646: Verify: Preset templates all default to lefthook.All preset templates now include
gitHooks: "lefthook". This seems intentional as Lefthook is positioned as the preferred option, but it differs fromDEFAULT_STACKwhich uses"none". Confirm this is the desired behavior for preset templates.Also applies to: 673-673, 700-701, 727-727
therealsamyak
changed the title
therealsamyak
force-pushed
the
sk/add-lefthook
branch
from
f69ff1f to
bb93a72
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/cli/test/backend-runtime.test.ts (1)
40-40: Consider addinggitHooks: "none"to other test configurations for consistency.The explicit
gitHooks: "none"is correctly added here. However, other test configurations in this file (e.g., invalid combinations, constraint tests) don't explicitly setgitHooks. While the test utilities likely default to"none", explicitly setting it throughout would improve consistency and make the test behavior more predictable.apps/cli/test/git-hooks.test.ts (1)
160-200: Consider usingdescribeblocks to group related tests.The tests are well-structured, but using
describeblocks (e.g., "Lefthook Linter Integration", "Husky Integration", "Hooks with Addons") would improve readability and match the organization style in other test files likeintegration.test.ts.+import { test, describe } from "bun:test"; -import { test } from "bun:test"; import type { GitHooks } from "../src/types"; import { runTRPCTest, expectSuccess } from "./test-utils"; const gitHookOptions = ["husky", "lefthook", "none"] as GitHooks[]; +describe("Git Hooks Configurations", () => { for (const gitHook of gitHookOptions) { - test(`Git Hooks Configurations - should work with ${gitHook} git hooks`, async () => { + test(`should work with ${gitHook} git hooks`, async () => { // ... test body }); } +});apps/web/content/docs/project-structure.mdx (1)
245-266: Clarify thathooksmaps to the Git hooks manager /--git-hooksoptionThe new
"hooks": "<lefthook|husky|none>"field looks correct, but it might help readers if the surrounding text briefly calls out that this controls the Git hooks manager and corresponds to the--git-hooksCLI flag, to avoid confusion with other kinds of “hooks”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (41)
README.md(1 hunks)apps/cli/README.md(3 hunks)apps/cli/src/constants.ts(2 hunks)apps/cli/src/helpers/addons/addons-setup.ts(1 hunks)apps/cli/src/helpers/addons/ultracite-setup.ts(3 hunks)apps/cli/src/helpers/core/add-addons.ts(1 hunks)apps/cli/src/helpers/core/command-handlers.ts(1 hunks)apps/cli/src/helpers/core/create-project.ts(4 hunks)apps/cli/src/helpers/core/create-readme.ts(5 hunks)apps/cli/src/helpers/core/detect-project-config.ts(1 hunks)apps/cli/src/helpers/core/post-installation.ts(2 hunks)apps/cli/src/helpers/core/template-manager.ts(1 hunks)apps/cli/src/helpers/git-hooks/git-hooks-setup.ts(1 hunks)apps/cli/src/index.ts(3 hunks)apps/cli/src/prompts/addons.ts(2 hunks)apps/cli/src/prompts/config-prompts.ts(5 hunks)apps/cli/src/prompts/git-hooks.ts(1 hunks)apps/cli/src/types.ts(5 hunks)apps/cli/src/utils/bts-config.ts(2 hunks)apps/cli/src/utils/config-processing.ts(2 hunks)apps/cli/src/utils/display-config.ts(1 hunks)apps/cli/src/validation.ts(1 hunks)apps/cli/templates/addons/ruler/.ruler/bts.md.hbs(1 hunks)apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs(1 hunks)apps/cli/test/addons.test.ts(2 hunks)apps/cli/test/backend-runtime.test.ts(1 hunks)apps/cli/test/benchmark.test.ts(1 hunks)apps/cli/test/git-hooks.test.ts(1 hunks)apps/cli/test/integration.test.ts(4 hunks)apps/cli/test/test-utils.ts(2 hunks)apps/web/content/docs/cli/index.mdx(1 hunks)apps/web/content/docs/cli/options.mdx(2 hunks)apps/web/content/docs/cli/programmatic-api.mdx(1 hunks)apps/web/content/docs/index.mdx(1 hunks)apps/web/content/docs/project-structure.mdx(1 hunks)apps/web/src/lib/constant.ts(9 hunks)apps/web/src/lib/stack-url-keys.ts(1 hunks)apps/web/src/lib/stack-url-state.client.ts(1 hunks)apps/web/src/lib/stack-url-state.ts(1 hunks)apps/web/src/lib/stack-utils.ts(2 hunks)apps/web/src/lib/types.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/cli/templates/addons/ruler/.ruler/bts.md.hbs
🚧 Files skipped from review as they are similar to previous changes (23)
- apps/web/src/lib/stack-url-keys.ts
- apps/cli/src/helpers/core/command-handlers.ts
- apps/cli/src/prompts/config-prompts.ts
- apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs
- apps/cli/src/prompts/git-hooks.ts
- apps/cli/src/utils/config-processing.ts
- apps/cli/src/constants.ts
- apps/web/content/docs/cli/index.mdx
- apps/cli/README.md
- apps/cli/src/helpers/core/post-installation.ts
- apps/web/content/docs/cli/programmatic-api.mdx
- README.md
- apps/cli/src/helpers/git-hooks/git-hooks-setup.ts
- apps/cli/test/benchmark.test.ts
- apps/cli/src/helpers/core/add-addons.ts
- apps/web/src/lib/stack-url-state.ts
- apps/cli/src/utils/display-config.ts
- apps/cli/src/types.ts
- apps/cli/test/test-utils.ts
- apps/cli/src/validation.ts
- apps/cli/src/index.ts
- apps/web/src/lib/stack-utils.ts
- apps/cli/src/helpers/core/create-project.ts
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
Define functions using the standard function declaration syntax, not arrow functions
Files:
apps/cli/test/addons.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/helpers/core/detect-project-config.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/constant.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/utils/bts-config.tsapps/web/src/lib/types.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
**/*.{ts,tsx}: Use TypeScript type aliases instead of interface declarations
Do not use explicit return types
Files:
apps/cli/test/addons.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/helpers/core/detect-project-config.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/constant.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/utils/bts-config.tsapps/web/src/lib/types.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.{ts,tsx,js,jsx}: Usebun <file>instead ofnode <file>orts-node <file>for running TypeScript/JavaScript files
Bun automatically loads .env files, so don't use the dotenv package
UseBun.serve()which supports WebSockets, HTTPS, and routes instead ofexpress
Usebun:sqlitemodule for SQLite instead ofbetter-sqlite3
UseBun.redisfor Redis instead ofioredis
UseBun.sqlfor Postgres instead ofpgorpostgres.js
Use built-inWebSocketinstead of thewspackage
PreferBun.fileovernode:fsreadFile/writeFile methods
UseBun.$template literal syntax instead ofexecafor shell command execution
Import .css files directly in TypeScript/JavaScript files; Bun's CSS bundler will handle bundling
Run server withbun --hot <file>to enable hot reloading during development
Files:
apps/cli/test/addons.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/helpers/core/detect-project-config.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/constant.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/utils/bts-config.tsapps/web/src/lib/types.ts
**/*.test.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.test.{ts,tsx,js,jsx}: Usebun testinstead ofjestorvitestfor running tests
Usebun:testmodule withtestandexpectfunctions for writing tests
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.ts
**/*.{ts,tsx,js,jsx,css}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use
bun build <file>instead ofwebpackoresbuildfor bundling TypeScript, JavaScript, and CSS files
Files:
apps/cli/test/addons.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/helpers/core/detect-project-config.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/constant.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/utils/bts-config.tsapps/web/src/lib/types.ts
**/*.{html,tsx,ts,jsx,js}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use HTML imports with
Bun.serve()for frontend instead of Vite
Files:
apps/cli/test/addons.test.tsapps/cli/src/helpers/core/template-manager.tsapps/cli/test/integration.test.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/test/git-hooks.test.tsapps/cli/test/backend-runtime.test.tsapps/cli/src/helpers/core/detect-project-config.tsapps/web/src/lib/stack-url-state.client.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/constant.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/utils/bts-config.tsapps/web/src/lib/types.ts
🧠 Learnings (4)
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun:test` module with `test` and `expect` functions for writing tests
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun test` instead of `jest` or `vitest` for running tests
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.{ts,tsx,js,jsx} : Use `bun <file>` instead of `node <file>` or `ts-node <file>` for running TypeScript/JavaScript files
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:14.703Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/convex_rules.mdc:0-0
Timestamp: 2025-12-03T07:48:14.703Z
Learning: Applies to convex/**/*.ts : Use the api object from convex/_generated/api.ts to call public functions registered with query, mutation, or action
Applied to files:
apps/cli/src/helpers/core/create-readme.ts
🧬 Code graph analysis (5)
apps/cli/src/helpers/core/template-manager.ts (2)
apps/cli/src/types.ts (1)
ProjectConfig(167-188)apps/cli/src/constants.ts (1)
PKG_ROOT(7-7)
apps/cli/src/helpers/addons/ultracite-setup.ts (2)
apps/cli/src/types.ts (1)
ProjectConfig(167-188)apps/cli/src/utils/add-package-deps.ts (1)
addPackageDependency(6-57)
apps/web/src/lib/stack-url-state.client.ts (1)
apps/web/src/lib/constant.ts (2)
StackState(740-761)DEFAULT_STACK(763-784)
apps/cli/src/helpers/core/create-readme.ts (2)
apps/cli/src/index.ts (1)
GitHooks(256-256)apps/cli/src/types.ts (1)
GitHooks(89-89)
apps/cli/src/helpers/addons/addons-setup.ts (1)
apps/cli/src/helpers/addons/ultracite-setup.ts (1)
setupUltracite(133-232)
🔇 Additional comments (25)
apps/cli/src/prompts/addons.ts (1)
46-66: LGTM! Clean migration of Husky out of addons.The removal of Husky from the addons switch case and ADDON_GROUPS.Other is consistent with the PR's objective to move Git hooks into their own configuration surface.
apps/cli/src/helpers/core/detect-project-config.ts (1)
26-26: LGTM! Correct propagation of gitHooks field.The gitHooks field is properly extracted from the BTS config and included in the returned project configuration, consistent with other config fields.
apps/cli/src/helpers/core/template-manager.ts (1)
599-610: LGTM! Well-structured Git hooks template setup.The function correctly:
- Guards against invalid states (none, missing gitHooks)
- Skips when Ultracite is handling hooks (per PR behavior notes)
- Follows the established template setup pattern
- Uses standard function declaration syntax as per coding guidelines
apps/web/src/lib/types.ts (1)
15-15: LGTM! Correct union type extension.The addition of "gitHooks" to TechCategory properly extends the type to support the new Git hooks configuration category.
apps/cli/src/utils/bts-config.ts (1)
27-48: LGTM! Proper gitHooks config persistence.The gitHooks field is correctly included in both the runtime config object and the serialized baseContent, ensuring it persists in bts.jsonc and remains available for downstream operations.
apps/cli/src/helpers/core/create-readme.ts (3)
11-11: LGTM! Correct type import.The GitHooks type import enables type-safe handling of the gitHooks parameter in README generation.
42-70: LGTM! Proper gitHooks propagation.The gitHooks field is correctly destructured from options and passed through to generateFeaturesList, maintaining consistency with how other config fields are handled.
353-476: LGTM! Well-implemented Git hooks feature rendering.The implementation correctly:
- Uses an optional parameter since gitHooks may be "none"
- Guards against undefined and "none" values before rendering
- Maps gitHooks values to appropriate display names
- Adds the feature to the list in a consistent format
apps/web/content/docs/index.mdx (1)
313-314: LGTM! Documentation correctly updated.The docs properly reflect the migration of Husky from addons to the new --hooks flag, with accurate values (lefthook, husky, none) documented for users.
apps/cli/test/addons.test.ts (2)
7-7: LGTM! Test correctly updated for Husky migration.Removing "husky" from the universalAddons array aligns with the PR's migration of Husky from addons to the gitHooks configuration.
178-178: LGTM! Multiple addons test correctly updated.The test array properly excludes "husky" while still validating that multiple compatible addons can be used together.
apps/cli/test/integration.test.ts (4)
38-39: LGTM!The migration of husky from the addons array to a dedicated
gitHooks: "husky"field is correctly implemented. This aligns with the PR's objective to refactor Git hooks into their own section.
186-187: LGTM!Consistent application of the gitHooks field for the MongoDB + Mongoose test configuration.
273-274: LGTM!Frontend-only Nuxt test configuration correctly updated with gitHooks field.
472-473: LGTM!Maximum complexity test configuration correctly updated to use gitHooks instead of husky in addons.
apps/web/content/docs/cli/options.mdx (2)
239-253: LGTM!The new Git Hooks section is well-documented with clear descriptions for each option (lefthook, husky, none) and helpful usage examples. The placement after Authentication and before Addons is logical.
273-273: LGTM!The addons example correctly excludes husky, which is now documented in the Git Hooks section.
apps/web/src/lib/stack-url-state.client.ts (1)
35-37: LGTM!The gitHooks parser follows the established pattern used by other enum parsers in this file. It correctly uses
parseAsStringEnumwith valid IDs fromTECH_OPTIONS["gitHooks"]and defaults toDEFAULT_STACK.gitHooks("none").apps/cli/test/git-hooks.test.ts (4)
1-3: LGTM!Correct usage of
bun:testper coding guidelines. The imports are appropriate for the test file.
5-28: LGTM!Good use of a loop to test all gitHook options, reducing code duplication while ensuring coverage for husky, lefthook, and none configurations.
30-93: LGTM!Comprehensive Lefthook integration tests covering biome, oxlint, and standalone scenarios. Test configurations are complete and follow established patterns.
95-158: LGTM!Comprehensive Husky integration tests mirroring the Lefthook tests for consistency. Good coverage of biome, oxlint, and standalone scenarios.
apps/cli/src/helpers/addons/addons-setup.ts (1)
59-68: Ultracite setup now correctly forwards full ProjectConfig (including gitHooks)Switching to
setupUltracite(config)keeps the Biome/Ultracite branching intact and correctly passes gitHooks and other fields through the config object; the control flow forultracitevsbiomeremains sound.apps/cli/src/helpers/addons/ultracite-setup.ts (1)
133-135: gitHooks-based Ultracite integration and dependency wiring look consistentUsing
config.gitHooksto gate--integrations <gitHooks> lint-stagedand to install[gitHooks, "lint-staged"]only whengitHooks !== "none"matches the intended behavior and cleanly replaces the earlier hasHusky flag.Also applies to: 200-202, 218-221
apps/web/src/lib/constant.ts (1)
472-497: gitHooks option and defaults are wired consistently across web constants and presetsThe new
gitHookstech category, its default of"none", the preset stacks setting"lefthook"where desired, and the StackState/DEFAULT_STACK updates all align and should integrate cleanly with the rest of the stack/state logic.Also applies to: 646-647, 673-674, 700-703, 727-728, 752-752, 775-775
therealsamyak
force-pushed
the
sk/add-lefthook
branch
from
bb93a72 to
fb1e620
Compare
|
@AmanVarshney01 this is ready to review when you are! |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
apps/web/content/docs/cli/programmatic-api.mdx (1)
163-163: Improve inline comment to describe field purpose, not just values.The comment lists allowed values but doesn't describe what the field does. Compare with the
gitfield above (line 162: "Initialize git repo"), which is more informative. Consider updating the comment to explain the purpose.- gitHooks?: GitHooks; // "lefthook" | "husky" | "none" + gitHooks?: GitHooks; // Git hooks manager: "lefthook" | "husky" | "none"Alternatively, if you want to keep it even more concise to match the union-type pattern, just ensure consistency:
- gitHooks?: GitHooks; // "lefthook" | "husky" | "none" + gitHooks?: GitHooks; // Git hooks manager ("lefthook" | "husky" | "none")apps/web/src/lib/stack-url-keys.ts (1)
17-17: Consider using an abbreviated URL key for consistency.Most URL keys use abbreviated forms (e.g.,
pm,add,ex,wd). Consider usingghinstead ofgitHooksto keep URLs shorter and consistent with the abbreviated pattern:- gitHooks: "gitHooks", + gitHooks: "gh",That said, keys like
api,git, andyoloalso use full names, so the current approach is acceptable.apps/web/src/lib/constant.ts (1)
540-541: Minor: Remove trailing empty line.This appears to be leftover formatting from removing Husky from addons. Consider removing the extra blank line for cleaner formatting.
apps/cli/test/addons.test.ts (1)
7-30: Addon tests correctly drop Husky; consider deriving lists from shared configUpdating
universalAddons, the “multiple compatible addons” config, andtestableAddonsto exclude"husky"matches the new separation between addons andgitHooks. To reduce future drift, you could derive these arrays fromAddonsSchema.options(filtering out prompt‑only addons) instead of maintaining the string lists by hand, but that’s optional.Also applies to: 174-195, 283-323
apps/cli/test/integration.test.ts (1)
28-45: Integration tests now exercise Husky viagitHooks; add a Lefthook case for full coverageSwitching Husky from
addonstogitHooks: "husky"in these scenarios keeps real‑world coverage aligned with the new API shape. To fully exercise the new--git-hookssurface, it would be worth adding at least one analogous integration test usinggitHooks: "lefthook"(with Biome/Oxlint enabled) so both hook managers are covered end‑to‑end.Also applies to: 176-193, 263-281, 461-479
apps/cli/test/git-hooks.test.ts (2)
1-28: Parameterized gitHooks tests are well-structuredThe shared
gitHookOptionsarray plus the looped test covers all three allowed git hooks values with a single, readable pattern, and each run uses a distinctprojectName, so there’s no cross-test directory clash. Just keep in mind that if new git hooks modes are ever added to the config, this array will need updating to keep coverage aligned, but as written it’s correct and maintainable.
30-200: Comprehensive scenario coverage; minor duplication onlyThese tests thoroughly exercise git hooks with and without linters (Biome/Oxlint), both managers (lefthook/husky), multiple addons, and the implicit default case where
gitHooksis omitted. The configurations andprojectNamevalues are consistent and should give good confidence that CLI scaffolding works across combinations. If this suite grows further, consider extracting a small helper to build the common config shape (frontend/backend/runtime/db/auth/api flags) to reduce repetition, but that’s optional.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (41)
README.md(1 hunks)apps/cli/README.md(3 hunks)apps/cli/src/constants.ts(2 hunks)apps/cli/src/helpers/addons/addons-setup.ts(1 hunks)apps/cli/src/helpers/addons/ultracite-setup.ts(3 hunks)apps/cli/src/helpers/core/add-addons.ts(1 hunks)apps/cli/src/helpers/core/command-handlers.ts(1 hunks)apps/cli/src/helpers/core/create-project.ts(4 hunks)apps/cli/src/helpers/core/create-readme.ts(5 hunks)apps/cli/src/helpers/core/detect-project-config.ts(1 hunks)apps/cli/src/helpers/core/post-installation.ts(2 hunks)apps/cli/src/helpers/core/template-manager.ts(1 hunks)apps/cli/src/helpers/git-hooks/git-hooks-setup.ts(1 hunks)apps/cli/src/index.ts(3 hunks)apps/cli/src/prompts/addons.ts(2 hunks)apps/cli/src/prompts/config-prompts.ts(5 hunks)apps/cli/src/prompts/git-hooks.ts(1 hunks)apps/cli/src/types.ts(5 hunks)apps/cli/src/utils/bts-config.ts(2 hunks)apps/cli/src/utils/config-processing.ts(2 hunks)apps/cli/src/utils/display-config.ts(1 hunks)apps/cli/src/validation.ts(1 hunks)apps/cli/templates/addons/ruler/.ruler/bts.md.hbs(1 hunks)apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs(1 hunks)apps/cli/test/addons.test.ts(2 hunks)apps/cli/test/backend-runtime.test.ts(1 hunks)apps/cli/test/benchmark.test.ts(1 hunks)apps/cli/test/git-hooks.test.ts(1 hunks)apps/cli/test/integration.test.ts(4 hunks)apps/cli/test/test-utils.ts(2 hunks)apps/web/content/docs/cli/index.mdx(1 hunks)apps/web/content/docs/cli/options.mdx(2 hunks)apps/web/content/docs/cli/programmatic-api.mdx(1 hunks)apps/web/content/docs/index.mdx(1 hunks)apps/web/content/docs/project-structure.mdx(1 hunks)apps/web/src/lib/constant.ts(9 hunks)apps/web/src/lib/stack-url-keys.ts(1 hunks)apps/web/src/lib/stack-url-state.client.ts(1 hunks)apps/web/src/lib/stack-url-state.ts(1 hunks)apps/web/src/lib/stack-utils.ts(2 hunks)apps/web/src/lib/types.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (30)
- apps/web/src/lib/stack-url-state.client.ts
- apps/cli/templates/addons/ruler/.ruler/bts.md.hbs
- apps/cli/src/constants.ts
- apps/cli/src/helpers/core/template-manager.ts
- apps/cli/src/helpers/core/detect-project-config.ts
- apps/cli/src/index.ts
- apps/web/content/docs/project-structure.mdx
- apps/cli/src/utils/display-config.ts
- apps/cli/src/prompts/git-hooks.ts
- apps/cli/test/backend-runtime.test.ts
- apps/cli/src/prompts/config-prompts.ts
- apps/cli/src/helpers/core/command-handlers.ts
- apps/web/src/lib/stack-utils.ts
- apps/web/content/docs/cli/options.mdx
- apps/cli/src/helpers/addons/ultracite-setup.ts
- apps/cli/src/validation.ts
- apps/cli/src/helpers/core/post-installation.ts
- apps/web/src/lib/stack-url-state.ts
- apps/cli/src/helpers/git-hooks/git-hooks-setup.ts
- apps/cli/src/helpers/core/add-addons.ts
- apps/cli/test/benchmark.test.ts
- apps/cli/src/utils/bts-config.ts
- apps/cli/templates/git-hooks/lefthook/lefthook.yml.hbs
- apps/web/content/docs/cli/index.mdx
- apps/cli/src/utils/config-processing.ts
- apps/web/content/docs/index.mdx
- apps/cli/src/types.ts
- apps/cli/test/test-utils.ts
- apps/cli/src/helpers/core/create-project.ts
- apps/web/src/lib/types.ts
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
Define functions using the standard function declaration syntax, not arrow functions
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/constant.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/better-t-stack-repo.mdc)
**/*.{ts,tsx}: Use TypeScript type aliases instead of interface declarations
Do not use explicit return types
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/constant.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.{ts,tsx,js,jsx}: Usebun <file>instead ofnode <file>orts-node <file>for running TypeScript/JavaScript files
Bun automatically loads .env files, so don't use the dotenv package
UseBun.serve()which supports WebSockets, HTTPS, and routes instead ofexpress
Usebun:sqlitemodule for SQLite instead ofbetter-sqlite3
UseBun.redisfor Redis instead ofioredis
UseBun.sqlfor Postgres instead ofpgorpostgres.js
Use built-inWebSocketinstead of thewspackage
PreferBun.fileovernode:fsreadFile/writeFile methods
UseBun.$template literal syntax instead ofexecafor shell command execution
Import .css files directly in TypeScript/JavaScript files; Bun's CSS bundler will handle bundling
Run server withbun --hot <file>to enable hot reloading during development
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/constant.ts
**/*.test.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
**/*.test.{ts,tsx,js,jsx}: Usebun testinstead ofjestorvitestfor running tests
Usebun:testmodule withtestandexpectfunctions for writing tests
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.ts
**/*.{ts,tsx,js,jsx,css}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use
bun build <file>instead ofwebpackoresbuildfor bundling TypeScript, JavaScript, and CSS files
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/constant.ts
**/*.{html,tsx,ts,jsx,js}
📄 CodeRabbit inference engine (.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc)
Use HTML imports with
Bun.serve()for frontend instead of Vite
Files:
apps/cli/test/addons.test.tsapps/cli/test/integration.test.tsapps/cli/test/git-hooks.test.tsapps/cli/src/prompts/addons.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/core/create-readme.tsapps/web/src/lib/stack-url-keys.tsapps/web/src/lib/constant.ts
🧠 Learnings (4)
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun:test` module with `test` and `expect` functions for writing tests
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.test.{ts,tsx,js,jsx} : Use `bun test` instead of `jest` or `vitest` for running tests
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:26.410Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc:0-0
Timestamp: 2025-12-03T07:48:26.410Z
Learning: Applies to **/*.{ts,tsx,js,jsx} : Use `bun <file>` instead of `node <file>` or `ts-node <file>` for running TypeScript/JavaScript files
Applied to files:
apps/cli/test/git-hooks.test.ts
📚 Learning: 2025-12-03T07:48:14.703Z
Learnt from: CR
Repo: AmanVarshney01/create-better-t-stack PR: 0
File: .cursor/rules/convex_rules.mdc:0-0
Timestamp: 2025-12-03T07:48:14.703Z
Learning: Applies to convex/**/*.ts : Use the api object from convex/_generated/api.ts to call public functions registered with query, mutation, or action
Applied to files:
apps/cli/src/helpers/core/create-readme.ts
🧬 Code graph analysis (3)
apps/cli/test/git-hooks.test.ts (2)
apps/cli/src/types.ts (1)
GitHooks(89-89)apps/cli/test/test-utils.ts (2)
runTRPCTest(58-161)expectSuccess(163-173)
apps/cli/src/helpers/addons/addons-setup.ts (1)
apps/cli/src/helpers/addons/ultracite-setup.ts (1)
setupUltracite(133-232)
apps/cli/src/helpers/core/create-readme.ts (2)
apps/cli/src/index.ts (1)
GitHooks(256-256)apps/cli/src/types.ts (1)
GitHooks(89-89)
🔇 Additional comments (12)
README.md (1)
47-48: Documentation properly reflects Git Hooks as distinct feature.The changes cleanly move Husky from Addons into the new Git Hooks section while maintaining the comprehensive addon list. Formatting and feature presentation are consistent with the rest of the README.
apps/cli/README.md (4)
43-43: Git Hooks table row properly integrated.The new table entry follows the established format, lists correct options (Lefthook, Husky, None), and fits naturally within the Features documentation structure.
45-45: Addons section correctly updated.Husky has been cleanly removed from the Addons row. The remaining addons are properly formatted and consistent with the PR's refactoring objective.
62-63: CLI options properly documented.The new
--git-hooks <type>option is correctly documented with appropriate values and formatting consistent with other CLI flags. The addons option no longer references Husky.
197-197: Compatibility notes updated consistently.The Addons 'none' compatibility note has been properly updated to remove reference to Husky, maintaining internal consistency with the broader refactoring.
apps/web/src/lib/constant.ts (3)
472-497: LGTM!The new
gitHookscategory is well-structured with appropriate options (lefthook, husky, none) and sensible defaults. The configuration follows the established pattern of other tech options.
646-647: LGTM!The
gitHooks: "lefthook"addition to preset templates is consistent across all presets (mern, pern, t3, uniwind), aligning with the PR's intent to promote Lefthook as the recommended Git hooks manager.
752-752: LGTM!The
gitHooksfield is correctly added toStackStatetype with an appropriate default of"none"inDEFAULT_STACK, allowing users to opt-in to Git hooks management.apps/cli/src/helpers/addons/addons-setup.ts (1)
63-63: LGTM: Clean refactoring that improves separation of concerns.The simplified call to
setupUltracite(config)correctly aligns with the new architecture where Git hooks configuration is managed through theconfig.gitHooksfield rather than a separate boolean parameter. This refactoring moves Git hooks setup logic to a dedicated module, improving maintainability and reducing coupling in the addons setup flow.apps/cli/src/prompts/addons.ts (1)
17-58: Husky removal from addon display/groups looks consistent with new Git Hooks modelThe switch in
getAddonDisplayandADDON_GROUPS.Othernow exclude"husky", so Husky will no longer appear as an addon option, which matches the move to a dedicatedgitHooksfield. As long as"husky"has also been removed fromAddonsSchema.options, this prompt logic remains consistent and won’t ever hit the generic default branch for Husky.Also applies to: 63-67
apps/cli/src/helpers/core/create-readme.ts (2)
28-43: gitHooks plumbing into README generation is consistentDestructuring
gitHooksfromoptionsand threading it intogenerateFeaturesListcleanly connects the new config field to README output without changing other behavior. This keeps README content in sync with the project’s git hooks choice while remaining backward compatible whengitHooksis absent.Also applies to: 70-70
344-354: Git hooks feature entry in Features list behaves as expectedExtending
generateFeaturesListwith an optionalgitHooksparameter and appending a single bullet when it’s set to something other than"none"is straightforward and matches the current allowed values (labeling"husky"vs"lefthook"). This keeps the Features section accurate without clutter when no hooks manager is selected.Also applies to: 472-476
1 participant
Sorry for jumping the gun here, but I will say I started working on this ~24 hours ago, and within that time lefthook is now used within BTS itself, so hopefully its fine 😅.
Add new cli flag
--git-hooks, which supports{ lefthook, husky, none }. Modified addons section to remove husky to compensate.Areas Updates
preparescript withlefthook installtopackage.jsonin template.Notes
{ lefthook, husky, none }preparescript in thepackage.jsonis not generated. I filed a feature request within the Ultracite repo (Prepare script when using Git hooks manager (ex. Lefthook) haydenbleasel/ultracite#427) so hopefully this is resolved soon. Ultracite already runs 'lefthook install' (or similar hook scripts) upon finishing its setup, so not a huge huge problem if the Git hooks don't change.biome check --writeand/oroxlint --fix .(lefthook) respectively. Lefthook doesn't need lint-staged (just usestage_fixed: true), so why add another dependency when it's not necessary.addcommand. There is possibility of expandingaddcommand to also add a Git hooks manager, but it feels too complicated, just dobun add lefthookand its basically done for you xdDisclaimer that majority of the code is AI-generated, but I did test it throughly, reviewed all the code generated manually with my own 2 eyes, and tested it locally to verify it worked before opening this PR.
Screenshots
Summary by CodeRabbit
New Features
Documentation
Chores
Tests
✏️ Tip: You can customize this high-level summary in your review settings.