https://github.com/mrcjkb/telescope-manix

A telescope.nvim extension for Manix - A fast documentation searcher for Nix
https://github.com/mrcjkb/telescope-manix

neovim neovim-plugin nix nixos telescope

Last synced: about 8 hours ago
JSON representation

A telescope.nvim extension for Manix - A fast documentation searcher for Nix

• Host: GitHub
• URL: https://github.com/mrcjkb/telescope-manix
• Owner: mrcjkb
• License: gpl-2.0
• Created: 2022-10-09T15:16:42.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T00:23:28.000Z (19 days ago)
• Last Synced: 2024-09-15T07:07:40.930Z (19 days ago)
• Topics: neovim, neovim-plugin, nix, nixos, telescope
• Language: Lua
• Homepage:
• Size: 146 KB
• Stars: 70
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# telescope-manix

![Neovim](https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white)

![Lua](https://img.shields.io/badge/lua-%232C2D72.svg?style=for-the-badge&logo=lua&logoColor=white)

![Nix](https://img.shields.io/badge/nix-0175C2?style=for-the-badge&logo=NixOS&logoColor=white)

[![LuaRocks](https://img.shields.io/luarocks/v/MrcJkb/telescope-manix?style=for-the-badge&logo=lua&color=purple)](https://luarocks.org/modules/MrcJkb/telescope-manix)

A [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

extension for [Manix](https://github.com/nix-community/manix)

> A fast documentation searcher for [Nix](https://nixos.wiki/wiki/Overview_of_the_Nix_Language)

## Quick links

- [Features](#features)

- [Prerequisites](#prerequisites)

- [Installation](#installation)

- [Configuration](#configuration)

- [Usage](#usage)

- [Customisation](#customisation)

- [Troubleshooting](#troubleshooting)

## Features

### Nix fuzzy search

[![asciicast](https://asciinema.org/a/t1rHXoElZtqW9lIhOamNG2xgu.svg)](https://asciinema.org/a/t1rHXoElZtqW9lIhOamNG2xgu)

### Search for the word under the cursor

[![asciicast](https://asciinema.org/a/6FyS0Bkp7bqSYLvY4OwvxzOF7.svg)](https://asciinema.org/a/6FyS0Bkp7bqSYLvY4OwvxzOF7)

## Prerequisites

- Neovim >= 0.9

- Depends on [Manix](https://github.com/nix-community/manix).

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

> [!NOTE]

>

> - This plugin may work with older Neovim versions,

>   but is only tested with the latest stable version and nightly.

## Installation

Using rocks.nvim:

```vim

:Rocks install telescope-manix

```

Using lazy.nvim:

```lua

{

  'nvim-telescope/telescope.nvim',

  branch = '0.1.x', -- Recommended

  dependencies = {

    'nvim-lua/plenary.nvim',

    'mrcjkb/telescope-manix',

    -- ...

  },

}

```

## Configuration

Add the following to your telescope config:

```lua

local telescope = require('telescope')

telescope.setup {

  -- opts...

}

telescope.load_extension('manix')

```

## Usage

```vim

:Telescope manix

```

```lua

require('telescope-manix').search()

-- or

require('telescope').extensions.manix.manix()

```

## Customisation

```lua

default_opts = {

  -- CLI arguments to pass to manix, see `manix --help`

  -- for example: `{'--source', 'nixpkgs_doc', '--source', 'nixpkgs_comments'}`

  -- will restrict search to nixpkgs docs and comments.

  manix_args = {},

  -- Set to true to search for the word under the cursor

  cword = false,

}

require('telescope-manix').search(default_opts)

-- or

require('telescope').extensions.manix.manix(default_opts)

```

## Troubleshooting

If you are not seeing any search results,

you may need to run `manix --update-cache `, to initialise the cache.