Git Product home page Git Product logo

git-policy-validator's Introduction

git-policy-validator

๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง

  UNDER CONSTRUCTION

๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง ๐Ÿšง

Description

A simple CLI that can be used to validate branch and commit messages using a regex configuration.

Examples of use:

# Validate commit message
gvalidate -c "Add new feature"

# Validate branch name
gvalidate -b

Configuration

You must use a config file named .gvalidate.config.json. Example config file.

{
  "branch": {
    "regexBranchName": "(feat|fix)/[A-Z]+-[0-9]+",
    "ignoreList": []
  },
  "commit": {
    "regexCommitMessage": "(feat|fix): [A-Z]+-[0-9]+ - .*"
  }
}

Todo

  • Unit tests
  • Custom error messages
  • [...]

Development

To run locally run the following commands.

# After cloning
npm i

npm run build:dev

npx gvalidate -c "feat: Teste message"

git-policy-validator's People

Contributors

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