ruff-sync 0.0.1.dev2__tar.gz → 0.0.1.dev4__tar.gz

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/.github/dependabot.yml

@@ -3,7 +3,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "pip" # Documentation: For package managers such as pipenv and poetry, you need to use the pip YAML value.
+  - package-ecosystem: "uv"
     directory: "/" # Location of package manifests
     schedule:
       interval: daily

ruff_sync-0.0.1.dev2/README.md → ruff_sync-0.0.1.dev4/PKG-INFO

@@ -1,12 +1,61 @@
-[![codecov](https://codecov.io/gh/Kilo59/ruff-sync/graph/badge.svg?token=kMZw0XtoFW)](https://codecov.io/gh/Kilo59/ruff-sync)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Kilo59/ruff-sync/main.svg)](https://results.pre-commit.ci/latest/github/Kilo59/ruff-sync/main)
-[![Wily](https://img.shields.io/badge/%F0%9F%A6%8A%20wily-passing-brightgreen.svg)](https://wily.readthedocs.io/)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+Metadata-Version: 2.4
+Name: ruff-sync
+Version: 0.0.1.dev4
+Summary: Synchronize Ruff linter configuration across projects
+Project-URL: Homepage, https://github.com/Kilo59/ruff-sync
+Project-URL: Documentation, https://github.com/Kilo59/ruff-sync#readme
+Project-URL: Repository, https://github.com/Kilo59/ruff-sync
+Project-URL: Issues, https://github.com/Kilo59/ruff-sync/issues
+Project-URL: Changelog, https://github.com/Kilo59/ruff-sync/releases
+Author-email: Gabriel Gore <gabriel59kg@gmail.com>
+License: MIT
+License-File: LICENSE.md
+Keywords: automation,config,linter,linting,python,ruff,synchronize,tomlkit
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: tomlkit<2.0.0,>=0.12.3
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Kilo59/ruff-sync/main/ruff_sync_banner.png" alt="ruff-sync banner" style="max-width: 600px; width: 100%; height: auto; margin-bottom: 1rem;">
+  <br>
+  <a href="https://pypi.org/project/ruff-sync/"><img src="https://img.shields.io/pypi/v/ruff-sync" alt="PyPI version"></a>
+  <a href="https://codecov.io/gh/Kilo59/ruff-sync"><img src="https://codecov.io/gh/Kilo59/ruff-sync/graph/badge.svg?token=kMZw0XtoFW" alt="codecov"></a>
+  <a href="https://results.pre-commit.ci/latest/github/Kilo59/ruff-sync/main"><img src="https://results.pre-commit.ci/badge/github/Kilo59/ruff-sync/main.svg" alt="pre-commit.ci status"></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
+  <a href="https://wily.readthedocs.io/"><img src="https://img.shields.io/badge/%F0%9F%A6%8A%20wily-passing-brightgreen.svg" alt="Wily"></a>
+</p>
 
 # ruff-sync
 
 **Keep your Ruff config consistent across every repo — automatically.**
 
+---
+
+### Table of Contents
+
+- [The Problem](#the-problem)
+- [How It Works](#how-it-works)
+- [Quick Start](#quick-start)
+  - [Install](#install)
+  - [Usage](#usage)
+- [Key Features](#key-features)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+- [License](#license)
+
 `ruff-sync` is a CLI tool that pulls a canonical [Ruff](https://docs.astral.sh/ruff/) configuration from an upstream `pyproject.toml` (hosted anywhere — GitHub, GitLab, a raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
 
 ## The Problem
@@ -61,28 +110,30 @@ No package registry. No publishing step. Just a URL.
 
 ### Install
 
-<!-- ### PyPi Install
+With [uv](https://docs.astral.sh/uv/) (recommended):
 
 ```console
-pip install ruff-sync
-``` -->
+uv tool install ruff-sync
+```
 
-From Git (with [`uv`](https://docs.astral.sh/uv/guides/tools/)):
+With [pipx](https://pipx.pypa.io/stable/):
 
 ```console
-uv tool install git+https://github.com/Kilo59/ruff-sync
+pipx install ruff-sync
 ```
 
-From Git (with [`pipx`](https://pipx.pypa.io/stable/) — recommended):
+With [pip](https://pip.pypa.io/en/stable/):
 
 ```console
-pipx install git+https://github.com/Kilo59/ruff-sync
+pip install ruff-sync
 ```
 
-Or with pip:
+#### From Source (Bleeding Edge)
+
+If you want the latest development version:
 
 ```console
-pip install git+https://github.com/Kilo59/ruff-sync
+uv tool install git+https://github.com/Kilo59/ruff-sync
 ```
 
 ### Usage
@@ -91,26 +142,31 @@ pip install git+https://github.com/Kilo59/ruff-sync
 # Sync from a GitHub URL (blob URLs are auto-converted to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
 
+# Once configured in pyproject.toml (see below), simply run:
+ruff-sync
+
 # Sync into a specific project directory
-ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml --source ./my-project
+ruff-sync --source ./my-project
 
 # Exclude specific sections from being overwritten using dotted paths
-ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml --exclude lint.per-file-ignores lint.ignore
+ruff-sync --exclude lint.per-file-ignores lint.ignore
 ```
 
 ### CLI Reference
 
 ```
-usage: ruff-sync [-h] [--source SOURCE] [--exclude EXCLUDE [EXCLUDE ...]] upstream
+usage: ruff-sync [-h] [--source SOURCE] [--exclude EXCLUDE [EXCLUDE ...]] [-v] [upstream]
 
 positional arguments:
   upstream              The URL to download the pyproject.toml file from.
+                        Optional if defined in [tool.ruff-sync]
 
 optional arguments:
   -h, --help            show this help message and exit
   --source SOURCE       The directory to sync the pyproject.toml file to. Default: .
   --exclude EXCLUDE [EXCLUDE ...]
                         Exclude certain ruff configs. Default: lint.per-file-ignores
+  -v, --verbose         Increase verbosity. -v for INFO, -vv for DEBUG.
 ```
 
 ## Key Features
@@ -126,6 +182,9 @@ You can configure `ruff-sync` itself in your `pyproject.toml`:
 
 ```toml
 [tool.ruff-sync]
+# The source of truth for your ruff configuration
+upstream = "https://github.com/my-org/standards/blob/main/pyproject.toml"
+
 # Use simple names for top-level keys, and dotted paths for nested keys
 exclude = [
     "target-version",          # A top-level key under [tool.ruff]

ruff_sync-0.0.1.dev2/PKG-INFO → ruff_sync-0.0.1.dev4/README.md

@@ -1,24 +1,31 @@
-Metadata-Version: 2.4
-Name: ruff-sync
-Version: 0.0.1.dev2
-Summary: Syncronize ruff linter config settings accross projects
-Author-email: Gabriel Gore <gabriel59kg@gmail.com>
-License: MIT
-License-File: LICENSE.md
-Requires-Python: >=3.10
-Requires-Dist: httpx<1.0.0,>=0.27.0
-Requires-Dist: tomlkit<2.0.0,>=0.12.3
-Description-Content-Type: text/markdown
-
-[![codecov](https://codecov.io/gh/Kilo59/ruff-sync/graph/badge.svg?token=kMZw0XtoFW)](https://codecov.io/gh/Kilo59/ruff-sync)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Kilo59/ruff-sync/main.svg)](https://results.pre-commit.ci/latest/github/Kilo59/ruff-sync/main)
-[![Wily](https://img.shields.io/badge/%F0%9F%A6%8A%20wily-passing-brightgreen.svg)](https://wily.readthedocs.io/)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Kilo59/ruff-sync/main/ruff_sync_banner.png" alt="ruff-sync banner" style="max-width: 600px; width: 100%; height: auto; margin-bottom: 1rem;">
+  <br>
+  <a href="https://pypi.org/project/ruff-sync/"><img src="https://img.shields.io/pypi/v/ruff-sync" alt="PyPI version"></a>
+  <a href="https://codecov.io/gh/Kilo59/ruff-sync"><img src="https://codecov.io/gh/Kilo59/ruff-sync/graph/badge.svg?token=kMZw0XtoFW" alt="codecov"></a>
+  <a href="https://results.pre-commit.ci/latest/github/Kilo59/ruff-sync/main"><img src="https://results.pre-commit.ci/badge/github/Kilo59/ruff-sync/main.svg" alt="pre-commit.ci status"></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
+  <a href="https://wily.readthedocs.io/"><img src="https://img.shields.io/badge/%F0%9F%A6%8A%20wily-passing-brightgreen.svg" alt="Wily"></a>
+</p>
 
 # ruff-sync
 
 **Keep your Ruff config consistent across every repo — automatically.**
 
+---
+
+### Table of Contents
+
+- [The Problem](#the-problem)
+- [How It Works](#how-it-works)
+- [Quick Start](#quick-start)
+  - [Install](#install)
+  - [Usage](#usage)
+- [Key Features](#key-features)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+- [License](#license)
+
 `ruff-sync` is a CLI tool that pulls a canonical [Ruff](https://docs.astral.sh/ruff/) configuration from an upstream `pyproject.toml` (hosted anywhere — GitHub, GitLab, a raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
 
 ## The Problem
@@ -73,28 +80,30 @@ No package registry. No publishing step. Just a URL.
 
 ### Install
 
-<!-- ### PyPi Install
+With [uv](https://docs.astral.sh/uv/) (recommended):
 
 ```console
-pip install ruff-sync
-``` -->
+uv tool install ruff-sync
+```
 
-From Git (with [`uv`](https://docs.astral.sh/uv/guides/tools/)):
+With [pipx](https://pipx.pypa.io/stable/):
 
 ```console
-uv tool install git+https://github.com/Kilo59/ruff-sync
+pipx install ruff-sync
 ```
 
-From Git (with [`pipx`](https://pipx.pypa.io/stable/) — recommended):
+With [pip](https://pip.pypa.io/en/stable/):
 
 ```console
-pipx install git+https://github.com/Kilo59/ruff-sync
+pip install ruff-sync
 ```
 
-Or with pip:
+#### From Source (Bleeding Edge)
+
+If you want the latest development version:
 
 ```console
-pip install git+https://github.com/Kilo59/ruff-sync
+uv tool install git+https://github.com/Kilo59/ruff-sync
 ```
 
 ### Usage
@@ -103,26 +112,31 @@ pip install git+https://github.com/Kilo59/ruff-sync
 # Sync from a GitHub URL (blob URLs are auto-converted to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
 
+# Once configured in pyproject.toml (see below), simply run:
+ruff-sync
+
 # Sync into a specific project directory
-ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml --source ./my-project
+ruff-sync --source ./my-project
 
 # Exclude specific sections from being overwritten using dotted paths
-ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml --exclude lint.per-file-ignores lint.ignore
+ruff-sync --exclude lint.per-file-ignores lint.ignore
 ```
 
 ### CLI Reference
 
 ```
-usage: ruff-sync [-h] [--source SOURCE] [--exclude EXCLUDE [EXCLUDE ...]] upstream
+usage: ruff-sync [-h] [--source SOURCE] [--exclude EXCLUDE [EXCLUDE ...]] [-v] [upstream]
 
 positional arguments:
   upstream              The URL to download the pyproject.toml file from.
+                        Optional if defined in [tool.ruff-sync]
 
 optional arguments:
   -h, --help            show this help message and exit
   --source SOURCE       The directory to sync the pyproject.toml file to. Default: .
   --exclude EXCLUDE [EXCLUDE ...]
                         Exclude certain ruff configs. Default: lint.per-file-ignores
+  -v, --verbose         Increase verbosity. -v for INFO, -vv for DEBUG.
 ```
 
 ## Key Features
@@ -138,6 +152,9 @@ You can configure `ruff-sync` itself in your `pyproject.toml`:
 
 ```toml
 [tool.ruff-sync]
+# The source of truth for your ruff configuration
+upstream = "https://github.com/my-org/standards/blob/main/pyproject.toml"
+
 # Use simple names for top-level keys, and dotted paths for nested keys
 exclude = [
     "target-version",          # A top-level key under [tool.ruff]

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/pyproject.toml

@@ -1,18 +1,40 @@
 [project]
 name = "ruff-sync"
-version = "0.0.1.dev2"
-description = "Syncronize ruff linter config settings accross projects"
+version = "0.0.1.dev4"
+description = "Synchronize Ruff linter configuration across projects"
+keywords = ["ruff", "linter", "config", "synchronize", "python", "linting", "automation", "tomlkit"]
 authors = [
     { name = "Gabriel Gore", email = "gabriel59kg@gmail.com" }
 ]
 license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Quality Assurance",
+]
 dependencies = [
     "httpx>=0.27.0,<1.0.0",
     "tomlkit>=0.12.3,<2.0.0",
 ]
 
+[project.urls]
+Homepage = "https://github.com/Kilo59/ruff-sync"
+Documentation = "https://github.com/Kilo59/ruff-sync#readme"
+Repository = "https://github.com/Kilo59/ruff-sync"
+Issues = "https://github.com/Kilo59/ruff-sync/issues"
+Changelog = "https://github.com/Kilo59/ruff-sync/releases"
+
 [project.scripts]
 ruff-sync = "ruff_sync:main"
 

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/ruff_sync.py

@@ -3,12 +3,12 @@ from __future__ import annotations
 import asyncio
 import logging
 import pathlib
-import warnings
+import sys
 from argparse import ArgumentParser
 from collections.abc import Iterable, Mapping
 from functools import lru_cache
 from io import StringIO
-from typing import Any, Final, Literal, NamedTuple, overload
+from typing import Any, ClassVar, Final, Literal, NamedTuple, overload
 
 import httpx
 import tomlkit
@@ -17,17 +17,40 @@ from tomlkit import TOMLDocument, table
 from tomlkit.items import Table
 from tomlkit.toml_file import TOMLFile
 
-__version__ = "0.0.1.dev0"
+__version__ = "0.0.1.dev4"
 
 _DEFAULT_EXCLUDE: Final[set[str]] = {"lint.per-file-ignores"}
 
 LOGGER = logging.getLogger(__name__)
 
 
+class ColoredFormatter(logging.Formatter):
+    """Logging Formatter to add colors"""
+
+    RESET: ClassVar[str] = "\x1b[0m"
+    COLORS: ClassVar[Mapping[int, str]] = {
+        logging.DEBUG: "\x1b[36m",  # Cyan
+        logging.INFO: "\x1b[32m",  # Green
+        logging.WARNING: "\x1b[33m",  # Yellow
+        logging.ERROR: "\x1b[31m",  # Red
+        logging.CRITICAL: "\x1b[1;31m",  # Bold Red
+    }
+
+    def __init__(self, fmt: str = "%(message)s") -> None:
+        super().__init__(fmt)
+
+    def format(self, record: logging.LogRecord) -> str:  # type: ignore[explicit-override]
+        if sys.stderr.isatty():
+            color = self.COLORS.get(record.levelno, self.RESET)
+            return f"{color}{super().format(record)}{self.RESET}"
+        return super().format(record)
+
+
 class Arguments(NamedTuple):
     upstream: URL
     source: pathlib.Path
     exclude: Iterable[str]
+    verbose: int
 
     @classmethod
     @lru_cache(maxsize=1)
@@ -50,7 +73,7 @@ def get_config(
                 if arg in Arguments.fields():
                     cfg_result[arg] = value
                 else:
-                    warnings.warn(f"Unknown ruff-sync configuration: {arg}", stacklevel=2)
+                    LOGGER.warning(f"Unknown ruff-sync configuration: {arg}")
     return cfg_result
 
 
@@ -62,13 +85,14 @@ def _resolve_source(source: str | pathlib.Path) -> pathlib.Path:
 
 
 def _get_cli_parser() -> ArgumentParser:
-    # TODO: determine if args was provided by user or not
     # https://docs.python.org/3/library/argparse.html#nargs
     parser = ArgumentParser()
     parser.add_argument(
         "upstream",
         type=URL,
-        help="The URL to download the pyproject.toml file from.",
+        nargs="?",
+        help="The URL to download the pyproject.toml file from."
+        " Optional if defined in [tool.ruff-sync].",
     )
     parser.add_argument(
         "--source",
@@ -83,6 +107,13 @@ def _get_cli_parser() -> ArgumentParser:
         help=f"Exclude certain ruff configs. Default: {' '.join(_DEFAULT_EXCLUDE)}",
         default=None,
     )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Increase verbosity. -v for INFO, -vv for DEBUG.",
+    )
     return parser
 
 
@@ -100,8 +131,10 @@ def github_url_to_raw_url(url: URL) -> URL:
         raw_url_str = url_str.replace("github.com", "raw.githubusercontent.com").replace(
             "/blob/", "/"
         )
+        LOGGER.debug(f"Converting GitHub URL to raw content URL: {raw_url_str}")
         return httpx.URL(raw_url_str)
     else:
+        LOGGER.debug("URL is not a GitHub URL, returning as is.")
         return url
 
 
@@ -147,7 +180,7 @@ def get_ruff_tool_table(
     except KeyError:
         if not create_if_missing:
             return None
-        LOGGER.info("No `tool.ruff` section found, creating it.")
+        LOGGER.info("✨ No `tool.ruff` section found, creating it.")
         tool = table(True)
         ruff = table()
         tool.append("ruff", ruff)
@@ -183,7 +216,7 @@ def toml_ruff_parse(toml_s: str, exclude: Iterable[str]) -> TOMLDocument:
     """Parse a TOML string for the tool.ruff section excluding certain ruff configs."""
     ruff_toml: TOMLDocument = tomlkit.parse(toml_s)["tool"]["ruff"]  # type: ignore[index,assignment]
     for section in exclude:
-        LOGGER.info(f"Exluding section `lint.{section}` from ruff config.")
+        LOGGER.info(f"Excluding section `lint.{section}` from ruff config.")
         ruff_toml["lint"].pop(section, None)  # type: ignore[union-attr]
     return ruff_toml
 
@@ -234,6 +267,11 @@ def merge_ruff_toml(
 
     _recursive_update(source_tool_ruff, upstream_ruff_doc)
 
+    # Ensure a newline at the end of the section for better readability.
+    # We only add it if it's missing to avoid triple newlines between sections.
+    if not source_tool_ruff.as_string().endswith("\n\n"):
+        source_tool_ruff.add(tomlkit.nl())
+
     return source
 
 
@@ -241,7 +279,7 @@ async def sync(
     args: Arguments,
 ) -> None:
     """Sync the upstream pyproject.toml file to the source directory."""
-    print("Syncing Ruff...")
+    print("🔄 Syncing Ruff...")
     if args.source.is_file():
         _source_toml_path = args.source
     else:
@@ -261,7 +299,7 @@ async def sync(
         upstream_ruff_toml,
     )
     source_toml_file.write(merged_toml)
-    print(f"Updated {_source_toml_path.resolve().relative_to(pathlib.Path.cwd())}")
+    print(f"✅ Updated {_source_toml_path.resolve().relative_to(pathlib.Path.cwd())}")
 
 
 PARSER: Final[ArgumentParser] = _get_cli_parser()
@@ -271,6 +309,37 @@ def main() -> None:
     args = PARSER.parse_args()
     config = get_config(args.source)
 
+    # Configure logging
+    log_level = {
+        0: logging.WARNING,
+        1: logging.INFO,
+    }.get(args.verbose, logging.DEBUG)
+
+    LOGGER.setLevel(log_level)
+    handler = logging.StreamHandler()
+    handler.setFormatter(ColoredFormatter())
+    LOGGER.addHandler(handler)
+    LOGGER.propagate = False  # Avoid double logging if root is also configured
+
+    # Resolve upstream: use CLI value if explicitly provided, else file config
+    upstream: URL
+    if args.upstream:
+        upstream = args.upstream
+    elif "upstream" in config:
+        config_upstream = config["upstream"]
+        if not isinstance(config_upstream, str):
+            PARSER.error(
+                "❌ upstream in [tool.ruff-sync] must be a string, "
+                f"got {type(config_upstream).__name__}"
+            )
+        upstream = URL(config_upstream)
+        LOGGER.info(f"📂 Using upstream from [tool.ruff-sync]: {upstream}")
+    else:
+        PARSER.error(
+            "❌ the following arguments are required: upstream "
+            "(or define it in [tool.ruff-sync] in pyproject.toml) 💥"
+        )
+
     # Merge exclude: use CLI value if explicitly provided, else file config,
     # else the built-in default.
     exclude: Iterable[str]
@@ -279,19 +348,20 @@ def main() -> None:
         exclude = args.exclude
     elif "exclude" in config:
         exclude = config["exclude"]
-        LOGGER.info(f"Using exclude from [tool.ruff-sync]: {list(exclude)}")
+        LOGGER.info(f"🚫 Using exclude from [tool.ruff-sync]: {list(exclude)}")
     else:
         exclude = _DEFAULT_EXCLUDE
 
     # Convert non-raw github upstream url to the raw equivalent
-    args.upstream = github_url_to_raw_url(args.upstream)
+    upstream = github_url_to_raw_url(upstream)
 
     asyncio.run(
         sync(
             Arguments(
-                upstream=args.upstream,
+                upstream=upstream,
                 source=args.source,
                 exclude=exclude,
+                verbose=args.verbose,
             )
         )
     )

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/scripts/dogfood.sh

@@ -35,7 +35,7 @@ if ! git diff --quiet pyproject.toml; then
 fi
 
 # Run the tool via poetry
-poetry run python ruff_sync.py "$UPSTREAM"
+poetry run python ruff_sync.py "$UPSTREAM" -v
 
 echo ""
 echo "✨ Dogfooding run complete!"

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/tests/test_basic.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import asyncio
 import contextlib
+import logging
 import os
 import pathlib
 import shutil
@@ -65,10 +66,6 @@ def pyproject_toml_s() -> str:
     return s
 
 
-def test_ruff_sync():
-    assert ruff_sync.__version__ == "0.0.1.dev0"
-
-
 @pytest.fixture
 def toml_s() -> str:
     """A sample pyproject.toml file with ruff config."""
@@ -273,7 +270,9 @@ async def test_sync_updates_ruff_config(
     upstream = URL("https://example.com/pyproject.toml")
     upstream_toml = httpx.get(upstream).text  # blocking but doesn't matter
     await ruff_sync.sync(
-        ruff_sync.Arguments(upstream=upstream, source=fake_fs_source, exclude=())
+        ruff_sync.Arguments(
+            upstream=upstream, source=fake_fs_source, exclude=(), verbose=0
+        )
     )
     updated_toml = fake_fs_source.read_text()
     updated_ruff_config: Table = tomlkit.parse(updated_toml)["tool"]["ruff"]  # type: ignore[index,assignment]
@@ -406,6 +405,123 @@ def test_exclude_resolution_default(monkeypatch: pytest.MonkeyPatch):
     assert captured_args[0].exclude == ruff_sync._DEFAULT_EXCLUDE
 
 
+def test_upstream_resolution_cli_precedence(monkeypatch: pytest.MonkeyPatch):
+    """CLI upstream should override config."""
+    captured_args: list[ruff_sync.Arguments] = []
+
+    def mock_sync(args: ruff_sync.Arguments) -> Any:
+        captured_args.append(args)
+        return asyncio.sleep(0)
+
+    monkeypatch.setattr(sys, "argv", ["ruff-sync", "http://cli.com"])
+    monkeypatch.setattr(
+        ruff_sync, "get_config", lambda _: {"upstream": "http://config.com"}
+    )
+    monkeypatch.setattr(ruff_sync, "sync", mock_sync)
+    monkeypatch.setattr(asyncio, "run", lambda _coro: None)
+
+    ruff_sync.main()
+
+    assert len(captured_args) == 1
+    assert str(captured_args[0].upstream) == "http://cli.com"
+
+
+def test_upstream_resolution_missing(
+    monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
+) -> None:
+    """Error when no upstream is provided via CLI or config."""
+    captured_args: list[ruff_sync.Arguments] = []
+
+    def mock_sync(args: ruff_sync.Arguments) -> Any:
+        captured_args.append(args)
+        return asyncio.sleep(0)
+
+    # No CLI upstream argument
+    monkeypatch.setattr(sys, "argv", ["ruff-sync"])
+    # No upstream in config
+    monkeypatch.setattr(ruff_sync, "get_config", lambda _: {})
+    # Ensure sync is never called if upstream is missing
+    monkeypatch.setattr(ruff_sync, "sync", mock_sync)
+    monkeypatch.setattr(asyncio, "run", lambda _coro: None)
+
+    with pytest.raises(SystemExit) as excinfo:
+        ruff_sync.main()
+
+    # Non-zero exit code on failure
+    assert excinfo.value.code != 0
+
+    captured = capsys.readouterr()
+    # Error message should indicate that an upstream is required
+    assert "upstream" in captured.err
+    assert "[tool.ruff-sync]" in captured.err
+
+    # When erroring early, sync must not be invoked
+    assert captured_args == []
+
+
+def test_upstream_resolution_config_precedence(monkeypatch: pytest.MonkeyPatch):
+    """[tool.ruff-sync] upstream should be used if CLI one is missing."""
+    captured_args: list[ruff_sync.Arguments] = []
+
+    def mock_sync(args: ruff_sync.Arguments) -> Any:
+        captured_args.append(args)
+        return asyncio.sleep(0)
+
+    monkeypatch.setattr(sys, "argv", ["ruff-sync"])
+    monkeypatch.setattr(
+        ruff_sync, "get_config", lambda _: {"upstream": "http://config.com"}
+    )
+    monkeypatch.setattr(ruff_sync, "sync", mock_sync)
+    monkeypatch.setattr(asyncio, "run", lambda _coro: None)
+
+    ruff_sync.main()
+
+    assert len(captured_args) == 1
+    assert str(captured_args[0].upstream) == "http://config.com"
+
+
+@pytest.mark.parametrize(
+    ["verbose_count", "expected_level"],
+    [
+        (0, logging.WARNING),
+        (1, logging.INFO),
+        (2, logging.DEBUG),
+        (3, logging.DEBUG),
+    ],
+)
+def test_verbosity_log_level(
+    monkeypatch: pytest.MonkeyPatch, verbose_count: int, expected_level: int
+):
+    """Test that the log level is correctly set based on the verbose count."""
+    captured_args: list[ruff_sync.Arguments] = []
+
+    def mock_sync(args: ruff_sync.Arguments) -> Any:
+        captured_args.append(args)
+        return asyncio.sleep(0)
+
+    argv = ["ruff-sync", "http://example.com"]
+    if verbose_count > 0:
+        argv.append(f"-{'v' * verbose_count}")
+
+    monkeypatch.setattr(sys, "argv", argv)
+    monkeypatch.setattr(ruff_sync, "get_config", lambda _: {})
+    monkeypatch.setattr(ruff_sync, "sync", mock_sync)
+    monkeypatch.setattr(asyncio, "run", lambda _coro: None)
+
+    # Reset LOGGER state before test
+    monkeypatch.setattr(ruff_sync.LOGGER, "level", logging.NOTSET)
+    monkeypatch.setattr(ruff_sync.LOGGER, "handlers", [])
+
+    ruff_sync.main()
+
+    # Verify that the computed log level matches what we expect for this verbosity
+    assert ruff_sync.LOGGER.level == expected_level
+
+    # Verify that the verbose flag value propagates into Arguments.verbose
+    assert len(captured_args) == 1
+    assert captured_args[0].verbose == verbose_count
+
+
 @pytest.mark.asyncio
 async def test_sync_default_exclude(fs: FakeFilesystem):
     """Integration style test for default exclude functionality."""
@@ -431,6 +547,7 @@ target-version = "py311"
                 upstream=URL("https://example.com/pyproject.toml"),
                 source=ff_path,
                 exclude=ruff_sync._DEFAULT_EXCLUDE,
+                verbose=0,
             )
         )
 

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/tests/test_e2e.py

@@ -93,6 +93,7 @@ async def test_ruff_sync(prep_env):
             upstream=prep_env.upstream_url,
             source=prep_env.source_path,
             exclude={},
+            verbose=0,
         )
     )
 

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/tests/test_project.py

@@ -4,13 +4,15 @@ import logging
 import pathlib
 import sys
 from pprint import pformat as pf
-from typing import TYPE_CHECKING, Final
+from typing import TYPE_CHECKING, Any, Final, cast
 
 import pytest
 import tomlkit
 from packaging.version import Version
 from ruamel.yaml import YAML
 
+import ruff_sync
+
 if TYPE_CHECKING:
     from collections.abc import Mapping
 
@@ -62,5 +64,14 @@ def test_pre_commit_versions_are_in_sync(
         )
 
 
+def test_ruff_sync_version_is_in_sync_with_pyproject():
+    """
+    Ensure the version in ruff_sync.py matches the version in pyproject.toml
+    """
+    toml_doc = tomlkit.loads(PYPROJECT_TOML.read_text())
+    pyproject_version = cast("Any", toml_doc)["project"]["version"]
+    assert ruff_sync.__version__ == pyproject_version
+
+
 if __name__ == "__main__":
     pytest.main([__file__, "-vv", "-rEf"])

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/tests/test_whitespace.py

@@ -101,5 +101,27 @@ lint.per-file-ignores = {"__init__.py" = ["F401", "F403"]}
     assert list(per_file_ignores["__init__.py"]) == ["F401", "F403"]
 
 
+def test_merge_adds_newline_at_end():
+    """
+    Test that merging adds a newline at the end of the ruff section if missing.
+    """
+    source_toml_s = """[tool.ruff]
+target-version = "py310"
+"""
+    upstream_ruff_s = """[tool.ruff]
+line-length = 100
+"""
+    source_doc = tomlkit.parse(source_toml_s)
+    upstream_ruff = cast("Any", tomlkit.parse(upstream_ruff_s))["tool"]["ruff"]
+
+    merged_doc = ruff_sync.merge_ruff_toml(source_doc, upstream_ruff)
+    merged_s = merged_doc.as_string()
+
+    print(f"Merged Result:\n{merged_s!r}")
+    # In TOML, sections usually end with a newline.
+    # We want to ensure it ends with \n\n if it's the last section.
+    assert merged_s.endswith("\n\n") or "\n\n[" in merged_s
+
+
 if __name__ == "__main__":
     pytest.main([__file__, "-vv"])

{ruff_sync-0.0.1.dev2 → ruff_sync-0.0.1.dev4}/uv.lock

@@ -990,7 +990,7 @@ wheels = [
 
 [[package]]
 name = "ruff-sync"
-version = "0.0.1.dev2"
+version = "0.0.1.dev4"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },