https://github.com/ryooooooga/commitizen-deno
Commitizen client powered by Deno and FZF
https://github.com/ryooooooga/commitizen-deno
commitizen deno git
Last synced: 2 months ago
JSON representation
Commitizen client powered by Deno and FZF
- Host: GitHub
- URL: https://github.com/ryooooooga/commitizen-deno
- Owner: Ryooooooga
- License: mit
- Created: 2022-01-20T03:56:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T11:25:47.000Z (about 1 year ago)
- Last Synced: 2025-02-02T04:32:00.505Z (11 months ago)
- Topics: commitizen, deno, git
- Language: TypeScript
- Homepage:
- Size: 85.9 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# commitizen-deno
Commitizen client powered by Deno and FZF
## Requirements
- Deno
- FZF
## Installation
### Zinit
```zsh
# ~/.zshrc
zinit wait lucid light-mode as'program' for 'Ryooooooga/commitizen-deno'
```
use as git subcommand:
```sh
git config --global alias.cz '!commitizen-deno --'
```
## Configuration
```yaml
# ~/.config/commitizen-deno/config.yaml
message:
items:
- name: type
description: Select the type of change that you're committing
required: true
form: select
options:
- name: feat
description: A new feature
- name: fix
description: A bug fix
- name: docs
description: Documentation only changes
- name: style
description: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- name: refactor
description: A code change that neither fixes a bug nor adds a feature
- name: perf
description: A code change that improves performance
- name: test
description: Adding missing tests or correcting existing tests
- name: build
description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)"
- name: ci
description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)"
- name: chore
description: Other changes that don't modify src or test files
- name: revert
description: Reverts a previous commit
- name: scope
description: What is the scope of this change (e.g. component or file name)
form: input
- name: subject
description: Write a short, imperative tense description of the change
required: true
form: input
- name: detail
description: Provide a longer description of the change
form: input
- name: breakingChange
description: Describe the breaking changes if exist
prompt: "BREAKING CHANGE > "
form: input
- name: issue
description: 'Add issue references (e.g. "fix #123", "re #123".)'
form: input
template: "<%- type %><% if (scope) { %>(<%- scope %>)<% } %>: <%- subject %><% if (detail) { %>\n\n<%- detail %><% } %><% if (breakingChange) { %>\n\nBREAKING CHANGE: <%- breakingChange %><% } %><% if (issue) { %>\n\n<%- issue %><% } %>"
```
## Related
- [cz-cli](https://github.com/commitizen/cz-cli)
- [git-cz](https://github.com/streamich/git-cz)
- [commitizen-go](https://github.com/lintingzhen/commitizen-go)