Introduce a new regex for a special comment: howto?

[wimalopaan]

I tried to introduce a special comment for CPP-directives like

#include "bla.lua"

in lua.tmLanguage.json

.vscode-oss/extensions/sumneko.lua-2.5.3/syntaxes

But now luck with

				{
						"begin": "^\\s*#[a-z]+",
						"beginCaptures": {
							"0": {
								"name": "punctuation.definition.comment.lua"
							}
						},
						"end": "\\n",
						"name": "comment.line.double-dash.lua"
					},

Maybe ralated too: https://github.com/sumneko/vscode-lua/issues/51
 

[sumneko]

I can't understand what you want, please tell more details

[wimalopaan]

In some lua-file, e.g.

#include "bla.lua"
#define VALUE 42
local function test()
#ifdef DEBUG 
return 42;
#else
return 0;   
#end 
end

I want to use CPP-preprocessor directives like demonstrated above.
These should be

1. first not disturb the parsing of the lua code
2. be coloured in a special way.

I tried to achieve that with the above extension.

[sumneko]

For 1. , please check https://github.com/sumneko/lua-language-server/wiki/Plugin

[wimalopaan]

Ok, thanks.

The plugin gets found, but no diffed.lua is created.

[wimalopaan]

{
    "Lua.misc.parameters": [
        "--develop=true"
      ],

    "Lua.diagnostics.disable": [
        "undefined-global"
    ],
    "Lua.completion.displayContext": 2,
    "files.associations": {
        "*.lpp": "lua",
        "*.lh": "lua",
        "makefile.include": "makefile"
    },
    "Lua.diagnostics.globals": [
        "__libI",
        "errorCode",
        "__libD",
        "__libP",
        "__stopWmSw2",
        "__libA"
    ],
    "Lua.workspace.library": ["lib"],
    "files.autoSave": "afterDelay",
    "Lua.completion.showWord": "Enable",
    "Lua.diagnostics.libraryFiles": "Enable",
    "Lua.hint.enable": true,
    "Lua.color.mode": "SemanticEnhanced",
    "Lua.runtime.plugin": "/home/lmeier/Projekte/lua/plugin.lua",
}

[wimalopaan]

Ok, works.

[wimalopaan]

What about 2) ?

[sumneko]

You may try this: https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide#injection-grammars

EDIT: VSCode dose not supports 2) in one extension, you may create a new extension to do this

[wimalopaan]

Wouldn't be sufficient to edit lua.tmLanguage.json?
Can you give me a hint to do that?

[sumneko]

Wouldn't be sufficient to edit lua.tmLanguage.json? Can you give me a hint to do that?

It is not good to modify internal files directly, because you need to modify it again after the new version is released.

You could replace # to // by plugin, then add // to Lua.runtime.nonstandardSymbol and set Lua.color.mode to Semantic or SemanticEnhanced

[wimalopaan]

It is not good to modify internal files directly, because you need to modify it again after the new version is released.

Yes, I would go an patch approach.

You could replace # to // by plugin, then add // to Lua.runtime.nonstandardSymbol and set Lua.color.mode to Semantic or SemanticEnhanced

Why replace by // instead of -- as lua comment for the parser?

[sumneko]

Color of -- is parsed by tmLanguage.json (client side) , so it can not handle plugin.
Color of // is parsed by semantic-tokens language feature (server side), it can handle plugin.

[wimalopaan]

Can I choose a speacial color for // then?

[sumneko]

"editor.semanticTokenColorCustomizations": {
    "rules": {
        "comment": "#ff0000"
    }
}

[wimalopaan]

Mmh, does not work (should be red):

diffed.lua:

//include "../../global.h"

//ifdef INCLUDE_ANIMATIONS
//endif

local function run(event)
lcd.clear();
local x = 20;
local y = 20;

lcd.drawText(x, y, "Press ENTER", MIDSIZE);

if (event == EVT_VIRTUAL_ENTER) then
return 1;
else
return 0;
end
end

return {
run = run
};

settings.json:

{
    "editor.semanticTokenColorCustomizations": {
        "rules": {
                "comment": "#FF0000" 
        }
    },
    "Lua.misc.parameters": [
        "--develop=true"
      ],
    "Lua.diagnostics.disable": [
        "undefined-global"
    ],
    "Lua.completion.displayContext": 2,
    "files.associations": {
        "*.lpp": "lua",
        "*.lh": "lua",
        "makefile.include": "makefile"
    },
    "Lua.diagnostics.globals": [
        "__libI",
        "errorCode",
        "__libD",
        "__libP",
        "__stopWmSw2",
        "__libA"
    ],
    "Lua.workspace.library": ["lib"],
    "files.autoSave": "afterDelay",
    "Lua.completion.showWord": "Enable",
    "Lua.diagnostics.libraryFiles": "Enable",
    "Lua.hint.enable": true,
    "Lua.color.mode": "Semantic",
    "Lua.runtime.plugin": "/home/lmeier/Projekte/lua/plugin.lua",
    "Lua.runtime.nonstandardSymbol": ["//"]
}

[sumneko]

Try to reopen/scoll this file, the client may not refresh at the first time

[wimalopaan]

No luck

[sumneko]

Try set editor.semanticHighlighting.enabled to true

[wimalopaan]

As well no luck

[sumneko]

I have no idea, but I can confirm that it works at my side

[wimalopaan]

Can you share your example?

[sumneko]

https://github.com/sumneko/sample-plugin-2

[wimalopaan]

I'm using exaclty your example / plugin / setting ... no luck with color

[wimalopaan]

Your example only works if main.lua has 5 lines. With 6 lines (blank) it does not work anymore

[wimalopaan]

[sumneko]

Your example only works if main.lua has 5 lines. With 6 lines (blank) it does not work anymore

I can reproduce it with EOL LF.
If your environment allows, you can change EOL to CRLF to bypass this problem for now.

[wimalopaan]

This is Linux, so LF only

[sumneko]

Maybe you can only waiting for fixing this bug or editing lua.tmLanguage.json first.
Notice that the getlen symbol (print(#array)) has used #, you must inject before it.

[wimalopaan]

Maybe you can only waiting for fixing this bug or editing lua.tmLanguage.json first. Notice that the getlen symbol (print(#array)) has used #, you must inject before it.

Well, I have no real idea how to do that.

I hope you can fix that soon