https://github.com/rohitpal0123/pre-commit-hooks-config
This is a pre commit hooks configuration for NodeJS using husky, lint-staged, eslint and prettier
https://github.com/rohitpal0123/pre-commit-hooks-config
eslint-config git-hooks husky husky-config husky-hooks lint-staged nodejs-server pre-commit-hooks prettier prettier-config
Last synced: about 2 months ago
JSON representation
This is a pre commit hooks configuration for NodeJS using husky, lint-staged, eslint and prettier
- Host: GitHub
- URL: https://github.com/rohitpal0123/pre-commit-hooks-config
- Owner: Rohitpal0123
- Created: 2024-01-24T16:41:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-25T15:20:53.000Z (over 1 year ago)
- Last Synced: 2025-06-27T08:42:11.169Z (3 months ago)
- Topics: eslint-config, git-hooks, husky, husky-config, husky-hooks, lint-staged, nodejs-server, pre-commit-hooks, prettier, prettier-config
- Homepage:
- Size: 2.93 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pre-commit Hooks Setup for Linting and Formatting with Husky, lint-staged, Prettier, and ESLint
1. Download lint-staged and Prettier using npm i command:
```bash
npm i lint-staged prettier --save-dev
```
2. First, install by setting up the initial ESLint config file:
```bash
npx init eslint/config
```
After the file is installed, you will find it in the root directory as `.eslintrc.js`.
3. Set up lint-staged in package.json:
```json
"lint-staged": {
"./**/*.js": [
"prettier --write",
"eslint --fix"
]
}
```
This configuration ensures that Prettier and ESLint will only be applied to staged changes and not the whole repository.
4. To check if the formatting and linting are set up properly, make small insignificant changes, stage them (using `git add -A`), and run the command:
```bash
npx lint-staged
```
If everything written in the editor is properly formatted and no mistakes are made, no error will be thrown.
## Setting up Husky for pre-commit hooks
Now, let's set up Husky to add the lint-staged command in Git hooks as pre-commit hooks.
1. Install Husky as a devDependency in your project:
```bash
npm install husky --save-dev
```
2. Initialize Husky:
```bash
npx husky install
```
3. Create a Husky configuration file by adding the following script to your `package.json` file:
```json
"husky": {
"hooks": {
"pre-commit": "npx lint-staged"
}
}
```
This configuration tells Husky to execute the `lint-staged` command before every commit.
4. Verify the Setup: Make a new change to your code, stage it (using `git add -A`), and then attempt to commit the changes:
```bash
git commit -m "Your commit message"
```
If everything is set up correctly, Husky will run `lint-staged`, which in turn will handle linting and formatting before the commit is finalized.
## Credits- https://youtu.be/_ssKvmZqSnk?si=faUmqNfTURPNajei