-
Notifications
You must be signed in to change notification settings - Fork 3
/
compositor.json
70 lines (70 loc) · 7.03 KB
/
compositor.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
"name": "Landish/cz-gitmoji",
"version": "0.1.4",
"libraries": {
"xv": "^1.1.25"
},
"title": "",
"branch": "master",
"style": {
"name": "Material",
"componentSet": {
"nav": "nav/DarkAbsoluteNav",
"header": "header/GradientHeader",
"article": "article/BasicArticle",
"footer": "footer/BasicFooter"
},
"fontFamily": "Roboto, sans-serif",
"heading": {
"fontWeight": 500,
"letterSpacing": "-0.01em"
},
"colors": {
"text": "#212121",
"background": "#fff",
"primary": "#2196f3",
"secondary": "#1565c0",
"highlight": "#ff4081",
"border": "#e0e0e0",
"muted": "#f5f5f5"
},
"layout": {
"centered": true,
"bannerHeight": "80vh",
"maxWidth": 896
}
},
"content": [
{
"component": "header",
"heading": "cz-gitmoji",
"subhead": "Commitizen adapter for gitmoji",
"children": [
{
"component": "ui/TweetButton",
"text": "cz-gitmoji: 🔬😜 Commitizen adapter for gitmoji.",
"url": ""
},
{
"component": "ui/GithubButton",
"user": "Landish",
"repo": "cz-gitmoji"
}
],
"text": "$ npm install --global cz-gitmoji",
"links": [
{
"href": "https://github.com/Landish/cz-gitmoji",
"text": "Source Code"
}
]
},
{
"component": "article",
"metadata": {
"source": "github.readme"
},
"html": "\n\n<p>\n<a href=\"https://www.npmjs.com/package/cz-gitmoji\"><img src=\"https://img.shields.io/npm/dt/cz-gitmoji.svg\"></a>\n<a href=\"https://www.npmjs.com/package/cz-gitmoji\"><img src=\"https://img.shields.io/npm/v/cz-gitmoji.svg\"></a>\n<a href=\"https://github.com/Landish/cz-gitmoji/pulls\"><img src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"></a>\n<a href=\"https://github.com/prettier/prettier\"><img src=\"https://img.shields.io/badge/styled_with-prettier-ff69b4.svg\"></a>\n<a href=\"https://github.com/Landish/cz-gitmoji/blob/master/LICENSE\"><img src=\"https://img.shields.io/github/license/Landish/cz-gitmoji.svg\"></a>\n</p>\n\n<blockquote>\n<p><a href=\"https://github.com/commitizen/cz-cli\">Commitizen</a> adapter for <a href=\"https://gitmoji.carloscuesta.me/\">gitmoji</a>.</p>\n</blockquote>\n<p><strong>cz-gitmoji</strong> allows you to easily use gitmojis in your commits using <a href=\"https://github.com/commitizen/cz-cli\">commitizen</a>.</p>\n<pre>? Select the <span class=\"hljs-built_in\">type</span> of change you<span class=\"hljs-string\">'re committing:\n 🎨 - :art: - Improving structure / format of the code.\n ⚡️ - :zap: - Improving performance.\n 🔥 - :fire: - Removing code or files.\n❯ 🐛 - :bug: - Fixing a bug.\n 🚑 - :ambulance: - Critical hotfix.\n ✨ - :sparkles: - Introducing new features.\n 📝 - :memo: - Writing docs.\n 🚀 - :rocket: - Deploying stuff.\n 💄 - :lipstick: - Updating the UI and style files.\n 🎉 - :tada: - Initial commit.\n ✅ - :white_check_mark: - Adding tests.\n 🔒 - :lock: - Fixing security issues.\n 🍎 - :apple: - Fixing something on macOS.\n 🐧 - :penguin: - Fixing something on Linux.\n 🏁 - :checkered_flag: - Fixing something on Windows.\n 🤖 - :robot: - Fixing something on Android.\n 🍏 - :green_apple: - Fixing something on iOS.\n 🔖 - :bookmark: - Releasing / Version tags.\n 🚨 - :rotating_light: - Removing linter warnings.\n 🚧 - :construction: - Work in progress.\n 💚 - :green_heart: - Fixing CI Build. \n ⬇️ - :arrow_down: - Downgrading dependencies.\n ⬆️ - :arrow_up: - Upgrading dependencies.\n 👷 - :construction_worker: - Adding CI build system.\n 📈 - :chart_with_upwards_trend: - Adding analytics or tracking code.\n 🔨 - :hammer: - Refactoring code.\n ➖ - :heavy_minus_sign: - Removing a dependency.\n 🐳 - :whale: - Work about Docker. \n ➕ - :heavy_plus_sign: - Adding a dependency.\n 🔧 - :wrench: - Changing configuration files.\n 🌐 - :globe_with_meridians: - Internationalization and localization.\n ✏️ - :pencil2: - Fixing typos.\n 💩 - :hankey: - Writing bad code that needs to be improved.\n ⏪ - :rewind: - Reverting changes.\n 🔀 - :twisted_rightwards_arrows: - Merging branches.\n 📦 - :package: - Updating compiled files or packages.\n 👽 - :alien: - Updating code due to external API changes.\n 🚚 - :truck: - Moving or renaming files.\n 📄 - :page_facing_up: - Adding or updating license.\n 💥 - :boom: - Introducing breaking changes.\n 🍱 - :bento: - Adding or updating assets.\n 👌 - :ok_hand: - Updating code due to code review changes.\n ♿️ - :wheelchair: - Improving accessibility.\n 💡 - :bulb: - Documenting source code.\n 🍻 - :beers: - Writing code drunkenly.\n 💬 - :speech_balloon: - Updating text and literals.\n 🗃 - :card_file_box: - Performing database related changes.\n 🔊 - :loud_sound: - Adding logs.\n 🔇 - :mute: - Removing logs.</span></pre><h2>Install</h2>\n<pre>$ npm install --global cz-gitmoji</pre><h2>Set Globally</h2>\n<pre><span class=\"hljs-built_in\">echo</span> <span class=\"hljs-string\">'{ "path": "cz-gitmoji" }'</span> > ~/.czrc</pre><p>This will set as default adapter for all your projects.</p>\n<h2>Usage</h2>\n<pre>$ git cz</pre><h2>Customize</h2>\n<p>You can customize types for per project by adding a configuration section in your <code>package.json</code>:</p>\n<pre>{\n <span class=\"hljs-attr\">"config"</span>: {\n <span class=\"hljs-attr\">"cz-gitmoji"</span>: {}\n }\n}</pre><p>For example: </p>\n<pre>{\n <span class=\"hljs-attr\">"config"</span>: {\n <span class=\"hljs-attr\">"cz-gitmoji"</span>: {\n <span class=\"hljs-attr\">"types"</span>: [\n {\n <span class=\"hljs-attr\">"name"</span>: <span class=\"hljs-string\">"bad \\t💩 bad code"</span>,\n <span class=\"hljs-attr\">"value"</span>: <span class=\"hljs-string\">":hankey:"</span>\n }\n ]\n }\n }\n}</pre><h3>Inspired by</h3>\n<ul>\n<li><a href=\"https://gitmoji.carloscuesta.me/\">gitmoji</a></li>\n<li><a href=\"https://github.com/carloscuesta/gitmoji-cli\">gitmoji-cli</a></li>\n<li><a href=\"https://github.com/commitizen/cz-cli\">commitizen</a></li>\n<li><a href=\"https://github.com/commitizen/cz-conventional-changelog\">cz-conventional-changelog</a></li>\n<li><a href=\"https://github.com/ngryman/cz-emoji\">cz-emoji</a></li>\n<li><a href=\"https://github.com/kevin940726/emoji-cz\">emoji-cz</a></li>\n</ul>\n<h2>Licence</h2>\n<p><a href=\"https://github.com/Landish/cz-gitmoji/blob/master/LICENSE\">The MIT License</a></p>\n"
}
]
}