What is this project?
Inspired by the work done in the GIMI_ini_extension repo, this extension is part of a larger project to provide multi-editor syntax highlighting for .ini files used by the program 3DMigoto, which have much more extensive syntax than the typical header + key-value pair structure of normal .ini files. The reason for the project's existence is then to improve upon that work by using more standardized scope names such that the highlighting will work with more themes out-of-the-box and will not need to provide its own theme. This extension also creates a grammar structure much more conducive to additions and modifications. While that original repo also provides additional functionality beyond the highlighting, this one currently only provides said highlighting with plans to reproduce those programmatic features in the future via an LSP language server and Tree Sitter parsing.
The Tree-sitter parser project is live and can be found at tree-sitter-migoto.
Current Features
Currently this extension only provides syntax highlighting and some very rudimentary language configuration. It will include programmatic language features in the future once an LSP language server is in place.
Some things to note:
If you wish to know more about how you can contribute to this extension, please check out the CONTRIBUTING document.
A log of all changes for this extension is provided with the CHANGELOG document.
Customization
Not all scopes are commonly styled by themes. For example, a lot of themes do not provide styling for the broad scope variable.language, opting to style things that are more specific like variable.language.this.cpp. Here are some scopes that I have personally created styling for in my settings.json for my current theme.
variable.other.readwritepunctuation.definition.variablevariable.language.shader-slot.migoto, variable.language.buffer.migoto, variable.language.resource-identifier.migoto, variable.language.shader-identifier.migoto, constant.language.override-parameter.migoto, variable.parameter.migotopunctuation.section.embeddedconstant.other.path.migoto, constant.other.file.migoto (I don't color these, but I do underline them)entity.name.namespace.migoto (themes usually style this one, I just don't like the color chosen with my theme next to the variable color, so I changed it)entity.name.section.group-title.migoto (after the change from .ini.3dm to .migoto, section titles no longer piggy-backed off of the default INI file coloring, so I needed to make a rule for it)keyword.other.instruction (originally just to make them bold, now they are colored quite differently too)variable.object.property (I believe a lot of themes make this default text colored, so I changed it)
Here's how to edit a theme via your settings.json:
Open up your settings.json file; you can do this by opening the command palette (Ctrl+Shift+P on Windows), typing "Open User Settings" and choosing the one that has (JSON) next to it. In it, start a new property called "editor.tokenColorCustomizations" with the value an object, and in that object make a property for the name of your theme in square brackets [ ]. This will also have an object value, with a property of "textMateRules" whose value is an array of objects with a scope property and a settings property.
That's a bit hard to follow in text, so here's an example using the Catppuccin Mocha theme. Feel free to copy this, replace the name of the theme, and then edit the colors and styles to your liking!
{
// ...
"editor.tokenColorCustomizations": {
// Replace the following with the name of the theme you want to customize in square brackets
"[Catppuccin Mocha]": {
"textMateRules": [
{
"scope": [
"variable",
"variable.other.readwrite",
"punctuation.definition.variable"
],
// fontStyle is always required, but you can leave it set to the empty string ""
"settings": {
"foreground": "#f5c2e7",
"fontStyle": ""
}
},
{
"scope": [
"variable.object.property"
],
"settings": {
"foreground": "#9da4d1",
"fontStyle": ""
}
},
{
"scope": [
"variable.language.shader-slot.migoto",
"variable.language.buffer.migoto",
"variable.language.resource-identifier.migoto",
"variable.language.shader-identifier.migoto"
],
"settings": {
"foreground": "#f38ba8",
"fontStyle": ""
}
},
{
"scope": [
"entity.name.tag.migoto",
],
"settings": {
"foreground": "#eba0ac",
"fontStyle": ""
}
},
{
"scope": [
"variable.language.shader-slot.migoto",
"variable.language.buffer.migoto",
"variable.language.resource-identifier.migoto",
"variable.language.shader-identifier.migoto",
"constant.language.override-parameter.migoto",
"variable.parameter.migoto"
],
"settings": {
"fontStyle": "italic"
}
},
{
"scope": [
"entity.name.function.section-type.migoto",
"support.type.dxgi-format.migoto"
],
"settings": {
"foreground": "#b4befe",
"fontStyle": ""
}
},
{
"scope": "punctuation.section.embedded",
"settings": {
"foreground": "#94e2d5",
"fontStyle": ""
}
},
{
"scope": [
"constant.other.path.migoto",
"constant.other.file.migoto"
],
"settings": {
"fontStyle": "underline"
}
},
{
"scope": "entity.name.section.group-title.migoto",
"settings": {
"foreground": "#f5e0dc",
"fontStyle": ""
}
},
{
"scope": [
"entity.name.namespace.migoto"
],
"settings": {
"foreground": "#a6e3a1",
"fontStyle": ""
}
},
{
"scope": [
"entity.name.constructor",
"keyword.other.instruction"
],
"settings": {
"foreground": "#74c7ec",
"fontStyle": "bold"
}
}
]
}
}
// ...
}
Acknowledgement
As this project was inspired by the GIMI INI extension, I feel I should explain why this is a new repo and extension rather than a direct fork. Put simply, the changes I envisioned making were not as iterative as would fit the forking process. I have ditched many of the files, renamed and modified others and the grammar is quite different. I also did not want to inherit the way that repo was set up. That being said, since the original is licensed under GPLv3, I do still need to maintain the same license and state changes made.
- Removed all files outside of the
/gimi-ini_extension directory in the original repo.
- Discarded all subdirectories of the above directory except for
syntaxes and discarded all files except for package.json and language-configuration.json.
- Modified
package.json to a more barebones state, renamed language-configuration.json to threedm-ini.language-configuration.json and modified it.
- Discarded the .yaml and v0.0.1 tmLanguage files under
syntaxes, renamed the remaining .json file to threedm-ini.tmLanguage.json and heavily modified it, with few things from the original remaining (mostly just some keyword regexes).
For more detailed comparison of modified files, one can download them from this repo and the originals from its repo at commit 4712a54c6378f340ed08c21cd68bca6bc18859f0 and compare them using a difference editor.
Of course this project would not be possible without the original contributors:
- @lewis252310
- @sinsofseven
- @leotorrez
