Arshlib.nvim

Common library for using in Neovim plugins.

Requirements
Installation
- Packer
- Lazy
Quick
- Normal
Util
- User Input
Tables
Colour
Strings
FS
LSP
License

Requirements

This library supports Neovim v0.7.0 and newer.

Update

Some functionalities such as creating augroup and autocmd have been provided by newer version of Neovim and are removed from this library. If you rely on these functionalities please pin this library to 86a8bbb commit, or use the Neovim's equivalent.

Installation

This library depends are the following libraries. Please make sure to add them as dependencies in your package manager:

Use your favourite package manager to install this library.

Packer

use({
  "arsham/arshlib.nvim",
  requires = {
    "MunifTanjim/nui.nvim",
    "nvim-lua/plenary.nvim",
  },
})

Lazy

{
  "arsham/arshlib.nvim",
  dependencies = {
    "MunifTanjim/nui.nvim",
    "nvim-lua/plenary.nvim",
  }
}

Quick

arshlib.quick provides quick shortcuts for commonly used Neovim functions.

Method	Notes
`normal(mode, motion)`	Execute a command in normal mode
`call_and_centre(fn)`	Centre the cursor after calling fn
`cmd_and_centre(cmd)`	Centre the cursor after executing Ex command
`command(name, comand, opts)`	Shortcut for `nvim_create_user_command`
`buffer_command(name, comand, opts)`	Shortcut for `nvim_buf_create_user_command`
`selection_contents()`	Returns the contents of the visually selected region

Normal

Executes a normal command. For example:

quick.normal("n", "y2k")

See :h feedkeys() for values of the mode.

Util

In the following examples we assume the util is:

local util = require("arshlib.util")

User Input

This launches a popup buffer for the input:

util.user_input({
  prompt = "Message: ",
  on_submit = function(value)
    print("Thank you for your note: " .. value)
  end,
})

Tables

arshlib.colour module augments the internal table with new methods that can be chained. A _t is injected in the global space that can be used to create new Tables or convert a normal table to the type of Table. Methods that require a Table instance, if they receive a table instance, they will convert them automatically.

If a return value is of Table type, the returned value is always a new instance.

Method	Notes
`filter(fn)`
`map(fn)`
`values()`
`slice(f, l, s)`	Slice with step
`merge(other)`
`find_first(fn)`
`contains_fn(fn)`
`contains(string)`
`reverse()`
`shuffle()`
`shunk(size)`	Returns chunks of tables
`unique(fn)`
`sort(fn)`
`exec(fn)`	Execute on the whole table
`when(bool)`	Returns an empty Table if v is false
`map_length()`	includes the key-value pairs

Colour

arshlib.colour module provides functionalities around colours.

Method	Notes
`hex_to_rgb(hex)`
`rgb_to_hsv(r, g, b)`
`hsv_to_rgb(h, s, v)`
`rgb_to_hex(r, g, b)`
`andi_colour(colour, text)`	Used for terminal colouring

Strings

arshlib.strings injects some methods into the string std module.

Method
`title_case(str)`

FS

arshlib.fs provides some file-system functionalities.

Method	Notes
`file_module(filename)`	Returns module name and the filepath

LSP

arshlib.lsp provides useful tools for interacting with LSP.

Method	Notes
`is_lsp_attached()`
`has_lsp_capability(capability)`	True if at least one of the LSP servers has the given capability.
`get_diagnostics_count(severity)`
`diagnostics_exist(severity)`
`diagnostic_errors()`	Count
`diagnostic_warnings()`	Count
`diagnostic_hints()`	Count
`diagnostic_info()`	Count
`go_mod_tidy(bufnr,`filename)	Executes go.mod tidy.
`go_mod_check_upgrades(filename)`	Checks for dependency updates and adds to the quickfix list.

License

Licensed under the MIT License. Check the LICENSE file for details.

arsham / arshlib.nvim Goto Github PK

arshlib.nvim's Introduction