Have ideas to improve npm?Join in the discussion! »

    coraline

    2.0.3 • Public • Published

    coraline

    npm

    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

    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: <title> will be replaced with the value of name: 'title'.

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

    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: `<title>: <message>`,
            readme: ``
        },
        custom2: {
            questions: [{
                type: 'input',
                name: 'title',
                message: 'Title'
            }],
            template: `<title>`,
            readme: ``
        }
    }

    Install

    npm i coraline

    DownloadsWeekly Downloads

    2

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    27 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar