Git Product home page Git Product logo

commitlint-config's Introduction

๐Ÿ‘ท git commit lint

use

commit lint

  • init
pnpm add @commitlint/cli @commitlint/config-conventional --save-dev

echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
  • test
echo "add commit lint" | npx commitlint  # found 2 problems, 0 warnings

echo "feat: add commit lint" | npx commitlint # success

husky

  • init
pnpm add husky --save-dev
npx husky install 
npx husky add .husky/commit-msg
# .husky/commit-msg

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx eslint src/**
npx --no-install commitlint --edit $1
  • test
git commit -m "test" # error, You can skip the check with `-no-verify`

commitizen

  • init
pnpm add commitizen commitlint-config-cz conventional-changelog conventional-changelog-cli cz-customizable --save-dev
npx commitizen init cz-conventional-changelog --yarn --dev --exact
  • test
git cz # use commitizen

Usage

  • pnpm run commit Submit the code and write Message
  • pnpm run version Generating version logs

commitlint-config's People

Contributors

hydenliu avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.