{"id":18269051,"url":"https://github.com/tw93/cz-emoji-chinese","last_synced_at":"2025-07-30T04:08:52.924Z","repository":{"id":41337119,"uuid":"271545870","full_name":"tw93/cz-emoji-chinese","owner":"tw93","description":"🚴 炫酷的中文版本的 git commit emoji  🐛🎨✨ 🔥💄📝 🎉 命令行","archived":false,"fork":false,"pushed_at":"2023-08-01T01:59:42.000Z","size":135,"stargazers_count":143,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-24T09:14:48.502Z","etag":null,"topics":["git","git-emoji","github"],"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/tw93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-11T12:54:14.000Z","updated_at":"2025-06-28T18:26:37.000Z","dependencies_parsed_at":"2024-06-19T04:08:16.068Z","dependency_job_id":"0252a4e5-0b5d-4be2-baab-193947460f28","html_url":"https://github.com/tw93/cz-emoji-chinese","commit_stats":{"total_commits":68,"total_committers":12,"mean_commits":5.666666666666667,"dds":0.5588235294117647,"last_synced_commit":"7d561f7f54f558a70ddf4dd02f26fa92630e9484"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/tw93/cz-emoji-chinese","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2Fcz-emoji-chinese","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2Fcz-emoji-chinese/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2Fcz-emoji-chinese/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2Fcz-emoji-chinese/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tw93","download_url":"https://codeload.github.com/tw93/cz-emoji-chinese/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2Fcz-emoji-chinese/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267808142,"owners_count":24147378,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["git","git-emoji","github"],"created_at":"2024-11-05T11:34:23.124Z","updated_at":"2025-07-30T04:08:52.888Z","avatar_url":"https://github.com/tw93.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cz-emoji-chinese\n\n\u003e 中文版本的 git 提交 emoji 提示\n\n**cz-emoji-chinese** allows you to easily use emojis in your commits using [commitizen] with chinese.\n\n![ScreenFlow](https://qpluspicture.oss-cn-beijing.aliyuncs.com/4To9Mo/ScreenFlow.gif)\n\n## Install\n\n**Globally**\n\n```bash\nsudo npm i commitizen cz-emoji-chinese -g\n\n# Method 1: set as default adapter for your projects\necho '{ \"path\": \"cz-emoji-chinese\" }' \u003e ~/.czrc\n\n# Method 2: If you want minimalist mode, you can set it like this\necho '{ \"path\": \"cz-emoji-chinese\", \"config\": { \"cz-emoji-chinese\": { \"skipQuestions\": [ \"issues\", \"scope\",\"body\" ],\"subjectMinLength\": 1 } } }' \u003e ~/.czrc\n```\n\n**Locally**\n\n```bash\nnpm install --save-dev commitizen cz-emoji-chinese\n```\n\nAdd this to your `package.json`:\n\n```json\n\"config\": {\n  \"commitizen\": {\n     \"path\": \"./node_modules/cz-emoji-chinese\"\n  },\n}\n```\n\n## Usage\n\n```sh\n$ git cz\n```\n\n## Customization\n\nBy default `cz-emoji-chinese` comes ready to run out of the box. Uses may vary, so there are a few configuration options to allow fine tuning for project needs.\n\n### How to\n\nConfiguring `cz-emoji-chinese` can be handled in the users home directory (`~/.czrc`) for changes to impact all projects or on a per project basis (`package.json`). Simply add the config property as shown below to the existing object in either of the locations with your settings for override.\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {}\n  }\n}\n```\n\n### Configuration Options\n\n#### Skip Questions\n\nAn array of questions you want to skip:\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"skipQuestions\": [\"scope\", \"issues\"]\n    }\n  }\n}\n```\n\n.czrc like this:\n\n```js\n{\n  \"path\": \"cz-emoji-chinese\",\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"skipQuestions\": [\n        \"issues\",\n        \"scope\"\n      ]\n    }\n  }\n}\n```\n\nYou can skip the following questions: `scope`, `body`, and `issues`. The `type` and `subject` questions are mandatory.\n\n#### Types\n\nBy default `cz-emoji-chinese` comes preconfigured with the [Gitmoji](https://gitmoji.carloscuesta.me/) types.\n\nAn [Inquirer.js] choices array:\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"types\": [\n        {\n          \"emoji\": \"🌟\",\n          \"code\": \":star2:\",\n          \"description\": \"A new feature\",\n          \"name\": \"feature\"\n        }\n      ]\n    }\n  }\n}\n```\n\n#### Scopes\n\nAn [Inquirer.js] choices array:\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"scopes\": [\"home\", \"accounts\", \"ci\"]\n    }\n  }\n}\n```\n\n#### Symbol\n\nA boolean value that allows for an using a unicode value rather than the default of [Gitmoji](https://gitmoji.carloscuesta.me/) markup in a commit message. The default for symbol is false.\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"symbol\": true\n    }\n  }\n}\n```\n\n#### Customize Questions\n\nAn object that contains overrides of the original questions:\n\n```json\n{\n  \"config\": {\n    \"cz-emoji-chinese\": {\n      \"questions\": {\n        \"body\": \"This will be displayed instead of original text\"\n      }\n    }\n  }\n}\n```\n\n## Examples\n\n- https://github.com/Falieson/TRAM\n\n## Commitlint\n\nCommitlint can be set to work with this package by leveraging the package https://github.com/arvinxx/commitlint-config-gitmoji.\n\n```bash\nnpm install --save-dev commitlint-config-gitmoji\n```\n\n_commitlint.config.js_\n\n```js\nmodule.exports = {\n  extends: ['gitmoji'],\n  parserPreset: {\n    parserOpts: {\n      headerPattern: /^(:\\w*:)(?:\\s)(?:\\((.*?)\\))?\\s((?:.*(?=\\())|.*)(?:\\(#(\\d*)\\))?/,\n      headerCorrespondence: ['type', 'scope', 'subject', 'ticket']\n    }\n  }\n}\n```\n\n## License\n\nMIT © Tw93\n\n## Changelog\n\n### 0.3.1\n\n- [+] add `subjectMinLength` for Config\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftw93%2Fcz-emoji-chinese","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftw93%2Fcz-emoji-chinese","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftw93%2Fcz-emoji-chinese/lists"}