{"id":13630406,"url":"https://github.com/danieldelcore/commitpal","last_synced_at":"2025-03-21T13:31:25.007Z","repository":{"id":42118238,"uuid":"231338234","full_name":"danieldelcore/commitpal","owner":"danieldelcore","description":"A delightful CLI tool for building complex commit messages","archived":false,"fork":false,"pushed_at":"2023-01-27T02:02:19.000Z","size":2839,"stargazers_count":29,"open_issues_count":16,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T01:43:12.001Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danieldelcore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-02T08:22:46.000Z","updated_at":"2023-04-20T10:29:45.000Z","dependencies_parsed_at":"2023-02-15T04:16:23.494Z","dependency_job_id":null,"html_url":"https://github.com/danieldelcore/commitpal","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danieldelcore%2Fcommitpal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danieldelcore%2Fcommitpal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danieldelcore%2Fcommitpal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danieldelcore%2Fcommitpal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danieldelcore","download_url":"https://codeload.github.com/danieldelcore/commitpal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244806091,"owners_count":20513378,"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":[],"created_at":"2024-08-01T22:01:41.457Z","updated_at":"2025-03-21T13:31:24.703Z","avatar_url":"https://github.com/danieldelcore.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"580\" src=\"assets/logo.png\" alt=\"Script Palette\"\u003e\n\u003c/p\u003e\n\n# CommitPal\n\nA delightful CLI tool for building commit messages which conform to your project's specific commit message format.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"580\" src=\"assets/demo.gif\" alt=\"Demo\"\u003e\n\u003c/p\u003e\n\n## Install ⬇️\n\nInstall globally\n\n```bash\nnpm install -g commitpal\n```\n\n## Get started 🏁\n\n```bash\ncommitpal\n```\n\nUsage with npx\n\n```bash\nnpx commitpal\n```\n\n## API 🤖\n\n- `--config`, `-c` Custom configuration file\n- `--preset`, `-p` Select an inbuilt preset. Options: 'angular', 'emoji', 'jira'\n- `--nowelcome`, `-n` Omit welcome message\n- `--help` `Help`me\n- `--version`, `-v` Version number\n\n## Examples\n\n- `$ commitpal --config ../commitpal.config.json`\n- `$ commitpal --nowelcome`\n- `$ commitpal --preset emoji`\n- `$ npx commitpal`\n\n## Presets\n\nCommitPal is loaded with the following collection of preset configurations:\n\n- **Emoji**: The Emoji commit format loosely [based on this Gist](https://gist.github.com/parmentf/035de27d6ed1dce0b36a)\n- **Angular**: [The Angular commit message conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)\n- **Jira**: An unofficial format that simply accepts a Jira ticket id and a message\n\nDon't like these presets, or want to provide your own? Raise a Pull Request 🙏\n\n## Configuration\n\nIf you're not using one of the predefined commit message formats, CommitPal will attempt to search for a `commitpal.config.json`.\n\nWhich can be configured like so:\n\n```json\n{\n  \"name\": \"Angular commit message format\",\n  \"steps\": [\n    {\n      \"type\": \"option\",\n      \"message\": \"What type of change?\",\n      \"options\": [\n        { \"value\": \"feat\", \"description\": \"feature\" },\n        { \"value\": \"fix\", \"description\": \"bug fix\" },\n        { \"value\": \"docs\", \"description\": \"documentation\" },\n        {\n          \"value\": \"style\",\n          \"description\": \"formatting, missing semi colons, …\"\n        },\n        { \"value\": \"test\", \"description\": \"tests\" },\n        { \"value\": \"chore\", \"description\": \"adhoc maintenance\" }\n      ]\n    },\n    {\n      \"type\": \"option\",\n      \"message\": \"What scope of the project is affected?\",\n      \"before\": \"(\",\n      \"after\": \"):\",\n      \"options\": [\n        { \"value\": \"authentication\", \"description\": \"Authentication modules\" },\n        { \"value\": \"users\", \"description\": \"User profiles\" },\n        { \"value\": \"settings\", \"description\": \"Settings\" },\n        { \"value\": \"payments\", \"description\": \"Payments modules\" },\n        { \"value\": \"shipping\", \"description\": \"Shipping modules\" },\n        { \"value\": \"build system\", \"description\": \"Build system\" },\n        { \"value\": \"CI\", \"description\": \"Continuous integration\" }\n      ]\n    },\n    {\n      \"type\": \"text\",\n      \"message\": \"Summarise this change...\"\n    },\n    {\n      \"type\": \"text\",\n      \"before\": \"\\n\\n\",\n      \"message\": \"Describe this change...\"\n    },\n    {\n      \"type\": \"text\",\n      \"before\": \"\\n\\n\",\n      \"message\": \"Describe any breaking changes...\"\n    }\n  ]\n}\n```\n\n## You might also like...\n\n- [ScriptPal](https://github.com/zeropoly/scriptpal): A simple npm script palette for lazy people\n- [Enquirer](https://github.com/enquirer/enquirer): Stylish, intuitive and user-friendly prompts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanieldelcore%2Fcommitpal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanieldelcore%2Fcommitpal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanieldelcore%2Fcommitpal/lists"}