vscode-extension: comment about the difference between isLanguageClie…

…ntReady and as3mxmlCodeIntelligenceReady
BowlerHatLLC · Mar 13, 2024 · b1a32a4 · b1a32a4
1 parent df2531f
commit b1a32a4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/vscode-extension/src/main/ts/extension.ts b/vscode-extension/src/main/ts/extension.ts
@@ -673,6 +673,14 @@ function startClient() {
           as3mxmlCodeIntelligenceReady
         );
         isLanguageClientReady = false;
+        // NOTE: isLanguageClientReady and as3mxmlCodeIntelligenceReady mean
+        // different things.
+        // isLanguageClientReady is true once the language server has started,
+        // and is communicating with the extension, but that doesn't mean any
+        // projects have been found. in that case, as3mxmlCodeIntelligenceReady
+        // will still be false. if a valid asconfig.json file is created, the
+        // language server will activate a project, and
+        // as3mxmlCodeIntelligenceReady will be changed to true.
         savedLanguageClient = new LanguageClient(
           "actionscript",
           "ActionScript & MXML Language Server",