{"id":26874007,"url":"https://github.com/createwheel/mini-cz","last_synced_at":"2025-10-20T07:58:06.202Z","repository":{"id":64947676,"uuid":"579584997","full_name":"CreateWheel/mini-cz","owner":"CreateWheel","description":"The minimal commitizen cli.","archived":false,"fork":false,"pushed_at":"2024-07-13T09:35:47.000Z","size":544,"stargazers_count":12,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-09T10:53:28.212Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/CreateWheel.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,"zenodo":null}},"created_at":"2022-12-18T07:14:14.000Z","updated_at":"2025-03-04T09:39:55.000Z","dependencies_parsed_at":"2024-02-25T10:32:25.596Z","dependency_job_id":"2e625004-9be4-4668-bc3f-8188ae8725c0","html_url":"https://github.com/CreateWheel/mini-cz","commit_stats":{"total_commits":47,"total_committers":1,"mean_commits":47.0,"dds":0.0,"last_synced_commit":"7139858585c3bab66de97985be9ee40e443a4c64"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/CreateWheel/mini-cz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateWheel%2Fmini-cz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateWheel%2Fmini-cz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateWheel%2Fmini-cz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateWheel%2Fmini-cz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CreateWheel","download_url":"https://codeload.github.com/CreateWheel/mini-cz/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateWheel%2Fmini-cz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271568258,"owners_count":24782369,"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-08-21T02:00:08.990Z","response_time":74,"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":[],"created_at":"2025-03-31T09:32:37.736Z","updated_at":"2025-10-20T07:58:01.168Z","avatar_url":"https://github.com/CreateWheel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mini-cz\n\n[![NPM version](https://img.shields.io/npm/v/mini-cz?color=a1b858\u0026label=)](https://www.npmjs.com/package/mini-cz)\n\n## 🤘 Description\n\nMini-cz is a tiny commitizen alternative.\n\n## 💎 Features\n\n- Commitizen alternative, but much smaller\n- Supports commit types\n- Supports commit scopes\n- Extensible configuration\n\n## 📦 Installation\n\n```bash\n$ npm install mini-cz -D\n$ yarn add mini-cz -D\n$ pnpm install mini-cz -D\n\n# install default config; or you can use your own config\n$ npm install @mini-cz/config-default -D\n$ yarn add @mini-cz/config-default -D\n$ pnpm install @mini-cz/config-default -D\n```\n\n## 🚀 Usage\n\nFirst create a `mini-cz.config.ts` in your workspace root.\n\n```ts\n// mini-cz.config.ts\nexport { default } from \"@mini-cz/config-default\";\n```\n\nThen add a script to your `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"commit\": \"mini-cz\"\n  }\n}\n```\n\nFinally, run `npm run commit`, `yarn commit` or `pnpm commit` to start the commit process.\n\n## 📖 Documentation\n\n### Configuration\n\nYou can configure `mini-cz` by creating a `mini-cz.config.ts` file in your workspace root.\n\n```ts\n// mini-cz.config.ts\nimport { defineConfig } from \"mini-cz\";\n\nexport default defineConfig({\n  // This is @mini-cz/config-default\n  kinds: [\n    {\n      name: \"feat\",\n      description: \"A new feature\",\n      emoji: \"✨\",\n    },\n    {\n      name: \"fix\",\n      description: \"A bug fix\",\n      emoji: \"🐛\",\n    },\n    {\n      name: \"docs\",\n      description: \"Documentation only changes\",\n      emoji: \"📚\",\n    },\n    {\n      name: \"style\",\n      description:\n        \"Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\",\n      emoji: \"💎\",\n    },\n    {\n      name: \"refactor\",\n      description: \"A code change that neither fixes a bug nor adds a feature\",\n      emoji: \"📦\",\n    },\n    {\n      name: \"perf\",\n      description: \"A code change that improves performance\",\n      emoji: \"🚀\",\n    },\n    {\n      name: \"test\",\n      description: \"Adding missing tests or correcting existing tests\",\n      emoji: \"🚨\",\n    },\n    {\n      name: \"chore\",\n      description:\n        \"Changes that do not modify src or test files. Such as updating build tasks, package manager configs, etc.\",\n      emoji: \"🤖\",\n    },\n  ],\n  // And you can add some scope\n  scopes: [\"core\", \"config-default\"],\n});\n```\n\n## 📝 License\n\n[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreatewheel%2Fmini-cz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreatewheel%2Fmini-cz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreatewheel%2Fmini-cz/lists"}