Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manning390/wrd.nvim
Thesaurus Neovim Plugin
https://github.com/manning390/wrd.nvim
Last synced: about 2 months ago
JSON representation
Thesaurus Neovim Plugin
- Host: GitHub
- URL: https://github.com/manning390/wrd.nvim
- Owner: manning390
- Created: 2024-05-16T23:02:39.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T23:23:45.000Z (8 months ago)
- Last Synced: 2024-08-02T18:37:13.996Z (5 months ago)
- Language: Lua
- Size: 2.93 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- my-neovim-pluginlist - manning390/wrd.nvim - commit/manning390/wrd.nvim)  (Other Standard Feature Enhancement / Dictionary)
README
# Wrd.nvim
`wrd.nvim` is an extendable thesaurus and dictionary plugin built on [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) for neovim. It leverages [datamuse](https://datamuse.com/) apis and provides multiple functions for finding words related to your query.
## Table of Contents
- [Getting Started](#getting-started)
- [Usage](#usage)
## Getting Started
Requires [Neovim (v0.9.0)](https://github.com/neovim/neovim/releases/tag/v0.9.0), or the lastest neovim nightly commit, for `telescope.nvim`, which is heavily used under the hood. See Telescope installation documentation in case of issues.
### Required dependencies
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) is required.
- [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim) is required.
### Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
-- init.lua:
{
'manning390/wrd.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
{'nvim-telescope/telescope.nvim', tag = '0.1.6'}
},
opts = {},
}
-- plugins/wrd.lua:
return {
'manning390/wrd.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
{'nvim-telescope/telescope.nvim', tag = '0.1.6'}
},
opts = {},
}
```
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'manning390/wrd.nvim'
requires = { {'nvim-lua/plenary.nvim'}, {'/telescope.nvim', tag = '0.1.6'} }
}
```
Using [vim-plug](https://github.com/junegunn/vim-plug)
```viml
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim', { 'tag': '0.1.6' }
Plug 'manning390/wrd.nvim'
```
## Usage
If you aren't using the `lazy.nvim` snippet above you'll need to run setup at least once to get the `:Wrd` command. Or you can call the internal methods directly via keybinds.
```lua
require('wrd').setup({}) -- Registers :Wrd
-- or
vim.keymap.set('n', 'z/', require'wrd'.run, { desc = 'Wrd: Run default wrd query'})
vim.keymap.set('n', 'zm', require'wrd'.run_methods, { desc = 'Wrd: List available methods from client'})
```
### Default configuration
These are the default values, set to overwrite:
```lua
-- Setup({})
{
client_key = "datamuse", -- Set to target internal client API
default_method = "means_like", -- Default method if one is not provided, must be available in client API
commands = true, -- Register the :Wrd command
client = nil -- Can be set to provide custom client API, if unset, will instance `client` from `client_key`
}
-- run({})
```
### Command
With the default config the `:Wrd` command will get automatically registered.
***Optional arguments and usage may change as I test out this plugin during daily driving***
```
:Wrd
:Wrd sesquipedalian
```
If you pass no arguments you will be promted for a word, autofilled with what's under your cursor. Or you may pass a word directly.
### Chaining
While you are browsing the dictionary responses, you may want to dig deeper or change your query.
- `` Will take the currently highlighted word within telescope and rerun your method with that word.
- `?` Will prompt you to change methods provided by the client with the current queried word.
### Selection
After finding a word or phrase that you want to use, you can select it with `enter` as you normally would by default within telescope.
This will store the word within the `*` and `@`. If you are hovered over a word, it will directly replace it.