Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbyuki/dash.nvim
Script runner for quick iteration. Bring your scripting to the next level.
https://github.com/jbyuki/dash.nvim
lua nvim runner script-runner
Last synced: 24 days ago
JSON representation
Script runner for quick iteration. Bring your scripting to the next level.
- Host: GitHub
- URL: https://github.com/jbyuki/dash.nvim
- Owner: jbyuki
- License: mit
- Created: 2021-03-09T17:06:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T20:54:56.000Z (3 months ago)
- Last Synced: 2024-10-12T22:54:32.808Z (about 1 month ago)
- Topics: lua, nvim, runner, script-runner
- Language: Lua
- Homepage:
- Size: 427 KB
- Stars: 38
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
dash.nvim
==================
A fast and safe script runner which outputs the result in a nicely formatted buffer.
**This is still work-in-progress.**
Supported
---------
* :seedling: : Supports but still unstable.
* :deciduous_tree: : Stable.
| Language | Execute | Visual | Quickfix | Debugger |
|----------|:-------:|:--------:|:--------:|:--------:|
| _Lua_ | :seedling: | :seedling: | :seedling: | :seedling: |
| _Python_ | :seedling: | :seedling: | | |
| _Fennel_ | :seedling: | :seedling: | | |
| _nodejs_ | :seedling: | :seedling: | | |
| _Vimscript_ | :seedling: || :seedling: | |
| _C++ / Visual Studio_ | :seedling: || :seedling: | |
| Matlab | || | |
| _Kotlin, Java / Android_ | :seedling: || :seedling:| |
| _Latex_ | :seedling: || | |
| _Go_ | :seedling: || | |
| _GLSL_ / glslc | :seedling: || | |
| _Bash_ | :seedling: || | |
Can be used in conjunction with [ntangle.nvim](https://github.com/jbyuki/ntangle.nvim).
**Visual**: Execution of a visual selection
**Remark**: I'm still debating if the lua debugger belongs here. But for convenience, I won't do a separate plugin for now.
Features
--------
### Diff Output
A basic diff algorithm highlights all the newly inserted lines in the output buffer. This is useful to quickly see which lines changes compared to the previous execution.
### Infinite Loop Guard
The execution is done completely is a sandboxed environnement. For lua, it spawns a new Neovim instance which will execute the script. The execution is done asynchronously and in case it prints infintely, **little-runner.nvim** will stop the execution after a certain number of lines has been reached.
This is an interesting workaround because executing a infinite loop through `luafile` will freeze the client normally. Lua plugins developer are most likely familar with it. Although **little-runner.nvim** sandboxed execution is interesting, it can't be applied to plugin development.
### Fill Quickfix
You can navigate instantly to the error line.
### Multi Language Support
It supports multiple languages out of the box. More support will be added as the plugin is evolving.
### Debugger
Vimscript has some good debugging support but lua has only `debug.debug()` which is insufficient in my opinion. This still breaks often and lacks features but offers some support for debugging. It's a prototype for more to come.
Start the debugger with `:DashDebug`.
* Place breakpoint: `require"dash".toggle_breakpoint()`
* Step: `require"dash".step()`
* Continue: `require"dash".continue()`
* Inspect variable: `require"dash".inspect()`
* Inspect variable (visual): `require"dash".vinspect()`
### Remote execution
The execution can happen in a remote neovim instance. It uses the TCP port `7777`
to connect to the remote process and invoke dash.nvim. For example, the host could
be Windows and the remote WSL.
Start the executing neovim instance using:
```
nvim --headless --listen localhost:7777
```
In the host environnement, open nvim and connect to the remote instance with:
```
:DashConnect
```
All the execution will happen remotely on `:DashRun`.
Installation
------------
Install using your favorite plugin manager. For example using [vim-plug](https://github.com/junegunn/vim-plug).
```vim
Plug 'jbyuki/dash.nvim'
```
Usage
-----
```vim
:DashRun
```
Design
------
Guidelines which should guide the development of this plugin.
* The plugin should be functionnal with minimal configuration
Help
----
* If you encounter any problem, please don't hesitate to open an [Issue](https://github.com/jbyuki/dash.nvim/issues).
* All contributions are welcome.
Extra
-----
For the curious out there: Try to copy-paste a brainf\*ck program and execute it using `DashRun`. Set the filetype to bf using `set ft=bf`. Admire the computation done live in front of your eyes.