Add 'dump-config' CLI command

Author: Aksem

README.md

@@ -45,7 +45,7 @@ presets = [
 
 ## CLI
 
-In virtualenv of your project you can use the following command:
+1. In virtualenv of your project you can use the following command:
 
 `python -m finecode run [run_options] <list_of_actions> [actions_payload]`
 
@@ -68,6 +68,17 @@ Examples:
 - `python -m finecode --workdir="./finecode_extension_api" run lint check_formatting` ... run `lint` and `check_formatting` sequentially in `finecode_extension_api` directory (project is there)
 - `python -m finecode --project="fine_python_mypy" --project="fine_python_ruff" run lint` ... run `lint` action in projects `fine_python_mypy` and `fine_python_ruff`. They should be discoverable from the working directory.
 
+2. You can dump project config with fully resolved configuration using following command:
+
+`python -m finecode dump-config [--trace] [--project="<project_name>"]`
+
+The result will be saved in `<cwd>/finecode_config_dump/` directory.
+
+Options:
+
+- `--trace` ... activate trace(more detailed) logging
+- `--project` ... by default config of project in current working directory is dumped. If current working directory contains multiple projects and you want to dump config of particular one, provide its name using this option
+
 ## Extensions from FineCode authors
 
 ### Presets

src/finecode/workspace_manager/cli.py

@@ -10,6 +10,7 @@
 from finecode import communication_utils
 from finecode.workspace_manager import logger_utils, user_messages
 from finecode.workspace_manager.cli_app import run as run_cmd
+from finecode.workspace_manager.cli_app import dump_config as dump_config_cmd
 
 
 @click.group()
@@ -168,5 +169,36 @@ def run(ctx) -> None:
         sys.exit(1)
 
 
+@cli.command()
+@click.option("--trace", "trace", is_flag=True, default=False)
+@click.option("--debug", "debug", is_flag=True, default=False)
+@click.option("--project", "project", type=str)
+def dump_config(
+    trace: bool,
+    debug: bool,
+    project: str | None
+):
+    if debug is True:
+        import debugpy
+
+        try:
+            debugpy.listen(5680)
+            debugpy.wait_for_client()
+        except Exception as e:
+            logger.info(e)
+
+    if project is None:
+        click.echo("--project parameter is required", err=True)
+        return
+    
+    logger_utils.init_logger(trace=trace, stdout=True)
+
+    try:
+        asyncio.run(dump_config_cmd.dump_config(workdir_path=pathlib.Path(os.getcwd()), project_name=project))
+    except dump_config_cmd.DumpFailed as exception:
+        click.echo(exception.message, err=True)
+        sys.exit(1)
+
+
 if __name__ == "__main__":
     cli()

src/finecode/workspace_manager/cli_app/dump_config.py

@@ -0,0 +1,56 @@
+import os
+import pathlib
+
+from loguru import logger
+
+from finecode.workspace_manager import context, services
+from finecode.workspace_manager.config import read_configs, dump_configs
+from finecode.workspace_manager.runner import manager as runner_manager
+
+
+class DumpFailed(Exception):
+    def __init__(self, message: str) -> None:
+        self.message = message
+
+
+async def dump_config(workdir_path: pathlib.Path, project_name: str):
+    ws_context = context.WorkspaceContext([workdir_path])
+    # it could be optimized by looking for concrete project instead of all
+    await read_configs.read_projects_in_dir(
+        dir_path=workdir_path, ws_context=ws_context
+    )
+
+    # project is provided. Filter out other projects if there are more, they would
+    # not be used (run can be started in a workspace with also other projects)
+    ws_context.ws_projects = {
+        project_dir_path: project
+        for project_dir_path, project in ws_context.ws_projects.items()
+        if project.name == project_name
+    }
+    
+    # start runner to init project config
+    try:
+        try:
+            await runner_manager.update_runners(ws_context)
+        except runner_manager.RunnerFailedToStart as exception:
+            raise DumpFailed(
+                f"One or more projects are misconfigured, runners for them didn't"
+                f" start: {exception.message}. Check logs for details."
+            )
+
+        # Some tools like IDE extensions for syntax highlighting rely on
+        # file name. Keep file name of config the same and save in subdirectory
+        project_dir_path = list(ws_context.ws_projects.keys())[0]
+        dump_dir_path = project_dir_path / 'finecode_config_dump'
+        dump_file_path = dump_dir_path / 'pyproject.toml'
+        
+        project_raw_config = ws_context.ws_projects_raw_configs[project_dir_path]
+        raw_config_str = dump_configs.dump_config(project_raw_config)
+
+        os.makedirs(dump_dir_path, exist_ok=True)
+        with open(dump_file_path, 'w') as dump_file:
+            dump_file.write(raw_config_str)
+        
+        logger.info(f"Dumped config into {dump_file_path}")
+    finally:
+        services.on_shutdown(ws_context)

src/finecode/workspace_manager/config/dump_configs.py

@@ -0,0 +1,6 @@
+import typing
+import tomlkit
+
+
+def dump_config(config: dict[str, typing.Any]) -> str:
+    return tomlkit.dumps(config)

src/finecode/workspace_manager/config/read_configs.py

@@ -27,6 +27,9 @@ async def read_projects_in_dir(
         if '__testdata__' in def_file_rel_dir_path.parts:
             logger.debug(f"Skip '{def_file}' because it is in test data and it is not a test session")
             continue
+        if def_file.parent.name == 'finecode_config_dump':
+            logger.debug(f"Skip '{def_file}' because it is config dump, not real project config")
+            continue
 
         status = domain.ProjectStatus.READY
         actions: list[domain.Action] | None = None
@@ -63,6 +66,7 @@ async def read_project_config(
     # from it
     if project.def_path.name == "pyproject.toml":
         with open(project.def_path, "rb") as pyproject_file:
+            # TODO: handle error if toml is invalid
             project_def = toml_loads(pyproject_file.read()).value
         # TODO: validate that finecode is installed?