ncks.nvim

Adding random Discord nicknames to an endlessly expanding and rarely used text file... WITHOUT LEAVING NEOVIM!

This is my first Neovim plugin, and it's just a tiny little time saver utility I've been wanting for personal use, and I thought it'd be a simple starting point for learning plugin dev.

Install

Requirements

• Neovim 0.7 or later
• telescope.nvim (optional, for the Telescope integration)

lazy.nvim:

{
    "956MB/ncks.nvim",
    config = function()
        require('ncks').setup {} -- required

        vim.keymap.set('n', '<leader>nn', '<cmd>NcksNew<cr>', { desc = 'Add [N]ew [N]ickname' })
        vim.keymap.set('n', '<leader>ni', '<cmd>NcksInfo<cr>', { desc = 'Show [N]icks file [I]nfo' })
        vim.keymap.set('n', '<leader>no', '<cmd>NcksOpen<cr>', { desc = '[O]pen [N]cks file' })
        vim.keymap.set('n', '<leader>nl', '<cmd>NcksList<cr>', { desc = '[L]ist [N]cks files' })
        vim.keymap.set('n', '<leader>nc', '<cmd>NcksCopyAll<cr>', { desc = '[C]opy all [N]icknames from file to clipboard' })
        vim.keymap.set('n', '<leader>nr', '<cmd>NcksRandom<cr>', { desc = 'Pick [R]andom [N]ick from file' })
    end
}

Commands

• :NcksInfo
  • Displays various information on ncks file, like file location and entry count.
• :NcksOpen
  • Opens ncks file in new buffer.
• :NcksCopyAll
  • Copies all entries from ncks file to clipboard.
• :NcksRandom
  • Picks random entry from ncks file, copies it to clipboard.
• :NcksList
  • Returns all lines of ncks file in list.
• :NcksNew {optional_pass}
  • Adds new name entry to your ncks file, by default opens dialog.
  • {optional_pass} pass new entry to file inline, instead of opening the dialog.

Configuration

Defaults

┌─ New (~/.ncks) ───────────────────────┐
│ ...                                 * │ -- Without preview (Default)
└───────────────────────────────────────┘

-- ...

{
    -- Default file ~/.ncks, but can use literally anything
    location = '~/.ncks',
    -- Layout config stuff if you want Telescope
    layout_config = {
        prompt_position = 'top',
        width = 0.50,
        height = 0.20,
    },
    prompt_title = 'New',
}

Telescope

┌───────────────── New ─────────────────┐
│ ...                           12 / 12 │
├─────────────── ~/.ncks ───────────────┤
│ BATT_MODEL_RAW                        │
│ conductor galloping spans             │
│ L812 Electric Two-Sided Grill         │ -- With preview (Telescope)
│ lackof(grid)                          │
│ ...                                   │
└───────────────────────────────────────┘

-- ...

{   -- Using telescope.nvim

    local ncks = require 'ncks'
    ncks.setup {} -- required

    local function toggle_telescope(contents)
        local function handle_input(prompt_bufnr)
            local entry = require('telescope.actions.state').get_current_line()
            if entry and entry ~= '' then
                require('telescope.actions').close(prompt_bufnr)
                ncks.write(entry)
            end
        end

        require('telescope.pickers')
            .new({
                prompt_title = ncks.config.prompt_title,
                results_title = ncks.config.location,
                finder = require('telescope.finders').new_table {
                    results = contents,
                    entry_maker = function(entry)
                        return { value = entry, display = entry, ordinal = entry, }
                    end,
                },
                layout_config = ncks.config.layout_config,
                sorting_strategy = 'ascending',
                attach_mappings = function(prompt_bufnr, map)
                    map('i', '<CR>', function() handle_input(prompt_bufnr) end)
                    map('n', '<CR>', function() end)
                    return true
                end,
            }, {})
            :find()
    end

    -- ... keymaps

    vim.keymap.set('n', '<leader>nn', function()
        ncks.exists(function(_)
            toggle_telescope(ncks.list())
        end)
    end, { desc = 'Open ncks window' })
}

Aknowledgements

Both ThePrimeagen/harpoon and tamton-aquib/stuff.nvim served as inspiration and helped me build up the structure of this tiny plugin. (The Telescope thing is straight out of harpoon TBH)

TODO

• If file doesn't exist when trying to open or add, ask to create it
• Still confused on how to fine tune all of Telescope settings
  • Line count in the prompt shouldn't be "9 / 9"
  • Figure out how to use Telescope ui without the results window, just the prompt
• Multiple lists?
• More commands:
  • Create, Delete, Move/Rename, etc.
• Tests?

License

MIT license