emoji-commit-helpers

v0.1.1

Published

3 years ago

Commitlint and Commitizen helpers for working with Gitmoji

Downloads

0High
0Medium
0Low

snugug

Emoji Commit Helpers

This module assist users in using the Emoji-style git commit format :emoji: (scope) Subject. It currently makes sharing emoji and scope possible between Commitizen and Commitlint easy and can automatically generate package-based scopes for Lerna projects.

Configuring Commitizen and Commitlint

Commitizen

In package.json, add the following:

{
  "config": {
    "commitizen": {
      "path": "./node_modules/emoji-commit-helpers/commitizen.js"
    }
  }
}

Commitlint

In .commitlintrc.js, do the following:

const config = require('emoji-commit-helpers/commitlint');

module.exports = config;

This will set all the rules, patterns, and helpers you need correctly. The commitlint configuration supports either the actual emoji or the emoji code (:code:).

Run Both on Code Commit

To run both Commitizen (to prepare your commit message) and Commitlint (to ensure your commit message is formatted correctly) automatically, first install husky, @commitlint/cli, and @commitizen, then add the following to your package.json file:

{
  "husky": {
    "hooks": {
      "prepare-commit-msg": "exec < /dev/tty && git-cz --hook || true",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

Configuring Emoji Commit Helpers

To configure Emoji Commit Helpers, first add one of the following files:

.commitrc
.commitrc.yml
.commitrc.json
.commitrc.js

Then, configure either the types to include and/or the scopes:

emoji:
  - style
  - perf
  - prune
  - fix
  - quickfix
  - docs
  - feature
scopes:
  - name: Root
    description: Root of my project
  - name: Modules
    description: Project Modules

Available Emoji

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme