readability-cli 0.8.3__tar.gz → 0.8.4__tar.gz

{readability_cli-0.8.3 → readability_cli-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: readability-cli
-Version: 0.8.3
+Version: 0.8.4
 Summary: A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format.
 Project-URL: Homepage, https://github.com/owahltinez/readability
 Project-URL: Repository, https://github.com/owahltinez/readability

{readability_cli-0.8.3 → readability_cli-0.8.4}/guides/jsoncstyleguide.md

@@ -123,7 +123,7 @@ Property names must conform to the following guidelines:
 
 * Property names should be meaningful names with defined semantics.
 * Property names must be camel-cased, ascii strings.
-* The first character must be a letter, an underscore (\_) or a dollar sign ($).
+* The first character must be a letter, an underscore (_) or a dollar sign ($).
 * Subsequent characters can be a letter, a digit, an underscore, or a dollar sign.
 * Reserved JavaScript keywords should be avoided (A list of reserved JavaScript keywords can be found below).
 

{readability_cli-0.8.3 → readability_cli-0.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "readability-cli"
-version = "0.8.3"
+version = "0.8.4"
 description = "A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format."
 readme = "README.md"
 requires-python = ">=3.12"

{readability_cli-0.8.3 → readability_cli-0.8.4}/readability.py

@@ -1486,6 +1486,12 @@ def _get_tool_definitions(
     pyrefly_config = _default_config_args(
         project_root, ["pyrefly.toml"], "pyrefly"
     )
+    # An explicit path switches Pyrefly to single-file mode, where the
+    # project's includes, excludes, and project-rooted import resolution are
+    # deliberately ignored. A directory backed by project-owned settings is
+    # a project check, so let Pyrefly discover its files from that config.
+    pyrefly_project_mode = path.is_dir() and not pyrefly_config
+    pyrefly_targets = [] if pyrefly_project_mode else [path_str]
     biome_config = []
     if not any(
         (project_root / filename).exists()
@@ -1552,7 +1558,13 @@ def _get_tool_definitions(
         {
             # Type checker only: it reports findings but cannot fix or format
             "name": "pyrefly",
-            "check": [*pyrefly, "check", *pyrefly_config, path_str],
+            "check": [
+                *pyrefly,
+                "check",
+                *pyrefly_config,
+                *pyrefly_targets,
+            ],
+            **({"cwd": project_root} if pyrefly_project_mode else {}),
             "trigger": ["pyproject.toml", "pyrefly.toml"],
             "extensions": [".py"],
         },
@@ -1668,6 +1680,7 @@ def _run_tool(
     logger.info("Running %s...", tool_name)
 
     report = CheckReport()
+    cwd = tool_config.get("cwd")
     try:
         if fix:
             # Formatters rewrite files, fixers apply what they can. Both
@@ -1676,11 +1689,11 @@ def _run_tool(
             # and report what they could not deal with.
             for phase in ("format", "fix"):
                 if phase in tool_config:
-                    result = _capture_tool_command(tool_config[phase])
+                    result = _capture_tool_command(tool_config[phase], cwd=cwd)
                     if _tool_checked_files(tool_name, result):
                         report.ran.add(tool_name)
         elif "check_format" in tool_config:
-            result = _capture_tool_command(tool_config["check_format"])
+            result = _capture_tool_command(tool_config["check_format"], cwd=cwd)
             if _tool_checked_files(tool_name, result):
                 report.ran.add(tool_name)
             # gofmt reports by naming files rather than by exit code
@@ -1694,7 +1707,7 @@ def _run_tool(
                 )
 
         if "check" in tool_config:
-            result = _capture_tool_command(tool_config["check"])
+            result = _capture_tool_command(tool_config["check"], cwd=cwd)
             if _tool_checked_files(tool_name, result):
                 report.ran.add(tool_name)
             if result.returncode != 0:
@@ -1733,11 +1746,15 @@ def _tool_checked_files(
     return not any(summary in output for summary in zero_file_summaries)
 
 
-def _capture_tool_command(cmd: list[str]) -> subprocess.CompletedProcess:
+def _capture_tool_command(
+    cmd: list[str], cwd: Path | None = None
+) -> subprocess.CompletedProcess:
     """Run a tool and capture what it said, whatever its exit code.
 
     Args:
         cmd: The command list to execute.
+        cwd: Directory in which the tool should run. Defaults to the caller's
+            current working directory.
 
     Returns:
         The completed process, including captured output and its exit code.
@@ -1753,6 +1770,7 @@ def _capture_tool_command(cmd: list[str]) -> subprocess.CompletedProcess:
         text=True,
         check=False,
         timeout=DEFAULT_TIMEOUT,
+        cwd=cwd,
     )
 
 

{readability_cli-0.8.3 → readability_cli-0.8.4}/test_readability.py

@@ -459,6 +459,36 @@ def test_check_command_pyrefly(
     assert ["pyrefly", "check", "--config", cfg, "script.py"] in called_cmds
 
 
+@patch("shutil.which")
+@patch("subprocess.run")
+def test_check_command_runs_configured_directory_as_pyrefly_project(
+    mock_run: MagicMock, mock_which: MagicMock, tmp_path: Path
+) -> None:
+    """The CLI lets project-owned includes and excludes select Python files."""
+    mock_which.side_effect = lambda name: name if name == "pyrefly" else None
+    mock_run.return_value = MagicMock(returncode=0, stdout="", stderr="")
+
+    runner = CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        Path("pyrefly.toml").write_text(
+            'project-excludes = ["**/excluded.py"]\n'
+        )
+        Path("main.py").touch()
+        project_root = Path.cwd()
+
+        result = runner.invoke(cli, ["check", "."])
+
+    assert result.exit_code == 0
+    pyrefly_calls = [
+        invocation
+        for invocation in mock_run.call_args_list
+        if invocation.args[0][0] == "pyrefly"
+    ]
+    assert len(pyrefly_calls) == 1
+    assert pyrefly_calls[0].args[0] == ["pyrefly", "check"]
+    assert pyrefly_calls[0].kwargs["cwd"] == project_root
+
+
 def test_has_project_config(tmp_path: Path) -> None:
     """Tests project config detection via dedicated files and pyproject.
 
@@ -514,6 +544,58 @@ def test_default_configs_omitted_when_project_configured(
         assert "--config-path" not in tools["biome"][command]
 
 
+def test_pyrefly_uses_project_mode_only_for_configured_directories(
+    tmp_path: Path,
+) -> None:
+    """Directories use config discovery while explicit files stay explicit."""
+    (tmp_path / "pyrefly.toml").write_text(
+        'project-excludes = ["**/excluded.py"]\n'
+    )
+    py_file = tmp_path / "main.py"
+    py_file.touch()
+
+    with patch("shutil.which", side_effect=lambda name: name):
+        directory_tools = {
+            tool["name"]: tool
+            for tool in _get_tool_definitions(tmp_path, tmp_path)
+        }
+        file_tools = {
+            tool["name"]: tool
+            for tool in _get_tool_definitions(py_file, tmp_path)
+        }
+
+    assert directory_tools["pyrefly"]["check"] == ["pyrefly", "check"]
+    assert directory_tools["pyrefly"]["cwd"] == tmp_path
+    assert file_tools["pyrefly"]["check"] == [
+        "pyrefly",
+        "check",
+        str(py_file),
+    ]
+    assert "cwd" not in file_tools["pyrefly"]
+
+
+def test_pyrefly_bundled_config_keeps_an_explicit_directory(
+    tmp_path: Path,
+) -> None:
+    """Project mode cannot use a config rooted in the installed package."""
+    (tmp_path / "main.py").touch()
+
+    with patch("shutil.which", side_effect=lambda name: name):
+        tools = {
+            tool["name"]: tool
+            for tool in _get_tool_definitions(tmp_path, tmp_path)
+        }
+
+    assert tools["pyrefly"]["check"] == [
+        "pyrefly",
+        "check",
+        "--config",
+        str(_bundled_config("pyrefly")),
+        str(tmp_path),
+    ]
+    assert "cwd" not in tools["pyrefly"]
+
+
 def test_biome_bundled_config_is_injected_into_every_command(
     tmp_path: Path,
 ) -> None:

{readability_cli-0.8.3 → readability_cli-0.8.4}/uv.lock

@@ -194,7 +194,7 @@ wheels = [
 
 [[package]]
 name = "readability-cli"
-version = "0.8.3"
+version = "0.8.4"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4" },