chore(squash): 5.0.0-canary.5-11 [skip ci]

5.0.0-canary.5+ into 5.1.0-canary.1

Husky really messed me up so want to remove all the dead-code that got introduced as a result to have less impact on `git-cz`.

This will rewrite `canary` branch and though not ideal we are in a canary state of mind (development).

- [x] docs: ✏️ README update
- [x] chore: 📄️ gitmoji license
- [x] chore: 🙈️ .npmignore
- [x] refactor: 💡️ theme:gitmoji to reduce dynamicism (lint:fix)
- [x] upgrade: husky@5.1.2

Author: JeromeFitz

.eslintignore

@@ -1,2 +1,3 @@
+data/gitmoji/index.json
 dist
-node_modules
+node_modules

.husky/prepare-commit-msg

@@ -1,5 +1,5 @@
 [ -n "$CI" ] && exit 0
 
 yarn pretty-quick --staged
-exec < /dev/tty
-node ./lib/cli.js --hook || true
+#exec < /dev/tty
+#node ./bin/git-cz --hook || true

.npmignore

@@ -21,6 +21,16 @@ yarn.lock
 /docs/
 # fork
 .env
+.eslintignore
+.eslintrc.js
 .github/
 .husky/
+.prettierignore
+.prettierignore_staged
+.prettierrc.js
+CHANGELOG.md
+data/gitmoji/init.json
+lint-staged.config.js
+release.config.js
+renovate.json
 scripts/

.prettierignore

@@ -1,2 +1,3 @@
+data/gitmoji/index.json
 dist
-node_modules
+node_modules

.prettierignore_staged

@@ -1,2 +1,3 @@
+data/gitmoji/index.json
 dist
-node_modules
+node_modules

README.md

