arshlib.nvim

KO | EN

gitlite — search

#javascript #python #typescript #go #android #deep-learning #linux #docker #java #nodejs #windows #awesome #awesome-list #security

(★ 10)

Common library for using in neovim plugins

arshlib.nvim Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Arshlib.nvim

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/arsham/arshlib.nvim)
![License](https://img.shields.io/github/license/arsham/arshlib.nvim)

Common library for using in Neovim plugins.

1. [Requirements](#requirements)
2. [Installation](#installation)
   - [Packer](#packer)
   - [Lazy](#lazy)
3. [Quick](#quick)
   - [Normal](#normal)
4. [Util](#util)
   - [User Input](#user-input)
5. [Tables](#tables)
6. [Colour](#colour)
7. [Strings](#strings)
8. [FS](#fs)
9. [LSP](#lsp)
10. [License](#license)

## Requirements

This library supports [Neovim
v0.7.0](https://github.com/neovim/neovim/releases/tag/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:

- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
- [nui.nvim](https://github.com/MunifTanjim/nui.nvim)

Use your favourite package manager to install this library.

### Packer

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

### Lazy

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

## Quick

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

### Normal

Executes a normal command. For example:

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

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

## Util

In the following examples we assume the `util` is:

```lua
local util = require("arshlib.util")
```

### User Input

This launches a popup buffer for the input:

```lua
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 `Table`s 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.

## Colour

`arshlib.colour` module provides functionalities around colours.

## Strings

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

## FS

`arshlib.fs` provides some file-system functionalities.

## LSP

`arshlib.lsp` provides useful tools for interacting with LSP.

## License

Licensed under the MIT License. Check the [LICENSE](./LICENSE) file for details.

arshlib.nvim

arshlib.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

arshlib.nvim

arshlib.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README