Merge branch 'topic/als-config-comments' into 'master'

Support comments in ALS JSON configuration files

Closes #1577

See merge request eng/ide/ada_language_server!1882

Author: eliericha

CHANGELOG.md

@@ -4,6 +4,8 @@
 section below it for the last release. -->
 ## \<next>
 
+* Support single-line (`//`) and multi-line (`/* */`) comments in ALS JSON configuration files
+
 ## 26.0.202412190
 
 * The configured project is now automatically reloaded when adding/renaming/deleting a file in a known source directory.

integration/vscode/ada/package.json

@@ -914,6 +914,9 @@
             "[ada]": {
                 "editor.tabSize": 3,
                 "editor.detectIndentation": false
+            },
+            "files.associations": {
+                ".als.json": "jsonc"
             }
         },
         "walkthroughs": [

source/ada/lsp-ada_configurations.adb

@@ -25,7 +25,7 @@ with GNATCOLL.VFS;
 with LSP.GNATCOLL_Tracers;
 with LSP.Utils;
 
-with VSS.JSON.Pull_Readers.Simple;
+with VSS.JSON.Pull_Readers.JSON5;
 with VSS.JSON.Streams;
 with VSS.Strings.Conversions;
 with VSS.Strings.Formatters.Booleans;
@@ -384,7 +384,7 @@ package body LSP.Ada_Configurations is
       File : VSS.Strings.Virtual_String)
    is
       Input   : aliased VSS.Text_Streams.File_Input.File_Input_Text_Stream;
-      Reader  : VSS.JSON.Pull_Readers.Simple.JSON_Simple_Pull_Reader;
+      Reader  : VSS.JSON.Pull_Readers.JSON5.JSON5_Pull_Reader;
       JSON    : LSP.Structures.LSPAny;
    begin
       Input.Open (File, "utf-8");

testsuite/ada_lsp/config_comments/.als.json

@@ -0,0 +1,7 @@
+{
+   // Single line comment
+   /* multi-line
+      comment
+   */
+   "projectFile": "non-root/p2.gpr"
+}

testsuite/ada_lsp/config_comments/non-root/p2.gpr

@@ -0,0 +1,2 @@
+project P2 is
+end P2;

testsuite/ada_lsp/config_comments/test.py

@@ -0,0 +1,15 @@
+"""
+The goal of this test is to check that comments are supported in .als.json files
+
+To test that, we create a non-root/p2.gpr project file and configure it in a .als.json
+with comments. We can determine if the config loading was successful (i.e. comments are
+supported) by querying for the current project.
+"""
+
+from drivers.pylsp import URI, ALSLanguageClient, assertEqual, test
+
+
+@test()
+async def func(lsp: ALSLanguageClient) -> None:
+    response = await lsp.getCurrentProject()
+    assertEqual(response, URI("non-root/p2.gpr"))

testsuite/ada_lsp/config_comments/test.yaml

@@ -0,0 +1 @@
+driver: pylsp