subedit 0.3.1__tar.gz → 0.3.2__tar.gz

{subedit-0.3.1 → subedit-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: subedit
-Version: 0.3.1
+Version: 0.3.2
 Summary: A linter and formatter for the prose inside code comments, across languages.
 Project-URL: Homepage, https://github.com/mroops0111/subedit
 Project-URL: Repository, https://github.com/mroops0111/subedit
@@ -109,6 +109,8 @@ Rewriting a sentence needs its meaning, which a deterministic process cannot sup
 
 `subedit-hook` runs after every file an agent edits. It repairs the mechanical findings in place, and exits 2 only when a sentence needs rewriting, which hands the message back to the model. In Claude Code a warning reaches the model too, as context beside the tool result, without blocking the edit.
 
+The hook acts only in a project that opts in, with a `subedit.toml` or a `[tool.subedit]` table in `pyproject.toml`, in the edited file's directory or a parent. An empty table is enough. Elsewhere it exits 0 and changes nothing, so a plugin installed for every session stays out of projects that never asked for it. `check` and `fix` run anywhere, with the defaults when no config is found.
+
 ### Claude Code
 
 The plugin needs only [uv](https://docs.astral.sh/uv/). It runs subedit from PyPI with the `vale` extra, and warms that environment in the background when a session starts, so no edit waits on the first download.

{subedit-0.3.1 → subedit-0.3.2}/README.md

@@ -75,6 +75,8 @@ Rewriting a sentence needs its meaning, which a deterministic process cannot sup
 
 `subedit-hook` runs after every file an agent edits. It repairs the mechanical findings in place, and exits 2 only when a sentence needs rewriting, which hands the message back to the model. In Claude Code a warning reaches the model too, as context beside the tool result, without blocking the edit.
 
+The hook acts only in a project that opts in, with a `subedit.toml` or a `[tool.subedit]` table in `pyproject.toml`, in the edited file's directory or a parent. An empty table is enough. Elsewhere it exits 0 and changes nothing, so a plugin installed for every session stays out of projects that never asked for it. `check` and `fix` run anywhere, with the defaults when no config is found.
+
 ### Claude Code
 
 The plugin needs only [uv](https://docs.astral.sh/uv/). It runs subedit from PyPI with the `vale` extra, and warms that environment in the background when a session starts, so no edit waits on the first download.

{subedit-0.3.1 → subedit-0.3.2}/plugins/subedit/.claude-plugin/plugin.json

@@ -1,7 +1,7 @@
 {
   "name": "subedit",
   "displayName": "subedit",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Repairs comment layout silently on write, and returns only what needs rewriting.",
   "author": {
     "name": "mroops0111"

{subedit-0.3.1 → subedit-0.3.2}/plugins/subedit/scripts/run-subedit-hook.sh

@@ -4,10 +4,32 @@
 # because the first run installs subedit and downloads Vale, which no edit should wait on.
 set -uo pipefail
 
-SPEC='subedit[vale]>=0.3.1'
+SPEC='subedit[vale]>=0.3.2'
 # A bare uvx takes the first Python it finds, which on a stock Mac is too old for subedit.
 PYTHON='>=3.11'
 
+# The plugin reaches every session, so it acts only in a project that configures subedit,
+# with a subedit.toml or a [tool.subedit] table in pyproject.toml, here or in a parent directory.
+adopts_subedit() {
+    local directory="$1"
+    while :; do
+        if [ -f "$directory/subedit.toml" ]; then
+            return 0
+        fi
+        if [ -f "$directory/pyproject.toml" ] && grep -q '^\[tool\.subedit[].]' "$directory/pyproject.toml"; then
+            return 0
+        fi
+        if [ "$directory" = / ] || [ -z "$directory" ]; then
+            return 1
+        fi
+        directory=$(dirname "$directory")
+    done
+}
+
+if ! adopts_subedit "${CLAUDE_PROJECT_DIR:-$PWD}"; then
+    exit 0
+fi
+
 if ! command -v uvx >/dev/null 2>&1; then
     cat >&2 <<'MESSAGE'
 subedit needs uv, so comment checks are not running.

{subedit-0.3.1 → subedit-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "subedit"
-version = "0.3.1"
+version = "0.3.2"
 description = "A linter and formatter for the prose inside code comments, across languages."
 authors = [
     {name = "Yun-Tai Yang"},

{subedit-0.3.1 → subedit-0.3.2}/src/subedit/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '0.3.1'
+__version__ = '0.3.2'
 
 __all__ = ['__version__']

{subedit-0.3.1 → subedit-0.3.2}/src/subedit/infrastructure/config_sources/toml_config_source.py

@@ -47,6 +47,10 @@ class TomlConfigSource:
             relative = target.resolve().as_posix()
         return any(fnmatch.fnmatch(relative, pattern) for pattern in patterns)
 
+    def is_adopted(self, path: str) -> bool:
+        """Whether a subedit.toml or a pyproject.toml with [tool.subedit] covers the path, as a project opts in."""
+        return self._locate(pathlib.Path(path)) is not None
+
     def root_for(self, path: str) -> pathlib.Path:
         config_path = self._locate(pathlib.Path(path))
         return config_path.parent if config_path else pathlib.Path.cwd()

{subedit-0.3.1 → subedit-0.3.2}/src/subedit/presentation/hook.py

@@ -45,7 +45,8 @@ def run(payload: Payload, *, write: bool = True) -> HookResult:
         except (OSError, UnicodeDecodeError):
             continue
         language = language_for(source_path)
-        if language is None:
+        # A plugin installed once reaches every project, so only one that configures subedit opts in.
+        if language is None or not DEFAULT_CONFIG_SOURCE.is_adopted(str(source_path)):
             continue
         document = Document(uri=source_path.resolve().as_uri(), text=source_text, language_id=language.language_id)
         fix_result = fixer.run(document, DEFAULT_CONFIG_SOURCE.resolve(str(source_path)))

{subedit-0.3.1 → subedit-0.3.2}/tests/test_hook.py

@@ -31,6 +31,25 @@ def seed(tmp_path: pathlib.Path, body: str, name: str = 'probe.py') -> pathlib.P
     return target
 
 
+def test_a_project_without_subedit_config_is_left_alone(tmp_path: pathlib.Path) -> None:
+    body = MIS_WRAPPED + 'def g():\n    # this one carries no comma and runs on' + ' and on' * 16 + '.\n    pass\n'
+    target = tmp_path / 'probe.py'
+    target.write_text(body, encoding='utf-8')
+
+    hook_result = hook.run(payload(target))
+
+    assert hook_result.exit_code == 0
+    assert target.read_text(encoding='utf-8') == body
+
+
+def test_a_tool_subedit_table_in_pyproject_opts_in(tmp_path: pathlib.Path) -> None:
+    (tmp_path / 'pyproject.toml').write_text('[tool.subedit]\nline-width = 74\n', encoding='utf-8')
+    target = tmp_path / 'probe.py'
+    target.write_text(UNBREAKABLE, encoding='utf-8')
+
+    assert hook.run(payload(target), write=False).is_blocking
+
+
 def test_a_non_edit_tool_is_ignored(tmp_path: pathlib.Path) -> None:
     target = seed(tmp_path, MIS_WRAPPED)
     assert hook.run(payload(target, tool='Read')).exit_code == 0

{subedit-0.3.1 → subedit-0.3.2}/tests/test_plugin.py

@@ -58,20 +58,48 @@ def test_the_wrapper_is_valid_shell() -> None:
     subprocess.run(['bash', '-n', str(WRAPPER)], check=True, capture_output=True)
 
 
-def test_the_wrapper_says_what_to_install_when_nothing_is_found() -> None:
-    completed = subprocess.run(
-        ['bash', str(WRAPPER)],
+def run_wrapper(project: pathlib.Path, *arguments: str) -> subprocess.CompletedProcess[str]:
+    return subprocess.run(
+        ['bash', str(WRAPPER), *arguments],
         check=False,
         capture_output=True,
         text=True,
-        env={'PATH': '/usr/bin:/bin'},
+        env={'PATH': '/usr/bin:/bin', 'CLAUDE_PROJECT_DIR': str(project)},
         input='',
     )
 
+
+def test_the_wrapper_says_what_to_install_when_nothing_is_found(tmp_path: pathlib.Path) -> None:
+    (tmp_path / 'subedit.toml').write_text('[subedit]\n', encoding='utf-8')
+
+    completed = run_wrapper(tmp_path)
+
     assert completed.returncode == 1
     assert 'astral.sh/uv' in completed.stderr, 'a missing command must say how to get it'
 
 
+@pytest.mark.parametrize('arguments', [(), ('prepare',)])
+def test_the_wrapper_stays_out_of_a_project_without_subedit_config(
+    tmp_path: pathlib.Path, arguments: tuple[str, ...]
+) -> None:
+    (tmp_path / 'pyproject.toml').write_text('[tool.ruff]\nline-length = 100\n', encoding='utf-8')
+
+    completed = run_wrapper(tmp_path, *arguments)
+
+    assert (completed.returncode, completed.stderr) == (0, '')
+
+
+@pytest.mark.parametrize('config', [('subedit.toml', '[subedit]\n'), ('pyproject.toml', '[tool.subedit.rules]\n')])
+def test_the_wrapper_acts_in_a_subdirectory_of_a_configured_project(
+    tmp_path: pathlib.Path, config: tuple[str, str]
+) -> None:
+    name, text = config
+    (tmp_path / name).write_text(text, encoding='utf-8')
+    (tmp_path / 'packages').mkdir()
+
+    assert 'astral.sh/uv' in run_wrapper(tmp_path / 'packages').stderr
+
+
 def test_the_wrapper_runs_the_released_version() -> None:
     pyproject = (ROOT / 'pyproject.toml').read_text(encoding='utf-8')
     version = next(line for line in pyproject.splitlines() if line.startswith('version')).split('"')[1]

{subedit-0.3.1 → subedit-0.3.2}/uv.lock

@@ -349,7 +349,7 @@ wheels = [
 
 [[package]]
 name = "subedit"
-version = "0.3.1"
+version = "0.3.2"
 source = { editable = "." }
 dependencies = [
     { name = "autocorrect-py" },