rename silent to no-view (#117)

Author: madhur-tandon

README.md

@@ -84,10 +84,10 @@ To use a different port, use `--port` option.
 $ pyscript run <path_of_folder> --port 9000
 ```
 
-To avoid opening a browser window, use `--silent` option.
+To avoid opening a browser window, use `--no-view` option.
 
 ```shell
-$ pyscript run <path_of_folder> --silent
+$ pyscript run <path_of_folder> --no-view
 ```
 
 ### create

src/pyscript/plugins/run.py

@@ -101,7 +101,7 @@ def run(
     path: Path = typer.Argument(
         Path("."), help="The path of the project that will run."
     ),
-    silent: bool = typer.Option(False, help="Open the app in web browser."),
+    view: bool = typer.Option(True, help="Open the app in web browser."),
     port: int = typer.Option(8000, help="The port that the app will run on."),
 ):
     """
@@ -113,7 +113,7 @@ def run(
         raise cli.Abort(f"Error: Path {str(path)} does not exist.", style="red")
 
     try:
-        start_server(path, not silent, port)
+        start_server(path, view, port)
     except OSError as e:
         if e.errno == 48:
             console.print(

tests/test_run_cli_cmd.py

@@ -52,40 +52,40 @@ def test_run_server_with_default_values(
     assert result.exit_code == 0
     # EXPECT start_server_mock function to be called with the default values:
     # Path("."): path to local folder
-    # show=True: the opposite of the --silent option (which default to False)
+    # show=True: same as passing the --view option (which defaults to True)
     # port=8000: that is the default port
     start_server_mock.assert_called_once_with(Path("."), True, 8000)
 
 
 @mock.patch("pyscript.plugins.run.start_server")
-def test_run_server_with_silent_flag(
+def test_run_server_with_no_view_flag(
     start_server_mock, invoke_cli: CLIInvoker  # noqa: F811
 ):
     """
     Test that when run is called without arguments the command runs with the
     default values
     """
     # GIVEN a call to run without arguments
-    result = invoke_cli("run", "--silent")
+    result = invoke_cli("run", "--no-view")
     # EXPECT the command to succeed
     assert result.exit_code == 0
     # EXPECT start_server_mock function to be called with the default values:
     # Path("."): path to local folder
-    # show=False: the opposite of the --silent option
+    # show=False: same as passing the --no-view option
     # port=8000: that is the default port
     start_server_mock.assert_called_once_with(Path("."), False, 8000)
 
 
 @pytest.mark.parametrize(
     "run_args, expected_values",
     [
-        (("--silent",), (Path("."), False, 8000)),
+        (("--no-view",), (Path("."), False, 8000)),
         ((BASEPATH,), (Path(BASEPATH), True, 8000)),
         (("--port=8001",), (Path("."), True, 8001)),
-        (("--silent", "--port=8001"), (Path("."), False, 8001)),
-        ((BASEPATH, "--silent"), (Path(BASEPATH), False, 8000)),
+        (("--no-view", "--port=8001"), (Path("."), False, 8001)),
+        ((BASEPATH, "--no-view"), (Path(BASEPATH), False, 8000)),
         ((BASEPATH, "--port=8001"), (Path(BASEPATH), True, 8001)),
-        ((BASEPATH, "--silent", "--port=8001"), (Path(BASEPATH), False, 8001)),
+        ((BASEPATH, "--no-view", "--port=8001"), (Path(BASEPATH), False, 8001)),
         ((BASEPATH, "--port=8001"), (Path(BASEPATH), True, 8001)),
     ],
 )