Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MisanthropicBit/decipher.nvim
A neovim plugin for encoding and decoding text
https://github.com/MisanthropicBit/decipher.nvim
Last synced: 3 months ago
JSON representation
A neovim plugin for encoding and decoding text
- Host: GitHub
- URL: https://github.com/MisanthropicBit/decipher.nvim
- Owner: MisanthropicBit
- License: bsd-3-clause
- Created: 2022-11-28T20:54:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-28T14:53:50.000Z (6 months ago)
- Last Synced: 2024-07-28T16:07:42.443Z (6 months ago)
- Language: Lua
- Size: 575 KB
- Stars: 30
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - MisanthropicBit/decipher.nvim (⭐34) - Encode and decode text using various codecs such as base64. (Recently Updated / [Dec 23, 2024](/content/2024/12/23/README.md))
README
decipher.nvim
A plugin that provides ways to encode and decode text using various codecs like base64.
> [!IMPORTANT]
> A bit library is needed which requires that either neovim has been compiled with luajit or you are using v0.9.0+ which provides a bit library.
## Installing
* **[vim-plug](https://github.com/junegunn/vim-plug)**
```vim
Plug 'MisanthropicBit/decipher.nvim'
```
* **[packer.nvim](https://github.com/wbthomason/packer.nvim)**
```lua
use 'MisanthropicBit/decipher.nvim'
```
## Setup
Setup decipher using `decipher.setup` unless you are content with the defaults.
The options below are the default values. Refer to the
[docs](doc/decipher.txt) for more help.
```lua
require("decipher").setup({
active_codecs = "all", -- Set all codecs as active and useable
float = { -- Floating window options
padding = 0, -- Zero padding (does not apply to title if any)
border = { -- Floating window border
{ "╭", "FloatBorder" },
{ "─", "FloatBorder" },
{ "╮", "FloatBorder" },
{ "│", "FloatBorder" },
{ "╯", "FloatBorder" },
{ "─", "FloatBorder" },
{ "╰", "FloatBorder" },
{ "│", "FloatBorder" },
},
mappings = {
close = "q", -- Key to press to close the floating window
apply = "a", -- Key to press to apply the encoding/decoding
jsonpp = "J", -- Key to prettily format contents as json if possbile
help = "?", -- Toggle help
},
title = true, -- Display a title with the codec name
title_pos = "left", -- Position of the title
autoclose = true, -- Autoclose floating window if insert
-- mode is activated or the cursor is moved
enter = false, -- Automatically enter the floating window if
-- opened
options = {}, -- Options to apply to the floating window contents
},
})
```
## Example keymaps
There are several ways in which you can invoke `decipher`. Check out the
[docs](doc/decipher.txt) for more info. Below are some examples:
```lua
-- Encode visually selected text as base64. If invoked from normal mode it will
-- try to use the last visual selection
vim.keymap.set({ "n", "v" }, "", function()
require("decipher").encode_selection("base64")
end)
-- Decode encoded text using a motion, selecting a codec and previewing the result
vim.keymap.set("n", "", function()
require("decipher").decode_motion_prompt({ preview = true })
end)
```
## Supported Codecs
Legend
* ✅ = supported
* ❌ = not supported
* 🗓️ = planned
| Codec | Encoding | Decoding |
| :--------------- | :-------: | :-------: |
| base32 | ✅ | ✅ |
| zbase32 | ✅ | ✅ |
| crockford | ✅ | ✅ |
| base64 | ✅ | ✅ |
| base64-url¹ | ✅ | ✅ |
| base64-url-safe² | ✅ | ✅ |
| url | ✅ | ✅ |
¹ Combination of base64 and url codecs.
² Base64-variant that is safe to include in urls.