{"id":14070364,"url":"https://github.com/martinmcwhorter/commitiquette","last_synced_at":"2025-07-30T07:33:03.342Z","repository":{"id":40289872,"uuid":"237950179","full_name":"martinmcwhorter/commitiquette","owner":"martinmcwhorter","description":"Plugin for Commitizen that uses commitLint configuration","archived":false,"fork":false,"pushed_at":"2023-08-18T20:58:59.000Z","size":1534,"stargazers_count":29,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-03T03:38:28.839Z","etag":null,"topics":["commitizen","commitizen-adapter","commitlint","commitlintplugin","conventional-commits"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/martinmcwhorter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-02-03T11:31:22.000Z","updated_at":"2024-03-28T07:39:03.000Z","dependencies_parsed_at":"2024-08-13T07:17:08.071Z","dependency_job_id":"f992ff0f-8338-4c88-9246-2db5f2c4f262","html_url":"https://github.com/martinmcwhorter/commitiquette","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinmcwhorter%2Fcommitiquette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinmcwhorter%2Fcommitiquette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinmcwhorter%2Fcommitiquette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinmcwhorter%2Fcommitiquette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martinmcwhorter","download_url":"https://codeload.github.com/martinmcwhorter/commitiquette/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228110178,"owners_count":17871143,"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","commitizen-adapter","commitlint","commitlintplugin","conventional-commits"],"created_at":"2024-08-13T07:07:41.914Z","updated_at":"2024-12-04T12:30:42.474Z","avatar_url":"https://github.com/martinmcwhorter.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Commitiquette\n\nPlugin for Commitizen that uses commitLint configuration. Allows you to use both Commitizen and commitLint with a single configuration.\n\n![Node.js CI](https://github.com/martinmcwhorter/commitiquette/workflows/Node.js%20CI/badge.svg)\n[![codecov](https://codecov.io/gh/martinmcwhorter/commitiquette/branch/master/graph/badge.svg)](https://codecov.io/gh/martinmcwhorter/commitiquette)\n[![npm version](https://badge.fury.io/js/commitiquette.svg)](https://badge.fury.io/js/commitiquette)\n\n## Installation\n\nYou will first need to follow the commitizen and commitlint instalation instructions if you do not already have these installed.\n\n- [commitizen](http://commitizen.github.io/cz-cli/)\n- [commitlint](https://commitlint.js.org/#/guides-local-setup)\n\nUse npm or yarn to install commitiquette into your project.\n\n```bash\nnpm install commitiquette --save-dev\n```\n\n## Usage\n\nUpdate `package.json` Commitizen configuration.\n\n```json\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"commitiquette\"\n    }\n  },\n```\n\n## Purpose\n\nThe purpose of this project is to have a single configuration for both `commitlint` and `commitizen` -- while prompting the user for each answer.\n\n## Similar Projects\n\nBoth of these wonderful projects are use the `commitlint` config as well.\n\n- [@commitlint/prompt](https://www.npmjs.com/package/@commitlint/prompt)\n- [@commitlint/prompt-cli](https://www.npmjs.com/package/@commitlint/prompt-cli)\n\nCommitiquette differs by using simple prompts, list selects whenever possible, for answers -- much like the `cz-conventional-changelog` commitizen plugin.\n\n## Fully Configurable\n\nCommitiquitte is fully configurable using the `commitlint` configuration.\n\nExamples\n\n### Disable Prompting for scope\n\n```javascript\nmodule.exports = {\n  extends: ['@commitlint/config-conventional'],\n  rules: {\n    'scope-empty': [2, 'always']\n  }\n};\n```\n\n### List select for scope\n\n```javascript\nmodule.exports = {\n  extends: ['@commitlint/config-conventional'],\n  rules: {\n    'scope-enum': [2, 'always', ['docs', 'core', 'lib', 'misc', 'etc']]\n  }\n};\n```\n\n## Filtering and Validation\n\nCommitiquette will validate against all but the deprecated `commitlint` rules.\n\n\u003e **NOTE:** This is not a replacement for `commitlint`. Commitlint should still validate the message before each commit.\n\nWhere possible, commitlint rules will be used to filter messages.\n\nValidation is run at Level Error (2) -- where filtering will apply at if the rule is set to Warn (1) or Error (2.)\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinmcwhorter%2Fcommitiquette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartinmcwhorter%2Fcommitiquette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinmcwhorter%2Fcommitiquette/lists"}