1.0.4 β€’ Published 4 years ago

gimmit v1.0.4

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Gimmit

git commit but cuter ✨

What it does

Gimmit is nothing more than tiny little opinionated terminal prompt to hopefully make mundane commit messages a bit more joyful (or more meaningful, if you want).

You'd still use your regular git commands, you can just use gimmit instead of your everyday git commit.

See below πŸŒ…

Gimmit demo

Opinionated? Whuuu? The emojis are curated by yours truly. There is a "Random" commit that selects from a pool of curatedβ„’ gimmit emojis 😘

How to install

Assuming you already have git cli installed on your machine and you've setup authentication etc. then you can simply install Gimmit globally via npm install -g gimmit or yarn global add gimmit.

Once installed, You can now simply type gimmit into a terminal window when you want to make a commit to your repo and just follow the prompts.

Custom configuration

Just make a .gimmitrc.json in your root directory.

You can pass in your own options for both commit flavors and the pool of emoji the random function selects from.

Note: The random option is always the first option even though you pass in your own set.

// .gimmitrc.json
{
  "options": [
    {
      "label": "Custom option",
      "emoji": "πŸ¦„"
    }
  ],
  "emojiPool": [
    "πŸ™",
    "🌻"
  ]
}

You can have fun with this! You can replace the emoji with anything: say, you want to have consistent "labeled" commits in your team, or just for yourself, then you can do something like:

// .gimmitrc.json
{
  "options": [
    {
      "label": "Visual Design",
      "emoji": "[VISUAL]"
    }, {
      "label": "Final final",
      "emoji": "[FINALFINALv3]",
    }
  ],
  "emojiPool": [
    "[I ATE BANANA]",
    "[GIMME BURGER]"
  ]
}

Have fun!

Plans

  • Override configuration and customize the selects via a .gimmitconfig
  • Adds prompt to push to remote
  • Add the possibility for validations for commit messages

P.S.

Peace and love πŸ’–

1.0.4

4 years ago

1.0.2

4 years ago

1.0.3

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago