indent-tools.nvim

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #machine-learning #rust #deep-learning #linux #docker #nodejs #cli #awesome-list #vue

indent-tools.nvim

(★ 17)

Neovim pluging for dealing with indentations

indent-tools.nvim Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Indent Tools

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

This Neovim plugin provides mappings and textobj for indentations capable of
repeating jumps with `;` and `,`;

1. [Demo](#demo)
2. [Requirements](#requirements)
3. [Installation](#installation)
   - [Lazy](#lazy)
   - [Packer](#packer)
   - [Config](#config)
   - [Lazy Loading](#lazy-loading)
     - [Packer Lazy Loading](#packer-lazy-loading)
     - [Lazy Lazy Loading](#lazy-lazy-loading)
4. [License](#license)

## Demo

Jumping along the indents (`[i`, `]i`):

![jumping](https://user-images.githubusercontent.com/428611/148661970-0aad20f2-61ce-4347-8971-6147556a1603.gif)

Text object (`dii`, `cai`, `yii`, `vai`, etc.):

![textobj](https://user-images.githubusercontent.com/428611/148661973-2d3cccad-715f-4f1e-a277-feb2e85396a9.gif)

## Requirements

This library supports [Neovim
v0.7.0](https://github.com/neovim/neovim/releases/tag/v0.7.0) or newer.

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

- [arshlib.nvim](https://github.com/arsham/arshlib.nvim)
- (Optional) [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects)

The _nvim-treesitter-textobjects_ is only used for repeatable jumps.

## Installation

Use your favourite package manager to install this library.

### Lazy

```lua
{
  "arsham/indent-tools.nvim",
  dependencies = {
    "arsham/arshlib.nvim",
    "nvim-treesitter/nvim-treesitter-textobjects",
  },
  config = true,
  -- or to provide configuration
  -- config = { normal = {..}, textobj = {..}},
}
```

### Packer

```lua
use({
  "arsham/indent-tools.nvim",
  requires = {
    "arsham/arshlib.nvim",
    "nvim-treesitter/nvim-treesitter-textobjects",
  },
  config = function()
    require("indent-tools").config({})
  end,
})
```

### Config

By default this pluging adds all necessary mappings. However you can change or
disable them to your liking.

To disable set them to `false`. For example:

```lua
require("indent-tools").config({
  textobj = false,
})
```

Here is the default settings:

```lua
{
  normal = {
    up   = "[i",
    down = "]i",
    repeatable = true, -- requires nvim-treesitter-textobjects
  },
  textobj = {
    ii = "ii",
    ai = "ai",
  },
}
```

If repeatable is set to true and _nvim-treesitter-textobjects_ plugin is
installed, you can repeat the jumps back and forth with `;` and `,`.

### Lazy Loading

You can let your package manager to load this plugin when a key-mapping
event is fired.

#### Packer Lazy Loading

```lua
use({
  "arsham/indent-tools.nvim",
  requires = { "arsham/arshlib.nvim" },
  config = function()
    require("indent-tools").config({})
  end,
  keys = { "]i", "[i", { "v", "ii" }, { "o", "ii" } },
})
```

#### Lazy Lazy Loading

```lua
{
  "arsham/indent-tools.nvim",
  dependencies = {
    "arsham/arshlib.nvim",
    "nvim-treesitter/nvim-treesitter-textobjects",
  },
  config = true,
  keys = { "]i", "[i", { "v", "ii" }, { "o", "ii" } },
}
```

## License

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

indent-tools.nvim

indent-tools.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

indent-tools.nvim

indent-tools.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README