aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorMatěj Cepl <mcepl@cepl.eu>2025-02-24 18:59:10 +0100
committerFlorian Fischer <florian.fischer@muhq.space>2025-03-10 16:13:45 -0300
commit9f30c87b5b687118f4e0c88249ca08ebad2f3003 (patch)
treef30cf9b9482faa531e1da671350e22df871a6748 /Readme.md
parent5f11dae4b32ae288951bda63e4936815ec2e4087 (diff)
downloadvis-spellcheck-9f30c87b5b687118f4e0c88249ca08ebad2f3003.tar.gz
vis-spellcheck-9f30c87b5b687118f4e0c88249ca08ebad2f3003.zip
feat: automatically enable spellchecking through local setting
When the local setting spellcheck.spelling_autoenable is set to true and spelling is available (via `spelling_language` setting in .editorconfig), vis will automatically enable spellchecker without any additional user action. References: https://github.com/editorconfig/specification/pull/41
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
index f0c2865..e91b532 100644
--- a/Readme.md
+++ b/Readme.md
@@ -26,6 +26,9 @@ The module table returned from `require(...)` has some configuration options:
* default: `enchant -l -d %s`
* `default_lang`: The name of the used dictionary if the opened file does not specify one. The selected language is inserted in the cmd-strings at `%s`.
* default: `$LANG` or `en_US`
+* `spelling_autoenable`: Enable automatic enabling of spellchecker when spelling is available
+ (via `spelling_language` setting in .editorconfig) without any additional user action.
+ * default: `false`
* `typo_style`: The style string with which misspellings should be highlighted when using the _full viewport_ method
* default: `fore:red`
* `check_tokens`: A table mapping all token names we consider for spellchecking to true