{"id":21449640,"url":"https://github.com/dr3/fancy-commit","last_synced_at":"2025-03-17T02:20:25.536Z","repository":{"id":34670100,"uuid":"167843137","full_name":"dr3/fancy-commit","owner":"dr3","description":"✨Ohhh so fancy. ✨ Super simple cli for writing fancy commit messages","archived":false,"fork":false,"pushed_at":"2023-01-04T03:52:19.000Z","size":439,"stargazers_count":0,"open_issues_count":12,"forks_count":1,"subscribers_count":2,"default_branch":"v1-alpha","last_synced_at":"2025-02-23T17:15:40.331Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dr3.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":"2019-01-27T18:28:24.000Z","updated_at":"2020-10-01T09:47:15.000Z","dependencies_parsed_at":"2023-01-15T08:30:21.314Z","dependency_job_id":null,"html_url":"https://github.com/dr3/fancy-commit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dr3%2Ffancy-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dr3%2Ffancy-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dr3%2Ffancy-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dr3%2Ffancy-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dr3","download_url":"https://codeload.github.com/dr3/fancy-commit/tar.gz/refs/heads/v1-alpha","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960607,"owners_count":20375106,"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-11-23T03:25:02.511Z","updated_at":"2025-03-17T02:20:25.515Z","avatar_url":"https://github.com/dr3.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e✨ fancy-commit ✨\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n\nOhhh so fancy. Super simple cli for writing fancy commit messages\n\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dr3/fancy-commit)\n\n\u003c/div\u003e\n\n![example gif](https://user-images.githubusercontent.com/11341355/51806401-6c971400-2271-11e9-8185-1c3bde5d334d.gif)\n\n![image](https://user-images.githubusercontent.com/11341355/51806434-c13a8f00-2271-11e9-8c89-38f78c2b154c.png)\n\n## 🚀 Install\n```\nnpm install -g fancy-commit\n```\n\n## 🦁 Alias\nI chose the name `fancy-commit` as it was nice and wouldn't clash with any other cli tool. I recomend aliasing it to something else in your command line. For bash I add the following line to my `.bashrc` file 😊\n```\nalias gc='fancy-commit'\n```\n\n## 🤟 Usage\n\nThe basic functionality of this package can be run simply via `fancy-commit`. On its own, this command will use default values for all settings. This can be overwritten via config however!\n\n## 🎩 Commands\n\n### - `fancy-commit setup`\n\nThis command will write a config file for you to change. It will be located in your home directory and called `.fancy_commit`.\n\n### - `fancy-commit reset`\n\nMess up your config file? This command will reset it to the defaults.\n\n### - `fancy-commit clean`\n\nDon't need custom config? Run this command to delete your `.fancy_commit` file.\n\n\n## ⚙️ Config\n\nfancy-commit is built on config and offers a whole bunch of settings you can change to your liking.\n\n| config key | description | default | possible values |\n|------------|-------------|---------|-----------------|\n| `prompts`  | An array of commit prompts for you to use. | see [here](https://github.com/dr3/fancy-commit/blob/latest/src/config/defaultUserConfig.js#L3) | Array items be in the format of `{ text: 'Feature', emoji: '🚀' }` |\n| `skipVerifyingCommit` | Skip verifying your commit. Adds `--no-verify` to the commit to skip and pre-commit checks. | `ask_n` | `always`, `never`, `ask_y`, `ask_n` ([prompt config](https://github.com/dr3/fancy-commit#-prompt-config)) |\n| `allowEmptyCommit`| Allow commits to be empty. | `ask_n` | `always`, `never`, `ask_y`, `ask_n` ([prompt config](https://github.com/dr3/fancy-commit#-prompt-config)) |\n| `signCommits`| Sign your git commits. Most commonly used to GPG sign your commits. | `ask_n` | `always`, `never`, `ask_y`, `ask_n` ([prompt config](https://github.com/dr3/fancy-commit#-prompt-config)) |\n| `warnNoChanges` | Warn you if your trying to make a commit with no changes. | `true` | `true`, `false` |\n| `mustBeInsideWorkingTree` | Exit `fancy-commit` if youre not inside a git working tree. | `true` | `true`, `false` |\n| `useGithubEmoji` | Use github emoji markup in commit messages in place of Unicode emoji chracters. e.g. `:dog:` instead of 🐶. | `true` | `true`, `false` |\n\n### ⁉️ Prompt config\n\nPrompt config has 4 possible values \n\n- `always` - Don't Ask, just always do it.\n- `never` - Don't Ask, but never do it.\n- `ask_y` - Ask every time, defaulting to `'y'` (yes).\n- `ask_n` - Ask every time, defaulting to `'n'` (no).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdr3%2Ffancy-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdr3%2Ffancy-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdr3%2Ffancy-commit/lists"}