I've switched to nvim and init.lua, which pulls in onedark colorscheme. How can I add a custom rule?

Question

I have C-style comments inside PHP strings that contain SQL code, so I can easily understand what the query is doing when I see it running on the server.

DB::runQuery('/* this is my SUPER complicated update example */

    UPDATE table1 SET foo = "bar"
');

How could I add a rule to style that comment-in-a-string differently to the rest of the string?

Thank you!

Answer 1

If the syntax file already matches the /**/ comment in the string, you only need to add a highlight for it.

1. Check the syntax group (e.g., using zS from scriptease or synstax#UnderCursor() from synstax).

2. Add highlighting in ~/.vim/after/syntax/php.vim (or your Vim directory equivalent):

   highlight [opts] GROUP [stuff] " see :help :highlight
   

---

If the syntax file doesn't already match the comment in the string… you could try to hack one in (place a :syntax command in ~/.vim/after/syntax/php.vim or equivalent). You could also try a solution using :help textprop or :help matchadd().