@@ -77,6 +77,7 @@ module.exports = {
   minMessageLength: 3,
   questions: ['type', 'scope', 'subject', 'body', 'breaking', 'issues', 'lerna'],
   scopes: [],
+  theme: 'default',
   types: {
     chore: {
       description: 'Build process or auxiliary tool changes',
@@ -189,8 +190,6 @@ This allows the message to be easier to read on GitHub as well as in various git
 
 By default the subject format is: `{type}{scope}: {emoji}{subject}`
 
-You can configure your own using the following fields:
-
 ```bash
 --format "{type}{scope}: {emoji}{subject}"
 ```
@@ -201,8 +200,19 @@ You can configure your own using the following fields:
 }
 ```
 
+You can configure your own using the following fields:
+
+- `{emoji}`
+- `{scope}`
+- `{subject}`
+- `{type}`
+
+These are the _only_ fields that will be dynamically replaced by `git-cz`.
+
 These are not `${type}` so in your configuration if you need to pass dynamically values to `format` you can while keeping these separate. Helpful for when adding ` [skip ci]` to `format` conditionally.
 
+📝️ Note: If your configuration file _is_ dynamic and you want to override these change yours at run time to `${type}` 😅️. These fields are only replaced _if_ they exist. Heck, you can have a format of: `format: "static(hard): code value"` if you really want (please do not).
+
 📝️ Note: If you want to keep emojis in the cli and not in your code commits you can do so with:
 
 ```bash
@@ -243,7 +253,11 @@ A theme override for [gitmoji](https://gitmoji.dev/) is available as an **overri
 }
 ```
 
-Note: `chore` is provided as a `git-cz` fallback for those that enjoy using it. Otherwise all current `git-cz` `default` have a 1:1 map to `gitmoji`.
+You can `extend` this theme by pulling `./dist/gitmoji.json` into your `changelog.config.js` and adding, refactoring as you see fit as well. (Via `yarn build:themes`)
+
+📝️ Note: `chore` is provided as a `git-cz` fallback for those that enjoy using it. Otherwise all current `git-cz` `default` have a 1:1 map to `gitmoji`.
+
+📝️ Note: This will override default types along with their emojis.
 
 ### Type
 

data/gitmoji/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2016-2018 Carlos Cuesta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+ref: https://github.com/carloscuesta/gitmoji/blob/master/LICENSE

data/gitmoji/index.json

@@ -0,0 +1 @@
+{"gitmojiList":["chore","style","perf","prune","fix","quickfix","feat","docs","deploy","ui","init","test","security","release","lint","wip","fix-ci","downgrade","upgrade","pushpin","ci","analytics","refactor","dep-add","dep-rm","config","build","i18n","typo","poo","revert","merge","dep-up","compat","mv","license","breaking","assets","access","docs-code","beer","texts","db","log-add","log-rm","contrib-add","ux","arch","iphone","mock","egg","ignore","snapshot","experiment","seo","types","seed","flags","catch","animation","clean","roles","patch","data","rip"],"gitmojiTypes":{"chore":{"code":":computer_disk:","description":"Changes that don’t modify src or test files","emoji":"💽️","entity":"💽","hidden":false,"name":"computer-disk","release":null,"section":"Changes that don’t modify src or test files","semver":null,"value":"chore"},"style":{"code":":art:","description":"Improve structure / format of the code.","emoji":"🎨","entity":"🎨","hidden":false,"name":"art","release":null,"section":"Improve structure / format of the code.","semver":null,"value":"style"},"perf":{"code":":zap:","description":"Improve performance.","emoji":"⚡️","entity":"⚡","hidden":false,"name":"zap","release":"patch","section":"Improve performance.","semver":"patch","value":"perf"},"prune":{"code":":fire:","description":"Remove code or files.","emoji":"🔥","entity":"🔥","hidden":false,"name":"fire","release":null,"section":"Remove code or files.","semver":null,"value":"prune"},"fix":{"code":":bug:","description":"Fix a bug.","emoji":"🐛","entity":"🐛","hidden":false,"name":"bug","release":"patch","section":"Fix a bug.","semver":"patch","value":"fix"},"quickfix":{"code":":ambulance:","description":"Critical hotfix.","emoji":"🚑","entity":"🚑","hidden":false,"name":"ambulance","release":"patch","section":"Critical hotfix.","semver":"patch","value":"quickfix"},"feat":{"code":":sparkles:","description":"Introduce new features.","emoji":"✨","entity":"✨","hidden":false,"name":"sparkles","release":"minor","section":"Introduce new features.","semver":"minor","value":"feat"},"docs":{"code":":memo:","description":"Add or update documentation.","emoji":"📝","entity":"📝","hidden":false,"name":"memo","release":null,"section":"Add or update documentation.","semver":null,"value":"docs"},"deploy":{"code":":rocket:","description":"Deploy stuff.","emoji":"🚀","entity":"🚀","hidden":false,"name":"rocket","release":null,"section":"Deploy stuff.","semver":null,"value":"deploy"},"ui":{"code":":lipstick:","description":"Add or update the UI and style files.","emoji":"💄","entity":"&#ff99cc;","hidden":false,"name":"lipstick","release":"patch","section":"Add or update the UI and style files.","semver":"patch","value":"ui"},"init":{"code":":tada:","description":"Begin a project.","emoji":"🎉","entity":"🎉","hidden":false,"name":"tada","release":null,"section":"Begin a project.","semver":null,"value":"init"},"test":{"code":":white_check_mark:","description":"Add or update tests.","emoji":"✅","entity":"✅","hidden":false,"name":"white-check-mark","release":null,"section":"Add or update tests.","semver":null,"value":"test"},"security":{"code":":lock:","description":"Fix security issues.","emoji":"🔒","entity":"🔒","hidden":false,"name":"lock","release":"patch","section":"Fix security issues.","semver":"patch","value":"security"},"release":{"code":":bookmark:","description":"Release / Version tags.","emoji":"🔖","entity":"🔖","hidden":false,"name":"bookmark","release":null,"section":"Release / Version tags.","semver":null,"value":"release"},"lint":{"code":":rotating_light:","description":"Fix compiler / linter warnings.","emoji":"🚨","entity":"🚨","hidden":false,"name":"rotating-light","release":null,"section":"Fix compiler / linter warnings.","semver":null,"value":"lint"},"wip":{"code":":construction:","description":"Work in progress.","emoji":"🚧","entity":"🚧","hidden":false,"name":"construction","release":null,"section":"Work in progress.","semver":null,"value":"wip"},"fix-ci":{"code":":green_heart:","description":"Fix CI Build.","emoji":"💚","entity":"💚","hidden":false,"name":"green-heart","release":null,"section":"Fix CI Build.","semver":null,"value":"fix-ci"},"downgrade":{"code":":arrow_down:","description":"Downgrade dependencies.","emoji":"⬇️","entity":"⬇️","hidden":false,"name":"arrow-down","release":"patch","section":"Downgrade dependencies.","semver":"patch","value":"downgrade"},"upgrade":{"code":":arrow_up:","description":"Upgrade dependencies.","emoji":"⬆️","entity":"⬆️","hidden":false,"name":"arrow-up","release":"patch","section":"Upgrade dependencies.","semver":"patch","value":"upgrade"},"pushpin":{"code":":pushpin:","description":"Pin dependencies to specific versions.","emoji":"📌","entity":"📌","hidden":false,"name":"pushpin","release":"patch","section":"Pin dependencies to specific versions.","semver":"patch","value":"pushpin"},"ci":{"code":":construction_worker:","description":"Add or update CI build system.","emoji":"👷","entity":"👷","hidden":false,"name":"construction-worker","release":null,"section":"Add or update CI build system.","semver":null,"value":"ci"},"analytics":{"code":":chart_with_upwards_trend:","description":"Add or update analytics or track code.","emoji":"📈","entity":"📈","hidden":false,"name":"chart-with-upwards-trend","release":"patch","section":"Add or update analytics or track code.","semver":"patch","value":"analytics"},"refactor":{"code":":recycle:","description":"Refactor code.","emoji":"♻️","entity":"♲","hidden":false,"name":"recycle","release":null,"section":"Refactor code.","semver":null,"value":"refactor"},"dep-add":{"code":":heavy_plus_sign:","description":"Add a dependency.","emoji":"➕","entity":"➕","hidden":false,"name":"heavy-plus-sign","release":"patch","section":"Add a dependency.","semver":"patch","value":"dep-add"},"dep-rm":{"code":":heavy_minus_sign:","description":"Remove a dependency.","emoji":"➖","entity":"➖","hidden":false,"name":"heavy-minus-sign","release":"patch","section":"Remove a dependency.","semver":"patch","value":"dep-rm"},"config":{"code":":wrench:","description":"Add or update configuration files.","emoji":"🔧","entity":"🔧","hidden":false,"name":"wrench","release":"patch","section":"Add or update configuration files.","semver":"patch","value":"config"},"build":{"code":":hammer:","description":"Add or update development scripts.","emoji":"🔨","entity":"🔨","hidden":false,"name":"hammer","release":null,"section":"Add or update development scripts.","semver":null,"value":"build"},"i18n":{"code":":globe_with_meridians:","description":"Internationalization and localization.","emoji":"🌐","entity":"🌐","hidden":false,"name":"globe-with-meridians","release":"patch","section":"Internationalization and localization.","semver":"patch","value":"i18n"},"typo":{"code":":pencil2:","description":"Fix typos.","emoji":"✏️","entity":"","hidden":false,"name":"pencil2","release":"patch","section":"Fix typos.","semver":"patch","value":"typo"},"poo":{"code":":poop:","description":"Write bad code that needs to be improved.","emoji":"💩","entity":"","hidden":false,"name":"poop","release":null,"section":"Write bad code that needs to be improved.","semver":null,"value":"poo"},"revert":{"code":":rewind:","description":"Revert changes.","emoji":"⏪","entity":"⏪","hidden":false,"name":"rewind","release":"patch","section":"Revert changes.","semver":"patch","value":"revert"},"merge":{"code":":twisted_rightwards_arrows:","description":"Merge branches.","emoji":"🔀","entity":"🔀","hidden":false,"name":"twisted-rightwards-arrows","release":null,"section":"Merge branches.","semver":null,"value":"merge"},"dep-up":{"code":":package:","description":"Add or update compiled files or packages.","emoji":"📦","entity":"&#1F4E6;","hidden":false,"name":"package","release":"patch","section":"Add or update compiled files or packages.","semver":"patch","value":"dep-up"},"compat":{"code":":alien:","description":"Update code due to external API changes.","emoji":"👽","entity":"&#1F47D;","hidden":false,"name":"alien","release":"patch","section":"Update code due to external API changes.","semver":"patch","value":"compat"},"mv":{"code":":truck:","description":"Move or rename resources (e.g.: files, paths, routes).","emoji":"🚚","entity":"&#1F69A;","hidden":false,"name":"truck","release":null,"section":"Move or rename resources (e.g.: files, paths, routes).","semver":null,"value":"mv"},"license":{"code":":page_facing_up:","description":"Add or update license.","emoji":"📄","entity":"&#1F4C4;","hidden":false,"name":"page-facing-up","release":null,"section":"Add or update license.","semver":null,"value":"license"},"breaking":{"code":":boom:","description":"Introduce breaking changes.","emoji":"💥","entity":"💥","hidden":false,"name":"boom","release":"major","section":"Introduce breaking changes.","semver":"major","value":"breaking"},"assets":{"code":":bento:","description":"Add or update assets.","emoji":"🍱","entity":"&#1F371","hidden":false,"name":"bento","release":"patch","section":"Add or update assets.","semver":"patch","value":"assets"},"access":{"code":":wheelchair:","description":"Improve accessibility.","emoji":"♿️","entity":"♿","hidden":false,"name":"wheelchair","release":"patch","section":"Improve accessibility.","semver":"patch","value":"access"},"docs-code":{"code":":bulb:","description":"Add or update comments in source code.","emoji":"💡","entity":"💡","hidden":false,"name":"bulb","release":null,"section":"Add or update comments in source code.","semver":null,"value":"docs-code"},"beer":{"code":":beers:","description":"Write code drunkenly.","emoji":"🍻","entity":"🍻","hidden":false,"name":"beers","release":null,"section":"Write code drunkenly.","semver":null,"value":"beer"},"texts":{"code":":speech_balloon:","description":"Add or update text and literals.","emoji":"💬","entity":"💬","hidden":false,"name":"speech-balloon","release":"patch","section":"Add or update text and literals.","semver":"patch","value":"texts"},"db":{"code":":card_file_box:","description":"Perform database related changes.","emoji":"🗃","entity":"🗃","hidden":false,"name":"card-file-box","release":"patch","section":"Perform database related changes.","semver":"patch","value":"db"},"log-add":{"code":":loud_sound:","description":"Add or update logs.","emoji":"🔊","entity":"🔊","hidden":false,"name":"loud-sound","release":null,"section":"Add or update logs.","semver":null,"value":"log-add"},"log-rm":{"code":":mute:","description":"Remove logs.","emoji":"🔇","entity":"🔇","hidden":false,"name":"mute","release":null,"section":"Remove logs.","semver":null,"value":"log-rm"},"contrib-add":{"code":":busts_in_silhouette:","description":"Add or update contributor(s).","emoji":"👥","entity":"👥","hidden":false,"name":"busts-in-silhouette","release":null,"section":"Add or update contributor(s).","semver":null,"value":"contrib-add"},"ux":{"code":":children_crossing:","description":"Improve user experience / usability.","emoji":"🚸","entity":"🚸","hidden":false,"name":"children-crossing","release":"patch","section":"Improve user experience / usability.","semver":"patch","value":"ux"},"arch":{"code":":building_construction:","description":"Make architectural changes.","emoji":"🏗","entity":"&#1f3d7;","hidden":false,"name":"building-construction","release":null,"section":"Make architectural changes.","semver":null,"value":"arch"},"iphone":{"code":":iphone:","description":"Work on responsive design.","emoji":"📱","entity":"📱","hidden":false,"name":"iphone","release":"patch","section":"Work on responsive design.","semver":"patch","value":"iphone"},"mock":{"code":":clown_face:","description":"Mock things.","emoji":"🤡","entity":"🤡","hidden":false,"name":"clown-face","release":null,"section":"Mock things.","semver":null,"value":"mock"},"egg":{"code":":egg:","description":"Add or update an easter egg.","emoji":"🥚","entity":"🥚","hidden":false,"name":"egg","release":"patch","section":"Add or update an easter egg.","semver":"patch","value":"egg"},"ignore":{"code":":see_no_evil:","description":"Add or update a .gitignore file.","emoji":"🙈","entity":"&#8bdfe7;","hidden":false,"name":"see-no-evil","release":null,"section":"Add or update a .gitignore file.","semver":null,"value":"ignore"},"snapshot":{"code":":camera_flash:","description":"Add or update snapshots.","emoji":"📸","entity":"📸","hidden":false,"name":"camera-flash","release":null,"section":"Add or update snapshots.","semver":null,"value":"snapshot"},"experiment":{"code":":alembic:","description":"Perform experiments.","emoji":"⚗","entity":"📸","hidden":false,"name":"alembic","release":"patch","section":"Perform experiments.","semver":"patch","value":"experiment"},"seo":{"code":":mag:","description":"Improve SEO.","emoji":"🔍","entity":"🔍","hidden":false,"name":"mag","release":"patch","section":"Improve SEO.","semver":"patch","value":"seo"},"types":{"code":":label:","description":"Add or update types.","emoji":"🏷️","entity":"🏷","hidden":false,"name":"label","release":"patch","section":"Add or update types.","semver":"patch","value":"types"},"seed":{"code":":seedling:","description":"Add or update seed files.","emoji":"🌱","entity":"🌱","hidden":false,"name":"seedling","release":null,"section":"Add or update seed files.","semver":null,"value":"seed"},"flags":{"code":":triangular_flag_on_post:","description":"Add, update, or remove feature flags.","emoji":"🚩","entity":"🚩","hidden":false,"name":"triangular-flag-on-post","release":"patch","section":"Add, update, or remove feature flags.","semver":"patch","value":"flags"},"catch":{"code":":goal_net:","description":"Catch errors.","emoji":"🥅","entity":"🥅","hidden":false,"name":"goal-net","release":"patch","section":"Catch errors.","semver":"patch","value":"catch"},"animation":{"code":":dizzy:","description":"Add or update animations and transitions.","emoji":"💫","entity":"💫","hidden":false,"name":"animation","release":"patch","section":"Add or update animations and transitions.","semver":"patch","value":"animation"},"clean":{"code":":wastebasket:","description":"Deprecate code that needs to be cleaned up.","emoji":"🗑","entity":"🗑","hidden":false,"name":"wastebasket","release":"patch","section":"Deprecate code that needs to be cleaned up.","semver":"patch","value":"clean"},"roles":{"code":":passport_control:","description":"Work on code related to authorization, roles and permissions.","emoji":"🛂","entity":"🛂","hidden":false,"name":"passport-control","release":"patch","section":"Work on code related to authorization, roles and permissions.","semver":"patch","value":"roles"},"patch":{"code":":adhesive_bandage:","description":"Simple fix for a non-critical issue.","emoji":"🩹","entity":"🩹","hidden":false,"name":"adhesive-bandage","release":"patch","section":"Simple fix for a non-critical issue.","semver":"patch","value":"patch"},"data":{"code":":monocle_face:","description":"Data exploration/inspection.","emoji":"🧐","entity":"🧐","hidden":false,"name":"monocle-face","release":null,"section":"Data exploration/inspection.","semver":null,"value":"data"},"rip":{"code":":coffin:","description":"Remove dead code.","emoji":"⚰️","entity":"⚰","hidden":false,"name":"coffin","release":null,"section":"Remove dead code.","semver":null,"value":"rip"}}}