https://github.com/nvim-neorocks/rocks-dev.nvim

A swiss-army knife for testing and developing rocks.nvim modules.
https://github.com/nvim-neorocks/rocks-dev.nvim

neovim rocks-nvim

Last synced: 12 days ago
JSON representation

A swiss-army knife for testing and developing rocks.nvim modules.

• Host: GitHub
• URL: https://github.com/nvim-neorocks/rocks-dev.nvim
• Owner: nvim-neorocks
• License: gpl-3.0
• Created: 2023-12-19T17:01:31.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T17:59:35.000Z (3 months ago)
• Last Synced: 2024-10-29T21:40:00.247Z (20 days ago)
• Topics: neovim, rocks-nvim
• Language: Lua
• Homepage:
• Size: 95.7 KB
• Stars: 14
• Watchers: 4
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        






  

    

  

  


    

    

    

    


    Report Bug

    ·

    Request Feature

    ·

    Ask Question

  

  


    

      A Swiss army knife for building and testing rocks.nvim modules.

    

  



[![LuaRocks][luarocks-shield]][luarocks-url]

## :star2: Summary

`rocks-dev.nvim` extends [`rocks.nvim`](https://github.com/nvim-neorocks/rocks.nvim)

with the ability to install dev plugins locally.

## :hammer: Installation

Simply run `:Rocks install rocks-dev.nvim`,

and you are good to go!

## :books: Usage

With this extension, you can add a `dir` field table to plugins in your `rocks.toml`,

for example:

```toml

[plugins."sweetie.nvim"]

dir = "~/git/nvim/sweetie.nvim"

```

This extension also supports `dev.path`, which allows you to provide the path to where local plugins

are stored. You can tell rocks-dev to load a plugin from that path with `dev = true`, for example:

```toml

[dev]

path = "~/Projects"

[plugins]

"sweetie.nvim" = { dev = true }

```

When both `dir` and `dev = true` are present, `dir` gets priority.

## :electric_plug: `rocks-config` interoperability

You can use [`rocks-config.nvim >= 2.0.0`](https://github.com/nvim-neorocks/rocks-config.nvim) 

to configure `dev` plugins, however, it does not currently work with [bundles](https://github.com/nvim-neorocks/rocks-config.nvim?tab=readme-ov-file#plugin-bundles).

## :book: License

`rocks-dev.nvim` is licensed under [GPLv3](./LICENSE).

[luarocks-shield]: https://img.shields.io/luarocks/v/neorocks/rocks-dev.nvim?logo=lua&color=purple&style=for-the-badge

[luarocks-url]: https://luarocks.org/modules/neorocks/rocks-dev.nvim