Add ltex.completionEnabled, disable by default

See #443.
valentjn · Oct 28, 2021 · e430930 · e430930
1 parent 19b3146
commit e430930
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -137,6 +137,7 @@ LT<sub>E</sub>X is a successor (since it's a fork) of the abandoned [LanguageToo
     - [`ltex.java.initialHeapSize`](https://valentjn.github.io/ltex/settings.html#ltexjavainitialheapsize)
     - [`ltex.java.maximumHeapSize`](https://valentjn.github.io/ltex/settings.html#ltexjavamaximumheapsize)
     - [`ltex.sentenceCacheSize`](https://valentjn.github.io/ltex/settings.html#ltexsentencecachesize)
+    - [`ltex.completionEnabled`](https://valentjn.github.io/ltex/settings.html#ltexcompletionenabled)
     - [`ltex.diagnosticSeverity`](https://valentjn.github.io/ltex/settings.html#ltexdiagnosticseverity)
     - [`ltex.checkFrequency`](https://valentjn.github.io/ltex/settings.html#ltexcheckfrequency)
     - [`ltex.clearDiagnosticsWhenClosingFile`](https://valentjn.github.io/ltex/settings.html#ltexcleardiagnosticswhenclosingfile)

diff --git a/changelog.xml b/changelog.xml
@@ -12,7 +12,10 @@
     <author>Julian Valentin, LTeX Development Community</author>
   </properties>
   <body>
-    <release version="12.2.1" date="upcoming">
+    <release version="13.0.0" date="upcoming">
+      <action type="update" issue="#443">
+        Add [`ltex.completionEnabled`](https://valentjn.github.io/vscode-ltex/docs/settings.html#ltexcompletionenabled) to disable completion by default
+      </action>
       <action type="fix" issue="vscode-ltex#442">
         Fix `StringIndexOutOfBoundsException` in `AnnotatedTextFragment.getSubstringOfPlainText`
       </action>

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vscode-ltex",
   "displayName": "LTeX – LanguageTool grammar/spell checking",
-  "version": "12.2.1-alpha.1.develop",
+  "version": "13.0.0-alpha.1.develop",
   "description": "Grammar/spell checker using LanguageTool with support for LaTeX, Markdown, and others",
   "icon": "img/logo-ltex.png",
   "author": "Julian Valentin",
@@ -2418,6 +2418,12 @@
           "default": 2000,
           "markdownDescription": "%ltex.i18n.configuration.ltex.sentenceCacheSize.markdownDescription%"
         },
+        "ltex.completionEnabled": {
+          "type": "boolean",
+          "scope": "resource",
+          "default": false,
+          "markdownDescription": "%ltex.i18n.configuration.ltex.completionEnabled.markdownDescription%"
+        },
         "ltex.diagnosticSeverity": {
           "oneOf": [
             {

diff --git a/package.nls.de.json b/package.nls.de.json
@@ -519,6 +519,8 @@
   "ltex.i18n.configuration.ltex.java.maximumHeapSize.fullMarkdownDescription": "<!-- ltex-client-specific-de-begin -->\n\nMaximale Größe des Java-Heap-Speichers in Megabytes (korrespondiert zur Java-Option `-Xmx`, muss eine positive Ganzzahl sein).\n\nEine Verkleinerung kann dazu führen, dass der Java-Prozess weniger RAM-Speicher benötigt. Wenn Sie diese Einstellung zu klein setzen, kann dies dazu führen, dass der Java-Prozess die Heap-Größe überschreitet, sodass der Fehler `OutOfMemoryError` angezeigt wird.\n\nNach Änderungen muss LTeX neugestartet werden.\n\n<!-- ltex-client-specific-end -->",
   "ltex.i18n.configuration.ltex.sentenceCacheSize.markdownDescription": "Größe des LanguageTool-Zwischenspeichers `ResultCache` in Sätzen (muss eine positive Ganzzahl sein). [Weitere Informationen ...](https://valentjn.github.io/ltex/settings-de.html#ltexsentencecachesize)",
   "ltex.i18n.configuration.ltex.sentenceCacheSize.fullMarkdownDescription": "Größe des LanguageTool-Zwischenspeichers `ResultCache` in Sätzen (muss eine positive Ganzzahl sein).\n\nFalls nur ein kleiner Teil des Textes geändert wird (z. B. ein einziger Tastendruck im Editor), dann benutzt LanguageTool den Zwischenspeicher, um zu vermeiden, dass der komplette Text nochmals überprüft werden muss. LanguageTool teilt den Text intern in Sätze auf; Sätze, die bereits überprüft worden sind, werden übersprungen.\n\nEine Verkleinerung kann dazu führen, dass der Java-Prozess weniger RAM-Speicher benötigt. Wenn Sie diese Einstellung auf einen zu kleinen Wert setzen, dann kann sich die Zeit, die LanguageTool zur Überprüfung benötigt, deutlich erhöhen.\n\nNach Änderungen muss LTeX neugestartet werden.",
+  "ltex.i18n.configuration.ltex.completionEnabled.markdownDescription": "Steuert, ob Vervollständigung aktiviert ist (auch bekannt als Auto-Vervollständigung, Schnellvorschläge und IntelliSense). [Weitere Informationen ...](https://valentjn.github.io/ltex/settings-de.html#ltexcompletionenabled)",
+  "ltex.i18n.configuration.ltex.completionEnabled.fullMarkdownDescription": "Steuert, ob Vervollständigung aktiviert ist (auch bekannt als Auto-Vervollständigung, Schnellvorschläge und IntelliSense).\n\nFalls diese Einstellung aktiviert ist, dann wird eine Liste von Wörtern angezeigt, die das aktuelle Wort ergänzen (jedes Mal, wenn der Editor eine Vervollständigungs-Anfrage sendet).\n\n<!-- ltex-client-specific-begin -->\n\nIn VS Code ist Vervollständigung während des Tippens standardmäßig aktiviert (via `editor.quickSuggestions`). Daher ist diese Einstellung standardmäßig deaktiviert, weil ständig angezeigte Vervollständigungs-Listen den Benutzer stören könnten. Es wird empfohlen, diese Einstellung zu aktivieren, aber `editor.quickSuggestions` zu deaktivieren. Dann können LTeX-Vervollständigungen durch Drücken von `Strg+Leertaste` angefordert werden.\n\n<!-- ltex-client-specific-end -->",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.markdownDescription": "Schwere, mit der Schreibfehler angezeigt werden. [Weitere Informationen ...](https://valentjn.github.io/ltex/settings-de.html#ltexdiagnosticseverity)",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.fullMarkdownDescription": "Schwere, mit der Schreibfehler angezeigt werden.\n\nErlaubt die Steuerung, wie und wo die Fehler in Visual Studio Code erscheinen. Die möglichen Schweren sind `\"error\"`, `\"warning\"`, `\"information\"` und `\"hint\"`.\n\nDiese Einstellung kann entweder ein String mit der Schwere sein, die für alle Schreibfehler benutzt werden soll, oder ein Objekt mit regelabhängigen Schweren. Falls ein Objekt verwendet wird, ist jeder Schlüssel die ID einer LanguageTool-Regel und jeder Wert einer der möglichen Schweren. In diesem Fall muss die Schwere anderer Regeln, die nicht zu einer der Schlüssel passen, mit dem besonderen Schlüssel `\"default\"` angegeben werden.",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.error.markdownEnumDescription": "Fehler mit der Schwere `error` sind üblicherweise mit einer roten geschlängelten Linie unterstrichen und erscheinen im Editor, in der Minimap, im Probleme-Reiter und im Explorer.",

diff --git a/package.nls.json b/package.nls.json
@@ -519,6 +519,8 @@
   "ltex.i18n.configuration.ltex.java.maximumHeapSize.fullMarkdownDescription": "<!-- ltex-client-specific-begin -->\n\nMaximum size of the Java heap memory in megabytes (corresponds to Java's `-Xmx` option, must be a positive integer).\n\nDecreasing this might decrease RAM usage of the Java process. If you set this too small, the Java process may exceed the heap size, in which case an `OutOfMemoryError` is thrown.\n\nChanges require restarting LTeX to take effect.\n\n<!-- ltex-client-specific-end -->",
   "ltex.i18n.configuration.ltex.sentenceCacheSize.markdownDescription": "Size of the LanguageTool `ResultCache` in sentences (must be a positive integer). [More info...](https://valentjn.github.io/ltex/settings.html#ltexsentencecachesize)",
   "ltex.i18n.configuration.ltex.sentenceCacheSize.fullMarkdownDescription": "Size of the LanguageTool `ResultCache` in sentences (must be a positive integer).\n\nIf only a small portion of the text changed (e.g., a single key press in the editor), LanguageTool uses the cache to avoid rechecking the complete text. LanguageTool internally splits the text into sentences, and sentences that have already been checked are skipped.\n\nDecreasing this might decrease RAM usage of the Java process. If you set this too small, checking time may increase significantly.\n\nChanges require restarting LTeX to take effect.",
+  "ltex.i18n.configuration.ltex.completionEnabled.markdownDescription": "Whether completion is enabled (also known as auto-completion, suggestions, or IntelliSense). [More info...](https://valentjn.github.io/ltex/settings.html#ltexcompletionenabled)",
+  "ltex.i18n.configuration.ltex.completionEnabled.fullMarkdownDescription": "Controls whether completion is enabled (also known as auto-completion, quick suggestions, and IntelliSense).\n\nIf this setting is enabled, then a list of words is displayed that complete the currently typed word (whenever the editor sends a completion request).\n\n<!-- ltex-client-specific-begin -->\n\nIn VS Code, completion is enabled by default while typing (via `editor.quickSuggestions`). Therefore, this setting is disabled by default, as constantly displaying completion lists might annoy the user. It is recommended to enable this setting, but disable `editor.quickSuggestions`. Then, LTeX completions can be requested by pressing `Ctrl+Space`.\n\n<!-- ltex-client-specific-end -->",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.markdownDescription": "Severity of the diagnostics corresponding to the grammar and spelling errors. [More info...](https://valentjn.github.io/ltex/settings.html#ltexdiagnosticseverity)",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.fullMarkdownDescription": "Severity of the diagnostics corresponding to the grammar and spelling errors.\n\nControls how and where the diagnostics appear in Visual Studio Code. The possible severities are `\"error\"`, `\"warning\"`, `\"information\"`, and `\"hint\"`.\n\nThis setting can either be a string with the severity to use for all diagnostics, or an object with rule-dependent severities. If an object is used, each key is the ID of a LanguageTool rule and each value is one of the possible severities. In this case, the severity of other rules, which don't match any of the keys, has to be specified with the special key `\"default\"`.",
   "ltex.i18n.configuration.ltex.diagnosticSeverity.error.markdownEnumDescription": "Error diagnostics are usually underlined with a red squiggly line and appear in editor, minimap, Problems tab, and Explorer.",