https://github.com/andostronaut/cocli

A ligthweight git commit prompt system to ensure readable and descriptive commit for Deno 🦕🌱
https://github.com/andostronaut/cocli

bash cli command command-line commit deno descriptive git hacktoberfest lightweight prompt shell typescript zsh

Last synced: 6 days ago
JSON representation

A ligthweight git commit prompt system to ensure readable and descriptive commit for Deno 🦕🌱

• Host: GitHub
• URL: https://github.com/andostronaut/cocli
• Owner: andostronaut
• License: mit
• Created: 2023-10-07T19:15:08.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-08T09:19:03.000Z (5 months ago)
• Last Synced: 2024-10-06T05:01:23.455Z (about 1 month ago)
• Topics: bash, cli, command, command-line, commit, deno, descriptive, git, hacktoberfest, lightweight, prompt, shell, typescript, zsh
• Language: TypeScript
• Homepage: https://deno.land/x/cocli
• Size: 9.19 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



![build](https://github.com/andostronaut/cocli/workflows/build/badge.svg)

[![deno module](https://shield.deno.dev/x/cocli)](https://deno.land/x/cocli)

![deno compatibility](https://shield.deno.dev/deno/^1.42.4)

![license](https://img.shields.io/github/license/andostronaut/cocli?color=success)

![demo](./demo.gif)

A ligthweight git commit prompt system to ensure readable and descriptive commit for Deno 🦕🌱

## Installation

```shell

deno install -A -r -g https://deno.land/x/cocli/cli.ts -n cocli

```

## Directly Compiling Executable

```shell

wget -O - https://raw.githubusercontent.com/andostronaut/cocli/main/scripts/install.sh | bash

```

## Quick Start

```shell

deno run -A -r https://deno.land/x/cocli/cli.ts

```

## Commit Type

List of type available:

- Feat - For new features (e.g., feat: implement --cache-to feature to export cache)

- Fix - For improvements and bugfixes that do not introduce a feature (e.g., fix: improve error message)

- Hotfix - For improvements and bugfixes that do not introduce a feature, directly in production mode (e.g., fix: improve success message)

- Chore - General things that should be excluded (e.g., chore: clean up X)

- Design - For design changes only (e.g., design: use rounded button)

- Experiment - General things that should be in experiment (e.g., experiment: implement new query system in X)

- Docs - For documentation changes only (e.g., docs: fix typo in X)

- Refactor - General things that should be restructured but not changing the original functionality (e.g., refactor: move X to new file utils)

- CI - For internal CI specific changes (e.g., ci: enable X for tests)

- Infra - For infrastructure changes (e.g., infra: Enable cloudfront for X)

- Test - For changes to tests only (e.g., test: check if X does Y)

## LICENSE

[MIT](LICENSE)