liadoz/nvim-dap-repl-highlights

Add syntax highlighting to the nvim-dap REPL

nvim-dap-repl-highlights

Add syntax highlighting to the nvim-dap REPL buffer using treesitter.

Before	After

Requirements

• Neovim 0.9 or later
• nvim-treesitter

Setup

Install the plugin and the requirements using your favourite method. Once installed, make sure you configured treesitter highlighting then add the following to your lua config

require('nvim-dap-repl-highlights').setup()

After initially setting up the plugin the dap_repl parser needs to be installed, this can be done manually by running :TSInstall dap_repl or by using the ensure_installed option of nvim-treesitter. NOTE: If you use the ensure_installed option you must first setup nvim-dap-repl-highlights or else the dap_repl parser won't be found, for example

require('nvim-dap-repl-highlights').setup()
require('nvim-treesitter.configs').setup {
  highlight = {
    enable = true,
  },
  ensure_installed = { 'dap_repl', ... },
  ...
}

Usage

By default, the plugin detects the language to use in the REPL by looking at the filetype used to to launch dap. Obviously in order to have syntax highlighting for certain language you will need to have a treesitter parser for that language, alongside the dap_repl parser. This may not fit all use cases.

You could instead use the command :lua require('nvim-dap-repl-highlights').setup_highlights('python') which will set python highlights in the current repl buffer. Alternatively the function can be called without specifiying the language, this will prompt the user for a language.

Additionally you could specify in the dap configuration the repl language to use, for example if you want your python repl to have javascript highlighting:

local dap = require('dap')
dap.configurations.python = {
  {
    name = "Python with javascript repl because I like to watch the world burn 🔥🔥🔥",
    type = "python",
    request = "launch",
    program = "${file}",
    repl_lang = "javascript"
  },
}

The repl_lang option takes precedence over the filetype.

nvim-dap-repl-highlights's Issues

Not Enough Room

tmp-2023-09-25_04.12.53.mp4

Neovim Nightly: config
Archlinux
dwm: config

How to install this using lazy.nvim ?

No highlights applied - Please help debugging

Hey 👋🏾

I think the idea of the plugin is great and I would love to use it. Unfortunately I'm unable to make it work. 🙈

So if I run :TSInstallInfo, I can see dap_repl as installed. If I run :lua =vim.treesitter.inspect_language('dap_repl'), I get the following output:

{
  _abi_version = 14,
  fields = {},
  symbols = { { "\n", false },
    [3] = { "prompt_tag", true },
    [4] = { "continue_prompt_tag", true },
    [5] = { "source_file", true },
    [6] = { "entry", true },
    [7] = { "prompt", true },
    [8] = { "user_input", true },
    [10] = { "user_input_statement", true },
    [11] = { "user_input_content", true },
    [12] = { "output", true },
    [13] = { "output_content", true }
  }
}

Anyhow, if I start a debugging session and have the dap-repl buffer opened, I don't get any highlighting. How can I investigate further why the highlights don't apply?
I'm using a Rust project with codelldb.

Thank you very much! 🙏🏾

Will this plugin support Neovim 0.8+?

How to Insert Multilines function in dap-repl?

Thanks for your useful plugin. In your example, I found you defined "foo()" function with multilines, but in my dap-repl, I can't do that. I'd like to know how could you do that

It's not enabled by default.

I just tried your plugin but it has no effect, these are the related configs:

{
  'nvim-treesitter/nvim-treesitter',
  build = ':TSUpdate',
  dependencies = {
    -- many unrelated lines omitted.
    { 'LiadOz/nvim-dap-repl-highlights', config = true },
  },
  config = function ()
    -- I also tried the next line too, same result.
    -- require('nvim-dap-repl-highlights').setup()
    require('nvim-treesitter.configs').setup {
      -- many unrelated lines omitted.
      ensure_installed = { 'dap_repl' },

No installation instructions

I tried installing this plugin with vim-plugged as usual, but it didn't activate.

Plug 'LiadOz/nvim-dap-repl-highlights'

I tried doing it manually with

:lua require('nvim-dap-repl-highlights').setup()

But I got

E5108: Error executing lua [string ":lua"]:1: module 'nvim-dap-repl-highlights' not found:
        no field package.preload['nvim-dap-repl-highlights']
        no file './nvim-dap-repl-highlights.lua'
        no file '/home/user/repositories/vim/neovim/.deps/usr/share/luajit-2.1.0-beta3/nvim-dap-repl-highlights.lua'
        no file '/usr/local/share/lua/5.1/nvim-dap-repl-highlights.lua'
        no file '/usr/local/share/lua/5.1/nvim-dap-repl-highlights/init.lua'
        no file '/home/user/repositories/vim/neovim/.deps/usr/share/lua/5.1/nvim-dap-repl-highlights.lua'
        no file '/home/user/repositories/vim/neovim/.deps/usr/share/lua/5.1/nvim-dap-repl-highlights/init.lua'
        no file './nvim-dap-repl-highlights.so'
        no file '/usr/local/lib/lua/5.1/nvim-dap-repl-highlights.so'
        no file '/home/user/repositories/vim/neovim/.deps/usr/lib/lua/5.1/nvim-dap-repl-highlights.so'
        no file '/usr/local/lib/lua/5.1/loadall.so'
stack traceback:
        [C]: in function 'require'
        [string ":lua"]:1: in main chunk
Press ENTER or type command to continue

So I looked into the repository and saw the cargo file (rust is not mentioned as a dependency). So I built it with

cargo build --release --all-features

and amended my vimrc/init

Plug 'LiadOz/nvim-dap-repl-highlights' {'do': 'cargo build --release --all-features'}

I tried again, and again it didn't work (same error as above). I don't want to run a system wide install.

Please add documentation on how to install this.

I also noticed that the directory that I used to set up vim-plugged doesn't appear in that list of error messages. It should be in ~/.vim/plugged. All my other plugins work just fine like that.