https://github.com/ph1p/coraline

A small git cli
https://github.com/ph1p/coraline

cli commit commit-conventions coraline git

Last synced: about 2 months ago
JSON representation

A small git cli

• Host: GitHub
• URL: https://github.com/ph1p/coraline
• Owner: ph1p
• License: mit
• Created: 2017-12-24T12:24:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-02T15:42:02.000Z (over 6 years ago)
• Last Synced: 2025-03-30T06:34:16.749Z (about 2 months ago)
• Topics: cli, commit, commit-conventions, coraline, git
• Language: JavaScript
• Size: 173 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## coraline

[![npm](https://img.shields.io/npm/v/coraline.svg)](https://www.npmjs.com/package/coraline)

This small cli makes it easier to handle conventional git commit messages.

Currently there are two preinstalled commit conventions:

- karma

- atom

- angular

## Install

`npm i coraline -g`

## How to use?

Just type `cl` or `coraline` in your terminal and follow the first configuration.

For help, just type `cli --help`

```bash

Usage

    $ cl --reset

    $ cl --default

    $ cl --readme

    $ cl --list

    $ cl --use

Options

    --help

    --reset, -r  Reset configuration

    --default, -d  Use your default style (Only relevant if you use a .coraline file)

    --readme {name}, -m {name}  Shows the readme of current or inputed commit style

    --list, -l List  all available styles

    --version, -v  Version info

    --use, -u  Use a specific style temporarily (e. g. cl -u karma

```

## .coraline.js

Define a custom commit style for every repository with a simple

dotfile called `.coraline.js` or  `.coraline`

**questions** and **template** properties are not optional.

The **questions** array includes one or many easy configurable inquirer objects. (https://www.npmjs.com/package/inquirer)

With **template** you define the commit message format.

For example: `` will be replaced with the value of `name: 'title'`.

The **readme** object contains a small explanation of how your defined convention works.

```javascript

module.exports = {

    custom: {

        questions: [{

            type: 'input',

            name: 'title',

            message: 'Title',

            validate(title) {

                return title.length > 0;

            }

        }, {

            type: 'editor', // opens your favorite cli editor

            name: 'message',

            message: 'Message'

        }],

        template: `: `,

        readme: ``

    },

    custom2: {

        questions: [{

            type: 'input',

            name: 'title',

            message: 'Title'

        }],

        template: ``,

        readme: ``

    }

}

```