Modern native git hooks made easy More Info
npx husky-init && npm installIt will setup husky, modify package.json and create a sample pre-commit hook that you can edit. By default, it will run npm test when you commit.
Commit lint helps your team adhering to a commit convention. By supporting npm-installed configurations it makes sharing of commit conventions easy. more info
Install commitlint globally
npm install -g @commitlint/cli @commitlint/config-conventionalnpm install @commitlint/cli @commitlint/config-conventionalCopy the code below to your commitlint.config.js
const Configuration = {
/*
* Resolve and load @commitlint/config-conventional from node_modules.
* Referenced packages must be installed
*/
extends: ['@commitlint/config-conventional'],
/*
* Custom URL to show upon failure
*/
helpUrl:
'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
/*
* Custom prompt configs
*/
prompt: {
messages: {},
questions: {
type: {
description: 'please input type:'
}
}
}
}
module.exports = ConfigurationRuns Prettier on your changed files more info.
Install
npm install --save-dev prettier pretty-quickAdd this code to you .husky/precommit file
echo 'Starting prettier...'
npx pretty-quick --staged
Run linters against staged git files and don't let 💩 slip into your code base! more info
Install ``bash npm install -D lint-staged
`
`
`
`
Add the following to your `.husky/precommit` file
```bash
# lint-stages
echo 'Starting eslint...'
npx lint-staged "$1"
Intall ESLint
npm install eslint --save-devCreate an eslint config file
Use the eslint config interactive command tool
npx eslint --init
or create using the following
`
`
`
`
```json
{
"env": {
"browser": true,
"es2021": true,
"node": true
},
"extends": ["standard"],
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "script"
},
"rules": {},
"ignorePatterns": ["temp.js", "**/vendor/*.js", "**/node_modules/*.js"]
}Create a .eslintignore file in your project root
node_modules
package-lock.json
# Cache
.npm
.cache
.eslintcache
# ignore built packages
dist
esm
public
generated
*.min.js
# Coverage
coverage
# Output of 'npm pack'
*.tgz
# Mac files
.DS_Store
# Logs
logs
*.log
*.hbs
**/node_modules/**
**/build/**
**/coverage/**
**/docs/**
**/dist/**A mighty, modern linter that helps you avoid errors and enforce conventions in your styles. more info
Install
npm install --save-dev stylelint stylelint-config-standardCreate a .stylelintrc.json configuration file in the root of your project with the following content:
{
"extends": "stylelint-config-standard"
}"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"husky": {
"hooks": {}
},
"lint-staged": {
"*.js": "eslint --fix",
"*.{scss, css}": "stylelint --fix"
}You can get all the files from on gist (updated) open
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
# npm test
echo 'Starting prettier...'
npx pretty-quick --staged "$1"
# lint-stages
echo 'Starting eslint...'
npx lint-staged "$1"
# commitizen
echo 'Starting commitlint...'
npx --no -- commitlint --edit "$1"
# If everything passes... Now we can commit
echo '✅✅✅✅ Excellent all test passed, I am committing this now...'
# ignore built packages
dist
esm
public
generated
*.min.js
# Coverage
coverage
# Output of 'npm pack'
*.tgz
# Mac files
.DS_Store
# Logs
logs
*.log
*.hbs
**/node_modules/**
**/build/**
**/coverage/**
**/docs/**
**/dist/**A mighty, modern linter that helps you avoid errors and enforce conventions in your styles. more info
Install
npm install --save-dev stylelint stylelint-config-standardCreate a .stylelintrc.json configuration file in the root of your project with the following content:
{
"extends": "stylelint-config-standard"
}webhint helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors. more info
Install
npm i -D hintCreate a hintrc
run npx create hintrc to create a hintrc file
Add a .hintrc file to you project root
{
"extends": ["accessibility"]
}"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"husky": {
"hooks": {}
},
"lint-staged": {
"*.js": "eslint --fix",
"*.{scss, css}": "stylelint --fix"
}HUSKY PRE-COMMIT
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
# npm test
echo 'Starting prettier...'
npx pretty-quick --staged "$1"
# lint-stages
echo 'Starting eslint...'
npx lint-staged "$1"
# commitizen
echo 'Starting commitlint...'
npx --no -- commitlint --edit "$1"
# If everything passes... Now we can commit
echo '✅✅✅✅ Excellent all test passed, I am committing this now...'You can get all the files from on gist (updated) open
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages more info.
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]A VS code extension that allows to write quickly write standard conventional commit messages Download
- Open the
.git/COMMIT_EDITMSGfile and remove all content. - Create a new commit with the
--amendoption