{"id":13433372,"url":"https://github.com/ccnnde/commitlint-config-git-commit-emoji","last_synced_at":"2025-06-20T06:08:13.590Z","repository":{"id":57204213,"uuid":"437451299","full_name":"ccnnde/commitlint-config-git-commit-emoji","owner":"ccnnde","description":"Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled","archived":false,"fork":false,"pushed_at":"2021-12-12T05:45:38.000Z","size":3,"stargazers_count":11,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-04T03:01:01.337Z","etag":null,"topics":["angular","commit","commitlint","commitlint-config","emoji","git"],"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/ccnnde.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}},"created_at":"2021-12-12T04:22:08.000Z","updated_at":"2025-04-29T01:35:55.000Z","dependencies_parsed_at":"2022-08-29T17:20:54.674Z","dependency_job_id":null,"html_url":"https://github.com/ccnnde/commitlint-config-git-commit-emoji","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ccnnde/commitlint-config-git-commit-emoji","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccnnde%2Fcommitlint-config-git-commit-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccnnde%2Fcommitlint-config-git-commit-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccnnde%2Fcommitlint-config-git-commit-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccnnde%2Fcommitlint-config-git-commit-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ccnnde","download_url":"https://codeload.github.com/ccnnde/commitlint-config-git-commit-emoji/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccnnde%2Fcommitlint-config-git-commit-emoji/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260619574,"owners_count":23037351,"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":["angular","commit","commitlint","commitlint-config","emoji","git"],"created_at":"2024-07-31T02:01:24.858Z","updated_at":"2025-06-20T06:08:08.577Z","avatar_url":"https://github.com/ccnnde.png","language":"JavaScript","readme":"# commitlint-config-git-commit-emoji\n\n[![npm latest][version-img]][pkg-url]\n[![download][download-img]][pkg-url]\n[![MIT][license-img]](LICENSE)\n\nShareable `commitlint` config for the VS Code extension [git-commit-plugin](https://github.com/RedJue/git-commit-plugin) with emoji enabled.\nUse with [commitlint](https://github.com/conventional-changelog/commitlint).\n\n## Getting started\n\n```sh\nnpm install --save-dev @commitlint/cli commitlint-config-git-commit-emoji\n\necho \"module.exports = {extends: ['git-commit-emoji']};\" \u003e .commitlintrc.js\n```\n\n## Format\n\n```text\n\u003cemoji\u003e \u003ctype\u003e(\u003cscope\u003e): \u003csubject\u003e\n\u003cBLANK LINE\u003e\n\u003cbody\u003e\n\u003cBLANK LINE\u003e\n\u003cfooter\u003e\n```\n\n### Example\n\n```text\n✨ feat(blog): add comment section\n```\n\n## Rules\n\n### Problems\n\nThe following rules are considered problems for `commitlint-config-git-commit-emoji` and will yield a non-zero exit code when not met.\nConsult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules.\n\n#### type-enum\n\n- **condition**: `type` is found in value\n- **rule**: `always`\n- **value**\n\n```text\n[\n  '🎉 init',\n  '✨ feat',\n  '🐞 fix',\n  '📃 docs',\n  '🌈 style',\n  '🦄 refactor',\n  '🎈 perf',\n  '🧪 test',\n  '🔧 build',\n  '🐎 ci',\n  '🐳 chore',\n  '↩ revert',\n]\n```\n\n```sh\necho \"foo: some message\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### type-case\n\n- **description**: `type` is in case `value`\n- **rule**: `always`\n- **value**\n\n```text\n'lowerCase'\n```\n\n```sh\necho \"FIX: some message\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### type-empty\n\n- **condition**: `type` is empty\n- **rule**: `never`\n\n```sh\necho \": some message\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### scope-case\n\n- **condition**: `scope` is in case `value`\n- **rule**: `always`\n\n```text\n'lowerCase'\n```\n\n```sh\necho \"🐞 fix(SCOPE): some message\" # fails\necho \"🐞 fix(scope): some message\" # passes\n```\n\n#### subject-case\n\n- **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`\n- **rule**: `never`\n\n```sh\necho \"🐞 fix(SCOPE): Some message\" # fails\necho \"🐞 fix(SCOPE): Some Message\" # fails\necho \"🐞 fix(SCOPE): SomeMessage\" # fails\necho \"🐞 fix(SCOPE): SOMEMESSAGE\" # fails\necho \"🐞 fix(scope): some message\" # passes\necho \"🐞 fix(scope): some Message\" # passes\n```\n\n#### subject-empty\n\n- **condition**: `subject` is empty\n- **rule**: `never`\n\n```sh\necho \"🐞 fix:\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### subject-full-stop\n\n- **condition**: `subject` ends with `value`\n- **rule**: `never`\n- **value**\n\n```text\n'.'\n```\n\n```sh\necho \"🐞 fix: some message.\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### subject-exclamation-mark\n\n- **condition**: `subject` must not have a `!` before the `:` marker\n- **rule**: `never`\n\nThe [angular commit\nconvention](hhttps://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)\ndose not use a `!` to define a breaking change in the commit subject. If you\nwant to use this feature please consider using the [conventional commit\nconfig](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#commitlintconfig-conventional).\n\n#### header-max-length\n\n- **condition**: `header` has `value` or less characters\n- **rule**: `always`\n- **value**\n\n```text\n72\n```\n\n```sh\necho \"🐞 fix: some message that is way too long and breaks the line max-length by several characters\" # fails\necho \"🐞 fix: some message\" # passes\n```\n\n#### body-leading-blank\n\n- **condition**: Body should have a leading blank line\n- **rule**: `always`\n\n```sh\necho \"🐞 fix: some message\nbody\" # fails\n\necho \"🐞 fix: some message\n\nbody\" # passes\n```\n\n#### footer-leading-blank\n\n- **condition**: Footer should have a leading blank line\n- **rule**: `always`\n\n```sh\necho \"🐞 fix: some message\nBREAKING CHANGE: It will be significant\" # fails\n\necho \"🐞 fix: some message\n\nBREAKING CHANGE: It will be significant\" # passes\n```\n\n## Thanks\n\n- Header regex pattern modified from [@gitmoji/parser-opts](https://github.com/arvinxx/gitmoji-commit-workflow/blob/master/packages/parser-opts/README.md)\n- Most of the rules come from [@commitlint/config-angular](https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/config-angular/README.md)\n\n## License\n\n[MIT](LICENSE) © Nor Cod\n\n\u003c!-- badge url --\u003e\n\n[pkg-url]: https://www.npmjs.com/package/commitlint-config-git-commit-emoji\n[version-img]: https://img.shields.io/npm/v/commitlint-config-git-commit-emoji?color=deepgreen\u0026style=flat-square\n[download-img]: https://img.shields.io/npm/dm/commitlint-config-git-commit-emoji?style=flat-square\n[license-img]: https://img.shields.io/badge/license-MIT-blue?style=flat-square\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccnnde%2Fcommitlint-config-git-commit-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccnnde%2Fcommitlint-config-git-commit-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccnnde%2Fcommitlint-config-git-commit-emoji/lists"}