divider.lua - Print a divider before and after certain commands (configurable)

[chrisant996]

This script puts a divider line before and after certain commands that you run.

The list of commands is configurable, and the colors are configurable.

(The custom prompt in the screen shot is clink-flex-prompt with Transient Prompt enabled and Spacing set to "sparse".)

divider.lua -- last updated 2022/03/15

--------------------------------------------------------------------------------
-- Insert divider before a command.

settings.add("color.divider_line", "sgr 30;48;5;25", "Color for command divider line")
settings.add("color.divider_line_end", "sgr 38;5;25", "Color for command end divider line", "When the color is blank, the end line is omitted.")
settings.add("divider_line.commands", "make nmake msbuild", "Show divider line before some commands")

-- You can get fancy and do additional configuration via a Lua script.
-- E.g. override the top and bottom line characters, and some other things.
--
-- For example:
--
--      divider_line = divider_line or {}
--      divider_line.left_justify_top = true
--      divider_line.top_line_color = "38;5;25"
--      divider_line.top_line_hilite_color = "38;5;159"
--      divider_line.top_line_lolite_color = "38;5;39"
--      divider_line.top_line_char = "▁"
--      divider_line.bottom_line_char = "▔"
--
-- Produces:
--
--      █COMMAND in DIR at TIME█▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁
--      ...output...
--      ...output...
--      ...output...
--      ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔█took ELAPSED█
--
divider_line = divider_line or {}

local function is_divider_command(line)
    if line then
        local s = string.explode(line)[1]
        local l = clink.lower(s)
        local commands = string.explode(clink.lower(settings.get("divider_line.commands")))
        for _,c in pairs(commands) do
            if c == l then
                return s
            end
        end
    end
end

local div_prompt = clink.promptfilter(999)
local div_begin

local function make_divider_begin(line, transient)
    local command = is_divider_command(line)
    if command then
        local line_color = "\x1b[0;" .. settings.get("color.divider_line") .. "m"
        local text_color = settings.get("color.divider_line_text")
        if not text_color or text_color == "" then
            text_color = line_color
        else
            text_color = "\x1b[0;" .. text_color .. "m"
        end

        local div = ""
        local hilite = "\x1b[" .. (divider_line.top_line_hilite_color or "1;97") .. "m"
        local lolite = "\x1b[" .. (divider_line.top_line_lolite_color or "38;5;252") .. "m"
        local top_char = divider_line.top_line_char or "-"
        local nbsp = " "
        local leading_space = divider_line.left_justify_top and nbsp or " "
        div = string.format("%s%s%s in %s%s%s at %s%s",
                            hilite, clink.upper(command), text_color,
                            lolite, os.getcwd(), text_color,
                            os.date(), text_color)
        local cellcount = console.cellcount(div)
        if divider_line.left_justify_top then
            cellcount = cellcount + 2   -- spc + text + spc
            if cellcount >= console.getwidth() then
                div = text_color .. nbsp .. div .. nbsp
            else
                div = text_color .. nbsp .. div .. " " .. line_color
            end
        else
            local bar = string.rep(top_char, 4)
            cellcount = cellcount + 10  -- bar + spc + text + spc + bar
            div = line_color .. bar .. text_color .. " " .. div .. " " .. line_color .. bar
        end
        div = div .. string.rep(top_char, console.getwidth() - 1 - console.cellcount(div)) .. "\x1b[m\n"
        if transient and flexprompt and flexprompt.get_spacing and flexprompt.get_spacing() == "sparse" then
            div = "\n" .. div
        end
        return div
    end
end

local function maybe_print_divider_end()
    if not div_begin then
        return
    end

    local line_color = settings.get("color.divider_line_end")
    if not line_color or line_color == "" then
        return
    end
    line_color = "\x1b[0;" .. line_color .. "m"

    local duration = os.clock() - div_begin
    div_begin = nil

    local h, m, s
    local t = math.floor(duration * 10) % 10
    duration = math.floor(duration)
    s = (duration % 60)
    duration = math.floor(duration / 60)
    if duration > 0 then
        m = (duration % 60)
        duration = math.floor(duration / 60)
        if duration > 0 then
            h = duration
        end
    end

    local text
    text = s .. "." .. t .. "s"
    if m then
        text = m .. "m " .. text
        if h then
            text = h .. "h " .. text
        end
    end

    text = " took " .. text
    if divider_line.bottom_line_reverse_video then
        text = "\x1b[7m" .. text .. " "
    end

    local bottom_char = divider_line.bottom_line_char or "-"
    text = line_color .. string.rep(bottom_char, console.getwidth() - 1 - console.cellcount(text)) .. text .. "\x1b[m"
    clink.print(text)
end

local inited_beginedit
local div_can_divide

function div_prompt:filter(prompt)
    if not inited_beginedit then
        -- Defer adding the event handler for printing the divider end line to
        -- make sure it's printed AFTER flexprompt applies its 'spacing' mode.
        clink.onbeginedit(function ()
            maybe_print_divider_end()
            div_can_divide = true
        end)
        inited_beginedit= true
    end

    maybe_print_divider_end()
end

function div_prompt:transientfilter(prompt)
    local line = rl_state and rl_state.line_buffer
    local div = make_divider_begin(line, true)
    if div then
        div_can_divide = false
        return div .. prompt
    end
end

clink.onendedit(function (line)
    if is_divider_command(line) then
        div_begin = os.clock()
        if div_can_divide then
            local div = make_divider_begin(line)
            if div then
                clink.print(div, NONL)
            end
        end
    else
        div_begin = nil
    end
end)

[chrisant996]

Changes 2022/03/15:

• Added various Lua-based configuration (top and bottom line characters, hilite and lolite colors, left justified top message, etc).
• Fixed divider line when prompt.transient is disabled.
• Fixed compatibility with flexprompt sparse spacing.

[chrisant996]

The divider.lua script is now part of clink-gizmos.