Skip to content

Your Commit Comrade - A tool to check that commits adhere to your comunal rules

License

Notifications You must be signed in to change notification settings

maeriens/commie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c256ceb · Apr 19, 2020

History

1 Commit
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020
Apr 19, 2020

Repository files navigation

Commie

Your Commit Comrade!

Commie is a tool to check your commit messages following some preestablished rules by you

Usage

In the root folder of the project, create a .commierc, .commierc.yaml, .commierc.yml, .commierc.json, or a .commierc.js exporting an object file with the desired options; or add a commie property to the package.json.

To check the commit message, add commie to the scripts section.

Adding no severity to a rule sets it to WARNING. Matchers are required for all rules save for Capitalized which ignores it.

Rules

  • Start
  • End
  • Contains
  • Capitalized

Example

.commierc

{
  "start": {
    "severity": "error",
    "matchers": ["feature", "fix", "hotfix", "bugfix"]
  },
  "contains": {
    "severity": "warn",
    "matchers": "JIRA-"
  },
  "capitalized": { 
    "severity": "warn"
  }
}

Husky Integration

"husky": {
    "hooks": {
      "commit-msg": "npm run commie"
    }
  }

Links

About

Your Commit Comrade - A tool to check that commits adhere to your comunal rules

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published