{"id":22006395,"url":"https://github.com/anoff/cz-conventional-kawaii","last_synced_at":"2025-05-05T22:38:30.837Z","repository":{"id":15471958,"uuid":"78217511","full_name":"anoff/cz-conventional-kawaii","owner":"anoff","description":"Allow emojified commit messages and clean changelogs 🐼📄","archived":false,"fork":false,"pushed_at":"2023-04-17T19:47:43.000Z","size":842,"stargazers_count":5,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T14:18:19.106Z","etag":null,"topics":["commitizen-adapter","conventional-changelog","emoji","kawaii"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anoff.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.png","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-06T15:44:37.000Z","updated_at":"2022-02-12T06:04:25.000Z","dependencies_parsed_at":"2022-07-20T21:32:22.045Z","dependency_job_id":null,"html_url":"https://github.com/anoff/cz-conventional-kawaii","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anoff%2Fcz-conventional-kawaii","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anoff%2Fcz-conventional-kawaii/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anoff%2Fcz-conventional-kawaii/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anoff%2Fcz-conventional-kawaii/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anoff","download_url":"https://codeload.github.com/anoff/cz-conventional-kawaii/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252588486,"owners_count":21772687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commitizen-adapter","conventional-changelog","emoji","kawaii"],"created_at":"2024-11-30T01:12:04.078Z","updated_at":"2025-05-05T22:38:30.817Z","avatar_url":"https://github.com/anoff.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cz-conventional-kawaii\n\n\u003e Allow emojified commit messages and clean changelogs 🐼📄\n\nYou like emojis and think conventional changelog formatting is a good idea? Well **cz-conventional-kawaii** gives you both. It is basically a blend between `cz-conventional-changelog-atom`, `cz-conventional-changelog` and `cz-emoji`.\n\nTogether with the **atom** preset for `conventional-changelog` it gives you emojis on your git history and clean changelogs.\n\n![default types \u0026 emojis](./types.png)\n\nThe default types and emojis from above give you awesome commit messages like these:\n\n![example messages](./commits.png)\n\nRunning `conventional-changelog -p atom` will format your changelog\n\n\u003cimg src=\"changelog.png\" width=\"400\"/\u003e\n\n## Installation\n\nYou need to have [commitizen](https://github.com/commitizen/cz-cli) installed.\n\n```sh\n# install per project\n$ npm i --save-dev cz-conventional-kawaii\n$ commitizen init cz-conventional-kawaii\n\n# global install for all projects\n$ npm i -g cz-conventional-kawaii\n$ echo '{ \"path\": \"cz-conventional-kawaii\" }' \u003e ~/.czrc\n```\n\n## Usage\n\nAfter you changed some code add it and commit using\n\n```sh\n$ git add . # add all changes\n$ git cz # or git-cz\n```\n\n## Customization\n\nYou can customize **types**, **scopes** and the inquirer **questions** per project or globally.\n\n### per project\n\nTo customize on a per project basis simply add a **config.cz-conventional-kawaii** entry to your `package.json`.\n\nSpecifying a `types` object will replace the default types. The object key will be the type used in the commit message together with the `emoji` entry.\n\nYou can also specify a fixed set of **scope** entries for your project by adding the respective field in the `package.json` config section.\n\nSetting `quick` to a truthy value to only use the `types` and `short description` to define your commit message.\n\n```json\n..\n\"config\": {\n\t\"cz-conventional-kawaii\": {\n\t\t\"types\": {\n\t\t\t\"feat\": {\n\t\t\t\t\"description\": \"feature\\t💖\\tNew feature\",\n\t\t\t\t\"emoji\": \":sparkling_heart:\"\n\t\t\t},\n\t\t\t\"bugfix\": {\n\t\t\t\t\"description\": \"bugfix\\t🐞\\tSquash them bugs!\",\n\t\t\t\t\"emoji\": \":beetle:\"\n\t\t\t}\n\t\t},\n\t\t\"scopes\": [\n\t\t\t\"logout\",\n\t\t\t\"registration\",\n\t\t\t\"update\"\n\t\t],\n\t\t\"quick\": true\n\t}\n}\n```\n\n### globally\n\nFor global configuration just use the same syntax as for project level settings and put them in an **cz-conventional-kawaii** entry.\n\nTo use quick mode by default set `$HOME/.czrc` to:\n\n```json\n{\n    \"path\": \"cz-conventional-kawaii\",\n    \"cz-conventional-kawaii\": {\n        \"quick\": true\n    }\n}\n```\n\n### custom adapter\n\nTo build your own *kawaii* commitizen adapter use **cz-conventional-kawaii** as a dependency and pass it your custom config.\n\n```javascript\n// myadapter.js\nconst convKawaii = require('cz-conventional-kawaii');\nconst myConfig = {\n\ttypes: {} // see lib/types.json for layout\n};\nmodule.exports = convKawaii.module(myConfig);\n```\n## Changelog\n\n`v1.0.0`\n\n- made quick mode even quicker\n- added support of system wide `.czrc` configuration\n\n## License\n\nInspired by https://github.com/ngryman/cz-emoji\n\nMIT © [Andreas Offenhäuser](http://anoff.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanoff%2Fcz-conventional-kawaii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanoff%2Fcz-conventional-kawaii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanoff%2Fcz-conventional-kawaii/lists"}