devmoji

To automatically emojify and lint your commit messages, you should set up a git hook. The --edit flag allows Devmoji to read and write to .git/COMMIT_EDITMSG.

Using Husky

If you use Husky, add a prepare-commit-msg hook. If you use commit-msg instead, Devmoji will also perform linting.

Using Yorkie

Add the command to your package.json under gitHooks.

Note: If Devmoji is installed locally as a dev dependency, use npx --no-install devmoji -e in your hook configuration.

# Using Husky
$ npx husky install
$ npx husky add .husky/prepare-commit-msg "npx devmoji -e --lint"

// Using Yorkie in package.json
{
  "gitHooks": {
    "prepare-commit-msg": "devmoji -e --lint"
  }
}

You can install Devmoji either globally for use across your system or locally within a specific project.

Global Installation

Use this if you want to use the devmoji command anywhere in your terminal.

Local Installation

Use this to add Devmoji as a development dependency in your project. When installed locally, you should invoke it using npx devmoji.

# Global installation
npm install -g devmoji
yarn global add devmoji

# Local installation
npm install --dev devmoji
yarn add --dev devmoji

When defining custom devmoji entries in your devmoji.config.js, you have two primary ways to specify them:

1. Using Gitmoji: Provide a gitmoji key. The library will automatically resolve the emoji and the description for you.
2. Manual Definition: Provide an emoji and a description directly.

Note: Every entry must have either a gitmoji key or an emoji key. If you use gitmoji, the code field is still required to identify the entry.

// devmoji.config.js
module.exports = {
  types: ['feat', 'fix'],
  devmoji: [
    // Option 1: Resolve via Gitmoji name
    { code: 'feat', gitmoji: 'sparkles' },

    // Option 2: Manual definition
    { code: 'fix', emoji: '🐛', description: 'fixing a bug' }
  ]
};

The devmoji command is a CLI tool used to manage and automate the use of devmojis in your git workflow. It provides commands for emojifying text, managing commits, linting commit messages, and editing existing ones.

To use the tool, ensure it is installed in your environment and then invoke it via the terminal using devmoji followed by your desired command and flags.

devmoji --help

The --lint flag enables validation of conventional commit messages. When enabled, the CLI checks if the commit message follows the expected pattern: type(scope)!: description. It also verifies that the type is included in your configured allowed types.

If linting fails, the CLI will output errors and exit with code 1. Note that linting is automatically disabled when using the --log flag.

devmoji --lint --text "feat: my feature"

The devmoji CLI can be used to transform commit messages using different formats. By default, it reads from stdin if no text is provided via the --text flag. You can specify the output format using the --format flag.

Available Formats:

• unicode: Converts shortcodes to actual emoji characters (default).
• shortcode: Converts emojis back to shortcodes.
• devmoji: Uses the devmojify logic.
• strip: Removes all devmoji related content.

Example: Formatting via stdin

echo ":sparkles: new feature" | devmoji

The --edit flag allows you to automatically process the current commit message being written in Git. It locates the .git/COMMIT_EDITMSG file in your git root, reads the content, applies the devmoji formatting, and writes it back to the file.

devmoji --edit

The --commit flag (enabled by default) automatically attempts to add a devmoji to the conventional commit header. This is particularly useful when piping text or using the --edit mode.

devmoji --commit --text "feat: something"

The --log flag emojifies and colorifies the output of git log. Unlike --commit, it searches for type(scope): message patterns anywhere in the input, making it ideal for viewing history.

Recommended usage with a custom git log format:

$ git log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --decorate --date=short | devmoji --log

To see a complete list of all supported Devmoji aliases and their corresponding emojis, run the command with the --list flag.

$ devmoji --list