Merge pull request #185 from gnikit/feat/multiple-configs

feat: adds more default configuration file names

Author: gnikit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -39,7 +39,7 @@ If applicable, add screenshots or GIF/MP4 animations to help explain your proble
  - the Fortran extension for the code editor and its version [e.g. Modern Fortran v3.0.0] (if applicable)
 
 **Configuration information (please complete the following information):**
-- Your `.fortls` configuration file OR any other JSON config being used (if any)
+- Your `.fortlsrc` or `.fortls.json` or `.fortls` configuration file OR any other JSON config being used (if any)
 - Any settings specified through your extension [e.g. for VS Code settings from `settings.json`]
 
 **Additional context**

CHANGELOG.md

@@ -2,17 +2,14 @@
 
 ## Unreleased
 
-## 2.14.0
+## 2.13.0
 
 ### Added
 
+- Added additional default configuration file names `.fortlsrc`, `.fortls.json`
+  ([#184](https://github.com/gnikit/fortls/issues/184))
 - Added coverage testing for multiple Python versions
   ([#168](https://github.com/gnikit/fortls/pull/178))
-
-## 2.13.0
-
-### Added
-
 - Added pre-commit.ci to `fortls`
   ([#168](https://github.com/gnikit/fortls/issues/168))
 

docs/options.rst

@@ -25,10 +25,12 @@ Configuration using the command line
 Configuration using a file
 --------------------------
 
-A configuration file is a JSON style file that contains project specific
-settings for ``fortls``. By default the name of the filepath is assumed to be
-``root_path/.fortls`` but different files can be used through the command line
-interface e.g. ``fortls --config my_project.json``.
+A configuration file is a JSONC (JSON with comments) file that contains project specific
+settings for ``fortls``. By default, the Language Server will recognise 3 default
+names ``.fortlsrc``, ``.fortls.json`` and ``.fortls`` (in that order)
+under the ``root_path`` of the project, e.g. ``root_path/.fortlsrc``.
+A different configuration file name can be passed with the command line
+interface options ``--config`` e.g. ``fortls --config my_project.json``.
 
 The settings that can be specified in the configuration file are identical to
 the ones available through the command line interface having removed the leading

fortls/interface.py

@@ -26,7 +26,8 @@ def cli(name: str = "fortls") -> argparse.ArgumentParser:
         formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=60),
         epilog=(
             "All options starting with '--' can also be set in a configuration file, by"
-            " default named '.fortls' (other names/paths can specified via -c or"
+            " default named '.fortlsrc', '.fortls.json' or '.fortls'"
+            " (other names/paths can specified via -c or"
             " --config). For more details see our documentation:"
             " https://gnikit.github.io/fortls/options.html#available-options"
         ),
@@ -43,8 +44,11 @@ def cli(name: str = "fortls") -> argparse.ArgumentParser:
         "-c",
         "--config",
         type=str,
-        default=".fortls",
-        help="Configuration options file (default file name: %(default)s)",
+        default=".fortlsrc",
+        help=(
+            "Configuration options file (default file name: %(default)s, other"
+            " default supported names: .fortls.json, .fortls)"
+        ),
     )
     parser.add_argument(
         "-n",

fortls/langserver.py

@@ -1492,16 +1492,21 @@ def serve_default(self, request: dict):
     def _load_config_file(self) -> None:
         """Loads the configuration file for the Language Server"""
 
-        # Check for config file
-        config_path = os.path.join(self.root_path, self.config)
-        # NOTE: it would be better if we could distinguish between a user-defined
-        # and a default config file. If not user-defined then we can check for
-        # default names, currently only .fortls. If None are found return None
-        # if user-defined config we would want to throw an error if the file
-        # cannot be found
-        if not os.path.isfile(config_path):
+        # Check for config files
+        default_conf_files = [self.config, ".fortlsrc", ".fortls.json", ".fortls"]
+        present_conf_files = [
+            os.path.isfile(os.path.join(self.root_path, f)) for f in default_conf_files
+        ]
+        if not any(present_conf_files):
             return None
 
+        # Load the first config file found
+        for f, present in zip(default_conf_files, present_conf_files):
+            if not present:
+                continue
+            config_path = os.path.join(self.root_path, f)
+            break
+
         try:
             with open(config_path, "r") as jsonfile:
                 config_dict = json5.load(jsonfile)