# commemoji

> A command line tool to make emojify your boring commit messages.

Latest version **1.1.7** (published 2016-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install commemoji
pnpm add commemoji
yarn add commemoji
bun add commemoji
```

Provides the command `commemoji`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2016-02-09 |
| First published | 2016-01-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Joe Martella |
| Maintainers | martellaj |

## Links

- npm: https://www.npmjs.com/package/commemoji
- npm.io page: https://npm.io/package/commemoji

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [emojilib](https://npm.io/package/emojilib.md) ^1.1.0
- [commander](https://npm.io/package/commander.md) ^2.9.0

## Recent versions

- 1.1.7 (latest) — 2016-02-09
- 1.1.6 — 2016-02-02
- 1.1.3 — 2016-01-18
- 1.1.2 — 2016-01-16
- 1.1.1 — 2016-01-13
- 1.1.0 — 2016-01-12
- 1.0.0 — 2016-01-01

## README

# commemoji
[![npm version](https://badge.fury.io/js/commemoji.svg)](https://badge.fury.io/js/commemoji)
[![Build Status](https://travis-ci.org/martellaj/commemoji.svg?branch=master)](https://travis-ci.org/martellaj/commemoji) [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)

A command line tool to make emojify your boring commit messages. :star2:

## Why?
* Emojis are cool. :sunglasses:
* A lot of text is boring. :unamused:
* People like emojis. :smile:
* People don't like to read. :rage:

## Install
```
$ npm install -g commemoji
```

## Usage
Use `commemoji` wherever you'd use `git commit -m`. 

### An emoji with purpose
Want to standardize? Are you fixing a bug, writing docs, adding tests, or something common? Use the `-k` flag with a commit type to get the emoji that best represents your commit. Check out [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) for more info.

```
$ commemoji -k "Fix bug causing random emojis to be returned." "bug"
```

#### Common commit types
* :bug: "bug" | "b" - When fixing a bug.
* :art: "formatting" | "f" - When improving the format/structure of the code.
* :memo: "docs" | "d" - When writing docs.
* :racehorse: "perf" | "p" - When improving performance.
* :penguin: "linux" | "l" - When fixing something on Linux.
* :apple: "mac" | "m" - When fixing something on Mac OS.
* :checkered_flag: "windows" | "w" - When fixing something on Windows.
* :fire: "removal" | "r" - When removing code or files.
* :green_heart: "ci" - When fixing the CI build.
* :white_check_mark: "tests" | "t" - When adding tests.
* :lock: "security" | "s" - When dealing with security.
* :arrow_up: "upgrade dep" | "ud" - When upgrading dependencies.
* :arrow_down: "downgrade dep" | "dd" - When downgrading dependencies.
* :shirt: "lint" - When removing/adding linter warnings. 

### A desired emoji
Want to express something specific with your commit? Just want that :poop:? Use the `-s` flag and specify a query after your commit message.

```
$ commemoji -s "This code is legit, but this message is boring." "fire"
```

### A descriptive emoji
Not sure how you *feel* about the commit? Just supply your message and we'll give you an emoji that describes your commit message, or a random one if we can't find one that does.

```
$ commemoji "This code is legit, but this message is boring."
```

### Replace keywords with emojis
Use the `-r` flag to replace any keywords in your commit message with emojis. This flag can be used with any of the other flags or by itself.

## Thanks
Thanks to @muan and [emojilib](https://github.com/muan/emojilib) for providing an awesome resource for GitHub-supported emojis. :clap: I frequently used their [emoji searcher](http://emoji.muan.co/) before creating this tool.

## License
MIT :copyright: Joe Martella

---
_Source: https://npm.io/package/commemoji · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._