🐛 Default to save the document if source path is remote.

Author: rafalkrupinski

src/lapidary/render/cli.py

@@ -19,12 +19,16 @@ def app(verbose: bool) -> None:
 @click.argument('document')
 @click.argument('project_root', type=click.Path(path_type=Path, exists=False, file_okay=False, dir_okay=True))
 @click.argument('package_name')
-@click.option('--save/--no-save', help='Copy the document in the project', default=False)
+@click.option(
+    '--save/--no-save',
+    help="Copy the document in the project. The default is to save if it's a remote path",
+    default=None,
+)
 def init(
     document: str,
     project_root: Path,
     package_name: str,
-    save: bool = False,
+    save: bool | None,
 ):
     """Initialize a new project.
 

src/lapidary/render/main.py

@@ -18,7 +18,7 @@ def init_project(
     document_path: str,
     project_root: Path,
     package_name: str,
-    save_document: bool,
+    save_document: bool | None,
 ) -> None:
     """Create project directory and pyproject file, download or copy the OpenAPI document"""
 
@@ -29,6 +29,10 @@ def init_project(
 
     document_handler = document_handler_for(Path(), document_path)
 
+    if save_document is None and document_handler.is_url:
+        # default is save if document is remote
+        save_document = True
+
     if save_document:
         document_root = Path('lapidary/openapi')
         target_dir = project_root / document_root
@@ -49,7 +53,7 @@ def init_project(
             else:
                 config_document_path = document_path
         else:
-            config_document_path = None
+            config_document_path = document_path
 
     config = Config(
         # if path is not URL and not saving the file

tests/test_cli.py

@@ -1,6 +1,5 @@
 from pathlib import Path
 
-import pytest
 from click.testing import CliRunner
 
 from lapidary.render.config import load_config
@@ -54,4 +53,4 @@ def test_init_url_saves_origin(tmp_path: Path) -> None:
 
     config = load_config(output)
     assert str(config.origin) == source
-    assert config.document_path is None
+    assert config.document_path == 'lapidary/openapi/openapi.json'