pltrant / GSL-Editor

GSL Editor extension for Visual Studio Code
GNU General Public License v3.0
1 stars 2 forks source link

Spellcheck for Yellow MSG text #14

Closed GS-Netz closed 2 years ago

GS-Netz commented 3 years ago

Is it possible to add spellcheck to our yellow colored msg text? Thanks. Chad/Netz

pltrant commented 2 years ago

This can be handled by a separate extension. I came across Code Spell Checker. Using it, we can create a custom configuration file to only check *.gsl files and only within specific regex patterns. In addition, we can add custom words to the dictionary.

cspell.json:

{
    "version": "0.2",
    "files": [
        "*.gsl"
    ],
    "enableFiletypes": [
        "gsl"
    ],
    "minWordLength": 3,
    "dictionaries": [
        "GemStone"
    ],
    "dictionaryDefinitions": [
        {
            "name": "GemStone",
            "path": "./GemStoneDictionary.txt"
        }
    ],
    "includeRegExpList": [
        "\"(.*?)\""
    ],
    "ignoreRegExpList": [
        "callmatch.*\"(.*?)\"",
        "set \\$MATCH to \"(.*?)\"",
        "\\:\\s+\"(.*?)\""
    ]
}

GemStoneDictionary.txt:

Elanthia
Lorminstra
Luukos

Here's how it would look:

image

You can then click on the lightbulb or right-click on the word to get suggestions, add it to the dictionary, etc. We'd probably have to come up with some step-by-step instructions on how to install and configure the extension.

pltrant commented 2 years ago

This is now implemented as of version 1.9.1, but it must be manually enabled:

Add spellcheck to your code/comments by installing the Code Spell Checker. Follow the link, then click on the green Install button. Next, open your Visual Studio Code Settings by hitting F1, then type in or copy/paste "Preferences: Open Settings (JSON)", and hit enter. In the file, add this line "cSpell.ignorePaths": [], then save and close the file.