Skip to content
This repository has been archived by the owner on Oct 21, 2023. It is now read-only.

crystal-ball/commitizen-base

Repository files navigation

Crystal Ball Projects documentation

Package version NPM downloads Build status Known vulnerabilities Test coverage Maintainability :status      
Renovate Commitizen friendly ZenHub Semantic Release Contributor Covenant :integrations
Contains magic Full of love :flair       


Automated commit message formatting with Commitizen


This package contains an adapter for using Commitizen with 🔮 Projects. Standardized commit messages are constructed using an interactive prompt with options for long descriptions, emojis, breaking change notes and release notes.


Commits generated with this package will automatically follow the ESLint commit fomat.

⚙️ Setup

1. Install

npm i -D @crystal-ball/commitizen-base husky

2. Configure package.json

{
  "config": {
    "commitizen": {
      "path": "@crystal-ball/commitizen-base"
    }
  },
  "husky": {
    "hooks": {
      "prepare-commit-msg": "exec < /dev/tty && git cz --hook"
    }
  }
}