chrisgrieser/nvim-genghis

github github
file-explorerutility
star 56
alert-circle 1
users 2
git-branch 2
CREATED

2022-11-21

UPDATED

25 days ago


nvim-genghis

Convenience file operations for neovim, written in lua.

How is this different from vim.eunuch?

  • Various improvements like automatically keeping the extensions when no extension is given, or moving files to the trash instead of removing them.
  • Uses only vim-commands or lua os-modules, so it has no dependencies and works cross-platform.
  • Makes use of up-to-date nvim features like vim.ui.input or vim.notify. This means you can get nicer input fields with normal mode support via plugins like dressing.nvim, and confirmation notices with plugins like nvim-notify, if they are installed and setup.
  • If used with dressing and cmp, you can also get autocompletion of directories.
  • Written 100% in lua.

Installation and Setup

-- Recommended (Packer)
use {"chrisgrieser/nvim-genghis", requires = "stevearc/dressing.nvim"}

-- if you do not care about nice input fields
use "chrisgrieser/nvim-genghis"

nvim-genghis (and dressign.nvim) require no .setup() function. Just create keybindings for the commands you want to use:

local keymap = vim.keymap.set
local genghis = require("genghis")
keymap("n", "<leader>yp", genghis.copyFilepath)
keymap("n", "<leader>yn", genghis.copyFilename)
keymap("n", "<leader>cx", genghis.chmodx)
keymap("n", "<leader>rf", genghis.renameFile)
keymap("n", "<leader>mf", genghis.moveAndRenameFile)
keymap("n", "<leader>nf", genghis.createNewFile)
keymap("n", "<leader>yf", genghis.duplicateFile)
keymap("n", "<leader>df", function () genghis.trashFile{trashLocation = "your/path"} end) -- default: "$HOME/.Trash".
keymap("x", "<leader>x", genghis.moveSelectionToNewFile)

Available commands

  • .createNewFile: Create a new file.
  • .duplicateFile: Duplicate the current file.
  • .moveSelectionToNewFile: Prompts for a new file name and moves the current selection to that new file. (Note that this is a Visual Line Mode command; the selection is moved linewise.)
  • .renameFile: Rename the current file.
  • .moveAndRenameFile: Move and Rename the current file. Works like the UNIX mv command. Best used with autocompletion of directories.

Note
Applying to all commands above:

  • If no extension has been provided, will use the extension of the original file.
  • If the new file name includes a /, the new file is placed in the respective subdirectory, creating any non-existing folders. Except for .moveAndRenameFile, all operations take only place in the current working directory, so .moveAndRenameFile is the only command that can move to a parent directory.
  • All commands support autocompletion of existing directories.
  • .trashFile{trashLocation = "your/path/"}: Move the current file the trash location. Defaults to location is $HOME/.Trash/. ⚠️ Any existing file in the trash location with the same name is overwritten, making that file irretrievable.
  • .copyFilename: Copy the file name. When clipboard="unnamed[plus]" has been set, copies to the + register, otherwise to ".
  • .copyFilepath: Copy the absolute file path. When clipboard="unnamed[plus]" has been set, copies to the + register, otherwise to ".
  • .chmodx: Makes current file executable. Equivalent to chmod +x.

Autocompletion of directories

You can get autocompletion for directories by using dressing.nvim, nvim-cmp, and vim's omnifunc:

    -- packer
    use { "chrisgrieser/nvim-genghis", requires = {
            "stevearc/dressing.nvim",
            "hrsh7th/nvim-cmp",
            "hrsh7th/cmp-omni",
        },
    }
-- required setup for cmp, somewhere after your main cmp-config
require("cmp").setup.filetype("DressingInput", {
    sources = cmp.config.sources { {name = "omni"} },
})

Why that name

A nod to vim.eunuch - as opposed to childless eunuchs, it is said that Genghis Khan has fathered thousands of children.

About me

In my day job, I am a sociologist studying the social mechanisms underlying the digital economy. For my PhD project, I investigate the governance of the app economy and how software ecosystems manage the tension between innovation and compatibility. If you are interested in this subject, feel free to get in touch.

Profiles