Giter Club home page Giter Club logo

commitlint-demo's Introduction

配置提交规范

一个使用 husky 和 commitlint 来规定提交规范的 Demo

husky

一个使用 git hook 的库,可以在提交前跑一些脚本整理提交信息,比如运行测试、lint 代码等。Husky 支持所有 Git 钩子 https://typicode.github.io/husky/

install husky

npm install husky --save-dev

commitlint

# Install and configure if needed
npm install --save-dev @commitlint/{cli,config-conventional}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

添加钩子

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

随后在项目根目录下创建文件 commitlint.config.js 配置规则 具体规则看官网,demo 简单的配置了个

module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    // 限制提交type只能为feat、fix、doc中其中一个
    "type-enum": [2, "always", ["feat", "fix", "doc"]],
  },
};

commitlint-demo's People

Contributors

annnyg 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.