chore: add pre-commit hook to run lint-staged (Prettier) #256
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR introduces automated code formatting on commit by integrating husky and lint-staged into the Tigris OS documentation project. The changes add:
- Husky and lint-staged dependencies - These are development tools that work together to run linters/formatters on Git hooks
- npm scripts - A "prepare" script that automatically installs husky hooks after
npm install, and a "lint-staged" script for manual execution - Pre-commit hook - A simple
.husky/pre-commitfile that executesnpx lint-stagedbefore each commit - lint-staged configuration - Targets staged
.md,.mdx,.js,.jsx,.ts, and.tsxfiles to run Prettier formatting
This implementation follows standard industry practices for maintaining consistent code style in JavaScript/TypeScript projects. The setup ensures that any staged files matching the specified extensions are automatically formatted with Prettier before being committed, eliminating manual formatting inconsistencies across the team. The configuration is particularly well-suited for a documentation project like this one, which contains a mix of markdown files for docs and JavaScript/TypeScript files for the Docusaurus site functionality.
The integration fits seamlessly with the existing project structure, which already uses Prettier (as evidenced by the .prettierrc configuration file) and follows modern JavaScript tooling conventions.
Confidence score: 5/5
- This PR is extremely safe to merge with virtually no risk of issues
- Score reflects the standard, well-established tooling with minimal complexity and no breaking changes
- No files require special attention as this is a straightforward tooling addition
1 file reviewed, no comments
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Xe
force-pushed
the
Xe/precommit-hooks
branch
from
7ace141 to
b9aede8
Compare
Executive summary: - Added husky and lint-staged devDependencies and config in package.json. - Added npm scripts: "lint-staged" and "prepare" to ensure husky is installed. - Created .husky/pre-commit to run `npx lint-staged` on commit, which runs Prettier on staged .md/.mdx/.js/.jsx/.ts/.tsx files. Made-with-help-from: GitHub Copilot
Xe
force-pushed
the
Xe/precommit-hooks
branch
from
b9aede8 to
274c998
Compare
Executive summary:
npx lint-stagedon commit, which runs Prettier on staged .md/.mdx/.js/.jsx/.ts/.tsx files.Made-with-help-from: GitHub Copilot