bnash/examples/git-commit-len.js

A command-line editor for bash or compatible shells, aiming to provide great UX and productivity

/* This example plugin illustrates the line decorator API. When the
    line editor displays the line next to the prompt, it calls all registered
    line decorators to add any decorations to the line, such as syntax
    highlight or history suggestions.

    This line decorator checks for a line with a `git commit` command,
    and if the commit message length is longer than 50, it decorates the
    text beyond that length in inverse color, to warn the user that
    the message length is beyond the establised good practice.
*/

const { registerLineDecorator } = require(NASH_BASE + '/editor')
const { colorize } = require(NASH_BASE + '/colors')

const MAX_MSG_LEN = 50

function gitWarn(plainLine, decoratedLine) {
    // Search for 'git commit "commit message" ...'
    let patt = /^\s*git\s+commit[^"]+("[^"]+)"?/
    let m = plainLine.match(patt)
    if (!m) return decoratedLine
    // Match found, check if message is too long
    if (m[1].length <= MAX_MSG_LEN) return decoratedLine
    // Message is longer than limit
    return decoratedLine.replace(m[1], (m1) => {
        let oktxt = m1.substr(0, MAX_MSG_LEN)
        // Add some warning background on the overflow text
        let warntxt = colorize('inverse', m1.substr(MAX_MSG_LEN))
        return `${oktxt}${warntxt}`
    })
}

function start() {
    registerLineDecorator(gitWarn)
}


module.exports = { start }