Show comments in GUI?

[kevin-kruse]

Hi,

this is a nice project. Just one question came to my mind: Is there some way to also show comments from the YAML file for example?

Best

[maliknajjar]

Hi, thank you so much for showing interest to the project. I really appreciate it.

Can you tell me exactly what is your use case so I can help you better. If what you want to do is show some Text like paragraphs or Headers inside the editor to organize or for documentation reasons currently we don't have this feature. but its a very good Idea and we can implement it

[kevin-kruse]

You can just add comments to the file like

# my additional comment
setting=true

It would be nice if those will be displayed also in the GUI :-)

[maliknajjar]

ok .. I get it now. Can you specify the exact location in the editor where you expect that comment to be positioned?

[maliknajjar]

you want that comment to be related to the setting boolean property?

[kevin-kruse]

I just thought to place comments placed inside the YAML/TOML etc. placed above an property also above the property in the graphical gui

[maliknajjar]

ok .. so its going to be something similar to when programmers add comments to functions, methods or a properties in order to show some extra information about it similar to this:

you can add any simple comments or even markdown and its going to be rendered like this when you hover your mouse on that function:

so we can add a feature to add a comment to every property that exists in the guifier editor

and when you hover your mouse on the field it will look like this:

and this is how it looks in yaml

# The name of the user that will be created.
name: Alice

wdyt?

[kevin-kruse]

Looks amazing :-)

[maliknajjar]

I really like the idea. thank you for sharing your ideas. I really appreciate it I will work on it as soon as possible 👍🏽

[maliknajjar]

just to keep you informed. I finished creating the description field param that enables the user to add description (comments) to the fields

you can use it in the Guifier easily this way

{
  "name": {
    "_value": "Alice",
    "_params": {
      "description": "the name of the game's main character"
    }
  },
}

now I am going to start in the parsing step. this step will involve taking the comments that resides on top of the property and add it to the description param of that field automatically