Merge pull request #138 from gnikit/gnikit/issue137

Gnikit/issue137

Author: gnikit

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 ### Added
 
+- Added support for comments in the `json` configuration files
+  ([#137](https://github.com/gnikit/fortls/issues/137))
 - Added `sitemap.xml` to documentation webpage
   ([#134](https://github.com/gnikit/fortls/pull/134))
 

fortls/langserver.py

@@ -1,4 +1,3 @@
-# TODO: enable jsonc C-style comments
 from __future__ import annotations
 
 import json
@@ -14,6 +13,7 @@
 from typing import Pattern
 from urllib.error import URLError
 
+import json5
 from packaging import version
 
 # Local modules
@@ -1502,12 +1502,7 @@ def _load_config_file(self) -> None:
 
         try:
             with open(config_path, "r") as jsonfile:
-                # Allow for jsonc C-style commnets
-                # jsondata = "".join(
-                #     line for line in jsonfile if not line.startswith("//")
-                # )
-                # config_dict = json.loads(jsondata)
-                config_dict = json.load(jsonfile)
+                config_dict = json5.load(jsonfile)
 
                 # Include and Exclude directories
                 self._load_config_file_dirs(config_dict)
@@ -1530,7 +1525,7 @@ def _load_config_file(self) -> None:
 
         # Erroneous json file syntax
         except ValueError as e:
-            msg = f"Error: '{e}' while reading '{self.config}' Configuration file"
+            msg = f'Error: "{e}" while reading "{self.config}" Configuration file'
             self.post_message(msg)
 
     def _load_config_file_dirs(self, config_dict: dict) -> None:

setup.cfg

@@ -39,6 +39,7 @@ project_urls =
 packages = find:
 python_requires = >= 3.7
 install_requires =
+    json5
     packaging
     importlib-metadata; python_version < "3.8"
     typing-extensions; python_version < "3.8"

test/test_server_messages.py

@@ -22,8 +22,8 @@ def test_config_file_non_existent_options():
     ref = {
         "type": 1,
         "message": (
-            "Error: 'Expecting ':' delimiter: line 2 column 18 (char 19)' while reading"
-            " 'wrong_syntax.json' Configuration file"
+            'Error: "<string>:2 Unexpected "," at column 18" while reading'
+            ' "wrong_syntax.json" Configuration file'
         ),
     }
     assert errcode == 0

test/test_source/.fortls

@@ -1,7 +1,9 @@
 {
+  // Directories to be scanned for source files
   "source_dirs": [
     "**/"
   ],
+  // These are regular expressions, files and paths that can be ignored
   "excl_paths": [
     "excldir/**",
     "./diag/",