Git is a powerful version control system, but it doesn't inherently guarantee commit quality. You can still commit code with errors, unhelpful messages, or poor formatting. Git hooks provide a solution. This tutorial demonstrates how to implement Git hooks to enforce commit standards, ensuring cleaner codebases and smoother collaboration.
We'll create hooks that only allow commits meeting specific criteria. Failing checks will result in informative error messages guiding you towards correction. As a bonus, passing commits will be automatically formatted.
Prerequisites
Basic familiarity with Node.js, npm, and Git is assumed. If you're unsure about package.json
or git commit -m [message]
, consult the relevant documentation before proceeding.
Our Approach
We'll install dependencies, then set up three commit checks:
- Linting: Code must be free of linting errors.
- Unit Tests: Related unit tests must pass.
- Commit Message Formatting: Messages must adhere to a predefined format (conventional commit format).
Finally, passing commits will be automatically formatted using Prettier. Crucially, these checks only run on staged files, minimizing overhead. The process is stack-agnostic; adapt it to your preferred tools (e.g., Mocha instead of Jest).
Installing Dependencies
First, install Husky (for managing hooks) and lint-staged (for running linters on staged files):
npm i husky lint-staged --save-dev
Next, install commitlint for commit message validation:
npm install @commitlint/{config-conventional,cli} --save-dev
For Windows users:
npm install @commitlint/config-conventional @commitlint/cli --save-dev
Configure commitlint to use the conventional format:
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
Implementing Pre-Commit Hooks
Let's assume a package.json
with these scripts (adjust to your project):
"scripts": { "start": "webpack-dev-server --config ./webpack.dev.js --mode development", "build": "webpack --config ./webpack.prod.js --mode production", "test": "jest", "lint": "tsc --noEmit", "prettier": "prettier --single-quote --print-width 80 \"**/*.{js,ts}\" --write" }
Configure Husky and lint-staged in package.json
:
"husky": { "hooks": { "pre-commit": "lint-staged" } }, "lint-staged": { "./**/*.{ts}": [ "npm run lint", "npm run prettier" ] }
This runs lint
and prettier
on staged TypeScript files before each commit. To include unit tests, add Jest:
"lint-staged": { "./**/*.{ts}": [ "npm run lint", "jest --bail --coverage --findRelatedTests", "npm run prettier" ] }
For commit message validation, add a commit-msg
hook to Husky:
"husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS", "pre-commit": "lint-staged" } },
Now, commits will fail if linting errors, failing tests, or improperly formatted commit messages are detected. Prettier automatically formats passing commits. This streamlined workflow significantly improves code quality and team collaboration.
The above is the detailed content of How I Learned to Stop Worrying and Love Git Hooks. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

There are three ways to create a CSS loading rotator: 1. Use the basic rotator of borders to achieve simple animation through HTML and CSS; 2. Use a custom rotator of multiple points to achieve the jump effect through different delay times; 3. Add a rotator in the button and switch classes through JavaScript to display the loading status. Each approach emphasizes the importance of design details such as color, size, accessibility and performance optimization to enhance the user experience.

To deal with CSS browser compatibility and prefix issues, you need to understand the differences in browser support and use vendor prefixes reasonably. 1. Understand common problems such as Flexbox and Grid support, position:sticky invalid, and animation performance is different; 2. Check CanIuse confirmation feature support status; 3. Correctly use -webkit-, -moz-, -ms-, -o- and other manufacturer prefixes; 4. It is recommended to use Autoprefixer to automatically add prefixes; 5. Install PostCSS and configure browserslist to specify the target browser; 6. Automatically handle compatibility during construction; 7. Modernizr detection features can be used for old projects; 8. No need to pursue consistency of all browsers,

Use the clip-path attribute of CSS to crop elements into custom shapes, such as triangles, circular notches, polygons, etc., without relying on pictures or SVGs. Its advantages include: 1. Supports a variety of basic shapes such as circle, ellipse, polygon, etc.; 2. Responsive adjustment and adaptable to mobile terminals; 3. Easy to animation, and can be combined with hover or JavaScript to achieve dynamic effects; 4. It does not affect the layout flow, and only crops the display area. Common usages are such as circular clip-path:circle (50pxatcenter) and triangle clip-path:polygon (50%0%, 100 0%, 0 0%). Notice

Themaindifferencesbetweendisplay:inline,block,andinline-blockinHTML/CSSarelayoutbehavior,spaceusage,andstylingcontrol.1.Inlineelementsflowwithtext,don’tstartonnewlines,ignorewidth/height,andonlyapplyhorizontalpadding/margins—idealforinlinetextstyling

Setting the style of links you have visited can improve the user experience, especially in content-intensive websites to help users navigate better. 1. Use CSS's: visited pseudo-class to define the style of the visited link, such as color changes; 2. Note that the browser only allows modification of some attributes due to privacy restrictions; 3. The color selection should be coordinated with the overall style to avoid abruptness; 4. The mobile terminal may not display this effect, and it is recommended to combine it with other visual prompts such as icon auxiliary logos.

To create responsive images using CSS, it can be mainly achieved through the following methods: 1. Use max-width:100% and height:auto to allow the image to adapt to the container width while maintaining the proportion; 2. Use HTML's srcset and sizes attributes to intelligently load the image sources adapted to different screens; 3. Use object-fit and object-position to control image cropping and focus display. Together, these methods ensure that the images are presented clearly and beautifully on different devices.

The choice of CSS units depends on design requirements and responsive requirements. 1.px is used for fixed size, suitable for precise control but lack of elasticity; 2.em is a relative unit, which is easily caused by the influence of the parent element, while rem is more stable based on the root element and is suitable for global scaling; 3.vw/vh is based on the viewport size, suitable for responsive design, but attention should be paid to the performance under extreme screens; 4. When choosing, it should be determined based on whether responsive adjustments, element hierarchy relationships and viewport dependence. Reasonable use can improve layout flexibility and maintenance.

Different browsers have differences in CSS parsing, resulting in inconsistent display effects, mainly including the default style difference, box model calculation method, Flexbox and Grid layout support level, and inconsistent behavior of certain CSS attributes. 1. The default style processing is inconsistent. The solution is to use CSSReset or Normalize.css to unify the initial style; 2. The box model calculation method of the old version of IE is different. It is recommended to use box-sizing:border-box in a unified manner; 3. Flexbox and Grid perform differently in edge cases or in old versions. More tests and use Autoprefixer; 4. Some CSS attribute behaviors are inconsistent. CanIuse must be consulted and downgraded.
