bryan
/
nvim-genghis
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added info on new functionality to README

remotes/origin/HEAD
pseudometa 2022-12-18 23:40:42 +01:00
parent 468a2a65f1
commit 1a4a3602a8
2 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,11 +1,11 @@
# nvim-genghis # nvim-genghis
Convenience file operations for neovim, written in lua. Convenience file operations for neovim,
<!--toc:start--> <!--toc:start-->
- [How is this different from `vim.eunuch`?](#how-is-this-different-from-vimeunuch) - [How is this different from `vim.eunuch`?](#how-is-this-different-from-vimeunuch)
- [Installation and Setup](#installation-and-setup) - [Installation and Setup](#installation-and-setup)
- [Available commands](#available-commands) - [Available commands](#available-commands)
- [Autocompletion of filenames](#autocompletion-of-filenames) - [Autocompletion of filenames](#autocompletion-of-directories)
- [Why that name](#why-that-name) - [Why that name](#why-that-name)
- [About me](#about-me) - [About me](#about-me)
<!--toc:end--> <!--toc:end-->
@ -13,8 +13,8 @@ Convenience file operations for neovim, written in lua.
## How is this different from `vim.eunuch`? ## 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. - 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. - 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 via plugins like [dressing.nvim](https://github.com/stevearc/dressing.nvim), and nicer confirmation notices with plugins like [nvim-notify](https://github.com/rcarriga/nvim-notify), if they are installed and setup. - 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](https://github.com/stevearc/dressing.nvim), and confirmation notices with plugins like [nvim-notify](https://github.com/rcarriga/nvim-notify), if they are installed and setup.
- If used with dressing and cmp, [you can also get autocompletion of filenames](#autocompletion-of-filenames). - If used with dressing and cmp, [you can also get autocompletion of directories](#autocompletion-of-directories).
- Written 100% in lua. - Written 100% in lua.
## Installation and Setup ## Installation and Setup
@ -43,17 +43,24 @@ keymap("x", "<leader>x", genghis.moveSelectionToNewFile)
``` ```
## Available commands ## Available commands
- `.copyFilepath`: Copy the absolute file path. When `clipboard="unnamed[plus]"` has been set, copies to the `+` register, otherwise to `"`. - `.createNewFile`: Create a new file.
- `.copyFilename`: Copy the file name. When `clipboard="unnamed[plus]"` has been set, copies to the `+` register, otherwise to `"`. - `.duplicateFile`: Duplicate the current file.
- `.chmodx`: Makes current file executable. Equivalent to `chmod +x`. - `.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. If no extension is provided, keeps the current file extension. - `.renameFile`: Rename the current file.
- `.createNewFile`: Create a new file. If no extension is provided, uses the extension of the current file. - `.moveAndRenameFile`: Move and Rename the current file. Works like the UNIX `mv` command. Best used with [autocompletion of directories](#autocompletion-of-directories).
- `.duplicateFile`: Duplicate the current file. If no extension is provided, uses the current file extension.
- `.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.
- `.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.
## Autocompletion of filenames > __Note__
You can get autocompletion for filenames by using `dressing.nvim`, `nvim-cmp`, and vim's omnifunc: > 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. (All commands support [autocompletion of existing directories](#autocompletion-of-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:
```lua ```lua
-- packer -- packer

17
lua/genghis.lua
View File

@ -38,7 +38,7 @@ local function fileOp(op)
prefill = oldNameNoExt prefill = oldNameNoExt
elseif op == "move-rename" then elseif op == "move-rename" then
promptStr = "Move & Rename File to: " promptStr = "Move & Rename File to: "
prefill = dir prefill = dir .. "/"
elseif op == "new" or op == "newFromSel" then elseif op == "new" or op == "newFromSel" then
promptStr = "Name for New File: " promptStr = "Name for New File: "
prefill = "" prefill = ""
@ -76,30 +76,31 @@ local function fileOp(op)
fn.mkdir(newFolder, "p") fn.mkdir(newFolder, "p")
end end
local extProvided = newName:find(".%.") -- non-leading dot to not include dotfiles without extension local extProvided = newName:find(".%.[^/]*$") -- non-leading dot to not include dotfiles without extension
if not extProvided then newName = newName .. oldExt end if not extProvided then newName = newName .. oldExt end
local newFilePath = (op == "move-rename") and newName or dir .. "/" .. newName
cmd.update() -- save current file; needed for users with `hidden=false` cmd.update() -- save current file; needed for users with `hidden=false`
if op == "duplicate" then if op == "duplicate" then
cmd.saveas(newName) cmd.saveas(newFilePath)
cmd.edit(newName) cmd.edit(newFilePath)
vim.notify('Duplicated "' .. oldName .. '" as "' .. newName .. '".') vim.notify('Duplicated "' .. oldName .. '" as "' .. newName .. '".')
elseif op == "rename" or "move-rename" then elseif op == "rename" or op == "move-rename" then
local success, errormsg = os.rename(oldName, newName) local success, errormsg = os.rename(oldName, newName)
if success then if success then
cmd.edit(newName) cmd.edit(newFilePath)
cmd.bwipeout("#") cmd.bwipeout("#")
vim.notify('Renamed "' .. oldName .. '" to "' .. newName .. '".') vim.notify('Renamed "' .. oldName .. '" to "' .. newName .. '".')
else else
vim.notify("Could not rename file: " .. errormsg, logError) vim.notify("Could not rename file: " .. errormsg, logError)
end end
elseif op == "new" or op == "newFromSel" then elseif op == "new" or op == "newFromSel" then
cmd.edit(newName) cmd.edit(newFilePath)
if op == "newFromSel" then if op == "newFromSel" then
cmd("put z") -- cmd.put("z") does not work here :/ cmd("put z") -- cmd.put("z") does not work here :/
fn.setreg("z", prevReg) -- restore register content fn.setreg("z", prevReg) -- restore register content
end end
cmd.write(newName) cmd.write(newFilePath)
end end
end) end)
end end