ruff-sync 0.1.4.dev1__tar.gz → 0.1.5.dev1__tar.gz

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/.agents/TESTING.md

@@ -8,7 +8,7 @@ This document defines the mandatory testing standards and patterns for the `ruff
 - **No Side Effects**: Tests must be isolated and not touch the actual filesystem or make real network calls.
 - **Semantic + Structural Assertions**: When testing TOML merges, always verify **both**:
   1. **Structural/Whitespace**: The file "looks" correct (comments and spacing are preserved).
-  2. **Semantic**: The actual data in the merged result matches the expected values.
+  2. **Semantic**: The actual data in the merged result matches the expected values. Use the [dirty-equals](skills/dirty-equals/SKILL.md) Agent Skill for declarative, concise assertions.
 - **DRY with Fixtures and Parameterization**: Avoid code duplication. Use fixtures for common setups and `@pytest.mark.parametrize` for matrix testing.
 
 ## 2. Tooling and Environment
@@ -130,6 +130,6 @@ def test_my_edge_case():
 
 ## 6. Code Coverage
 
-We target **high coverage** for `ruff_sync.py`.
+We target **high coverage** for `src/ruff_sync/`.
 - Run coverage locally: `uv run coverage run -m pytest -vv && uv run coverage report`
 - New features MUST include unit tests in `tests/test_basic.py` or specialized files like `tests/test_whitespace.py` if they involve formatting logic.

ruff_sync-0.1.5.dev1/.agents/skills/dirty-equals/SKILL.md

@@ -0,0 +1,37 @@
+---
+name: dirty-equals
+description: Use this skill when you need to write declarative, readable, and maintainable assertions in Python tests. It is particularly effective for matching complex data structures, validating merged TOML configurations, and performing fuzzy matching on URLs, file paths, or object types. Use this when the user asks to "assert," "check," "verify," or "match" data in a test, even if they don't explicitly mention "dirty-equals."
+---
+
+# `dirty-equals` Skill
+
+This skill provides patterns and best practices for writing declarative assertions in the `ruff-sync` project using the `dirty-equals` library.
+
+## Overview
+
+Instead of asserting on every field manually, compare against a "dirty" object that matches the expected structure and types.
+
+```python
+from dirty_equals import IsInt, IsPartialDict, IsStr
+
+def test_config_logic():
+    result = {"status": "active", "version": 1, "extra": "data"}
+    # Declarative assertion
+    assert result == IsPartialDict({
+        "status": IsStr(regex="act.*"),
+        "version": IsInt(gt=0),
+    })
+```
+
+## Detailed reference
+
+Check these references for project-specific usage and common matchers:
+
+- **[Common Matchers](references/common-matchers.md)**: Standard `dirty-equals` matchers like `IsPartialDict`, `IsInstance`, and more.
+- **[Specialized Matching](references/toml-matching.md)**: Handling `tomlkit.unwrap()` and `Arguments._asdict()`.
+
+## Best Practices
+
+- **Import Style**: Always use the `from dirty_equals import ...` style at the **module level** of your test files.
+- **Semantic Matching**: Use `dirty-equals` for the semantic part of your test assertions, while using string comparisons or `respx` for structural/whitespace checks where appropriate.
+- **Type Safety**: Prefer `IsInstance(httpx.URL)` or `IsInstance(pathlib.Path)` over custom regex for well-known types in the project.

ruff_sync-0.1.5.dev1/.agents/skills/dirty-equals/references/common-matchers.md

@@ -0,0 +1,51 @@
+# Common `dirty-equals` Matchers
+
+This guide covers the most frequently used `dirty-equals` matchers in the `ruff-sync` project. Standard practice is to import these using the `from` syntax at the module level in test files.
+
+## Structural Matching
+
+- **`IsPartialDict`**: Matches a subset of a dictionary. Essential for verifying specific fields in a larger configuration.
+- **`IsDict`**: Matches an entire dictionary exactly (while still allowing fuzzy values).
+- **`IsList`**: Matches a list, allowing fuzzy matching for elements.
+
+## Type and Instance Matching
+
+- **`IsInstance(type)`**: Matches an object of a specific class. Used for objects like `httpx.URL` or `pathlib.Path`.
+- **`IsStr()`**: Matches any string. Can also specify regex or prefix/suffix.
+- **`IsInt()`**: Matches any integer.
+
+## Examples
+
+### Using `IsPartialDict` and `IsInstance`
+
+```python
+from dirty_equals import IsInstance, IsPartialDict
+import httpx
+import pathlib
+
+# Match a partial dict with mixed types
+assert response_data == IsPartialDict({
+    "url": IsInstance(httpx.URL),
+    "status": "success",
+    "retries": 0,
+})
+```
+
+### String and Path Matching
+
+```python
+from dirty_equals import IsInstance, IsStr
+import pathlib
+
+# Match a path instance
+assert result_path == IsInstance(pathlib.Path)
+
+# Match a string with a specific prefix
+assert error_message == IsStr(regex="^ERROR:.*")
+```
+
+## Logic Matchers
+
+- **`~` (Negation)**: Match values that are *not* the given value (e.g., `assert x == ~IsNone`).
+- **`&` (AND)**: Combine matchers (e.g., `IsInt & IsPositive`).
+- **`|` (OR)**: Combine alternatives.

ruff_sync-0.1.5.dev1/.agents/skills/dirty-equals/references/toml-matching.md

@@ -0,0 +1,54 @@
+# Specialized Matching for `ruff-sync`
+
+This reference covers project-specific data structures where `dirty-equals` matchers require particular preparation for reliable results.
+
+## TOML Matching (`tomlkit`)
+
+`tomlkit` returns proxy objects (containers and items). To reliably match these with `dirty-equals`, always use `.unwrap()` on the parsed document or table to convert it to plain Python types.
+
+### Correct Pattern
+
+```python
+from dirty_equals import IsPartialDict
+import tomlkit
+
+# Parse some TOML
+doc = tomlkit.parse('[tool.ruff]\nline-length = 80')
+
+# Match the tool.ruff section
+ruff_config = doc["tool"]["ruff"]
+
+# Must use .unwrap()
+assert ruff_config.unwrap() == IsPartialDict({"line-length": 80})
+```
+
+### Potential Gotcha
+Direct matching of `tomlkit` proxy objects without `.unwrap()` can fail because `dirty-equals` may see the proxy's internal attributes rather than its data.
+
+## CLI `Arguments` matching
+
+Our CLI arguments are defined as a `NamedTuple`. To match specific fields without validating the entire object, convert it to a dictionary using `._asdict()`.
+
+### Correct Pattern
+
+```python
+from dirty_equals import IsInstance, IsPartialDict
+import httpx
+import pathlib
+import ruff_sync_cli
+
+# Sample Arguments instance
+args = ruff_sync_cli.Arguments(
+    command="pull",
+    upstream=(httpx.URL("https://example.com"),),
+    to=pathlib.Path("."),
+    # ... other defaults ...
+)
+
+# Convert to dict and match specific fields
+assert args._asdict() == IsPartialDict({
+    "command": "pull",
+    "upstream": (IsInstance(httpx.URL),),
+    "to": IsInstance(pathlib.Path),
+})
+```

ruff_sync-0.1.5.dev1/.agents/skills/dirty-equals/trigger_eval.json

@@ -0,0 +1,30 @@
+[
+  {
+    "query": "I need to check if the tool.ruff section was merged correctly",
+    "should_trigger": true
+  },
+  {
+    "query": "add a unit test that verifies the output",
+    "should_trigger": true
+  },
+  {
+    "query": "where should I use dirty-equals",
+    "should_trigger": true
+  },
+  {
+    "query": "verify that this URL is from github.com",
+    "should_trigger": true
+  },
+  {
+    "query": "assert that the dictionary matches this schema",
+    "should_trigger": true
+  },
+  {
+    "query": "fix this syntax error in the CLI",
+    "should_trigger": false
+  },
+  {
+    "query": "run the tests with coverage",
+    "should_trigger": false
+  }
+]

ruff_sync-0.1.5.dev1/.agents/skills/mike/SKILL.md

@@ -0,0 +1,64 @@
+---
+name: mike
+description: Use this skill to manage multiple versions of documentation for MkDocs-powered sites. Deploy new versions, update aliases (like 'latest' or 'stable'), set the default version for the site root, and manage versioned subdirectories in the deployment branch. Use this whenever the user wants to publish, version, or alias documentation, even if they don't explicitly mention "mike". Also use this when the user wants to troubleshoot or debug versioned documentation.
+---
+
+# mike: MkDocs Versioning
+
+`mike` is used in this project to manage a versioned documentation site, allowing side-by-side availability of `dev` (main branch) and stable release docs (e.g., `0.1.4`).
+
+## Prerequisites
+
+`mike` is included in the `docs` dependency group.
+```bash
+# Sync documentation dependencies
+uv sync --group docs
+```
+
+## Project Strategy
+
+This project follows a specific versioning strategy:
+1.  **`dev`**: Represents the current `main` branch.
+2.  **Stable Releases**: Versioned documentation (e.g., `0.1.4`) created upon release.
+3.  **`stable`**: An alias always pointing to the most recent non-dev release.
+
+## Core Workflows
+
+### 1. Deploying Development Docs
+Run this from the `main` branch to update the `dev` version:
+```bash
+mike deploy dev --push --update-aliases
+```
+
+### 2. Deploying a Stable Release
+When a new version is released (e.g., `0.1.4`), deploy it and update the `stable` alias:
+```bash
+# Deploy the specific version and update 'stable'
+mike deploy 0.1.4 stable --push --update-aliases
+
+# Set 'stable' as the default version for the site root
+mike set-default --push stable
+```
+
+## Reference Commands
+
+| Action | Command |
+| :--- | :--- |
+| **Deploy** | `mike deploy <version> [alias]` |
+| **List** | `mike list` |
+| **Set Default** | `mike set-default <version>` |
+| **Alias** | `mike alias <version> <alias>` |
+| **Delete** | `mike delete <identifier>` |
+
+## CI/CD Integration
+
+The deployment logic is automated in [.github/workflows/ci.yaml](.github/workflows/ci.yaml). It automatically:
+- Extracts the version from `pyproject.toml`.
+- Deploys to `dev` if the version contains `.dev`.
+- Deploys to `<version>` and updates `stable` for official releases.
+
+> [!IMPORTANT]
+> **Do NOT** use `mike install-gh-pages`. It is deprecated and removed in the version used by this project. `mike deploy` handles branch initialization automatically.
+
+> [!TIP]
+> Use `mike serve` locally to preview the version switcher before pushing changes.

ruff_sync-0.1.5.dev1/.agents/skills/mike/references/commands.md

@@ -0,0 +1,78 @@
+# Reference: mike CLI commands
+
+Detailed parameter and core command reference for `mike`.
+
+## `deploy`
+
+```bash
+mike deploy [options] <version> [alias]...
+```
+
+Build the documentation for the specified version and commit it to the deployment branch.
+
+- `<version>`: The version name to deploy (e.g., `1.0`, `v1.2.3`).
+- `[alias]`: Optional aliases to point to this version (e.g., `latest`, `stable`).
+
+**Common options:**
+- `-p, --push`: Push the branch to the remote repository.
+- `-b, --branch NAME`: Deployment branch (default: `gh-pages`).
+- `-m, --message MESSAGE`: Custom commit message.
+- `-u, --update-aliases`: Update existing aliases if they already point to a different version.
+- `--alias-type {symlink,redirect,copy}`: Method for creating aliases.
+
+---
+
+## `alias`
+
+```bash
+mike alias [options] <version> <alias>...
+```
+
+Create or update aliases for a version without rebuilding the documentation.
+
+---
+
+## `set-default`
+
+```bash
+mike set-default [options] <version>
+```
+
+Set the default version for the documentation site's root redirect.
+
+---
+
+## `list`
+
+```bash
+mike list [options]
+```
+
+List all versions and aliases deployed to the deployment branch.
+
+---
+
+## `delete`
+
+```bash
+mike delete [options] <identifier>...
+```
+
+Delete one or more versions or aliases.
+
+- `<identifier>`: Version or alias name.
+
+**Options:**
+- `--all`: Delete all versions/aliases.
+
+---
+
+## `serve`
+
+```bash
+mike serve [options]
+```
+
+Locally serve the documentation from the deployment branch. This is for testing the built versioned site.
+
+- `-a, --addr ADDR`: Address to bind to (default: `localhost:8000`).

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/.agents/skills/ruff-sync-usage/SKILL.md

@@ -117,7 +117,7 @@ ruff-sync git@github.com:my-org/standards.git             # SSH (shallow clone)
 
 | Flag | Meaning |
 |------|---------|
-| `--output-format` | `text` (default), `json`, `github` (PR annotations) |
+| `--output-format` | `text` (default), `json`, `github`, `gitlab`, `sarif` (auto-detected in CI) |
 | `--semantic`      | Ignore whitespace/comments in `check` |
 | `--pre-commit`    | Sync `.pre-commit-config.yaml` hook version |
 | `--save`          | Persist CLI args to `pyproject.toml` |

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/.github/workflows/ci.yaml

@@ -134,6 +134,67 @@ jobs:
           echo "Verifying that --semantic check fails for kitchen-sink config (expected failure)..."
           ! ruff-sync check --semantic https://github.com/Kilo59/ruff-sync --path configs/kitchen-sink
 
+  publish-docs:
+    name: Publish Documentation
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [pre-publish]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync --group docs --frozen
+
+      - name: Deploy documentation
+        run: |
+          # Configure git
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # mike deploy handles gh-pages initialization automatically
+
+          # Extract version from pyproject.toml in a TOML-aware way using already installed dependencies
+          VERSION=$(uv run python - << 'PY'
+          import pathlib
+          import tomlkit
+
+          pyproject = pathlib.Path("pyproject.toml")
+          data = tomlkit.parse(pyproject.read_text(encoding="utf-8"))
+
+          # Support both top-level `version` and `[project]` table `version`
+          version = (
+              data.get("project", {}).get("version")
+              or data.get("version")
+          )
+          if not version:
+              raise SystemExit("Version not found in pyproject.toml")
+          print(version)
+          PY
+          )
+          echo "Current Version: $VERSION"
+
+          if [[ "$VERSION" == *".dev"* ]]; then
+            echo "Deploying DEV documentation only..."
+            uv run mike deploy --push --update-aliases dev
+          else
+            echo "Deploying STABLE documentation..."
+            uv run mike deploy --push --update-aliases $VERSION stable
+            uv run mike set-default --push stable
+            # Also update dev to match stable on a full release
+            uv run mike deploy --push --update-aliases dev
+          fi
+
   publish:
     name: Build and publish to PyPI
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
       - id: no-commit-to-branch
         args: [--branch, develop, --branch, main]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.8"
+    rev: "v0.15.9"
     hooks:
       - id: ruff-check
         args: ["--fix"]

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/AGENTS.md

@@ -44,7 +44,7 @@ gh label list                           # See available labels
 
 - **Python** ≥ 3.10 (target version `py310`)
 - **Package Manager**: [uv](https://docs.astral.sh/uv/) — Use `uv run <command>` for all executions to ensure the correct environment.
-- **Linter / Formatter**: [Ruff](https://docs.astral.sh/ruff/) (`^0.15.0`)
+- **Linter / Formatter**: [Ruff](https://docs.astral.sh/ruff/) (`>=0.15.0`)
 - **Type Checker**: [mypy](https://mypy-lang.org/) (strict mode)
 - **Test Framework**: [pytest](https://docs.pytest.org/) with `pytest-asyncio`, `respx`, `pyfakefs` (See [Testing Standards](.agents/TESTING.md))
 - **Coverage**: `coverage` + Codecov
@@ -67,18 +67,35 @@ gh label list                           # See available labels
         ci-integration.md
 src/ruff_sync/         # The application source
   __init__.py          # Public API
-  cli.py               # CLI, merging logic, HTTP
-  __main__.py          # -m support
-tasks.py               # Invoke tasks: lint, fmt, type-check, deps, new-case
+  __main__.py          # CLI entry point (`python -m ruff_sync`)
+  cli.py               # CLI argparse definition and orchestration
+  constants.py         # Project-wide constants and default values
+  core.py              # Core logic for merging, syncing, and repository handling
+  formatters.py        # Logic for CLI output formatting (GitHub, GitLab, etc.)
+  pre_commit.py        # Support for pre-commit hook generation and validation
+tasks.py               # Invoke tasks: lint, fmt, type-check, deps, new-case, release
 pyproject.toml         # Project config, dependencies, ruff/mypy settings
 tests/
+  conftest.py          # Shared pytest fixtures (mocking, temp dirs)
   ruff.toml            # Test-specific ruff overrides (extends ../pyproject.toml)
   test_basic.py        # Unit tests for core functions
+  test_check.py        # Tests for --check mode and drift detection
+  test_ci_integration.py # CI-specific environment tests
+  test_ci_validation.py # Environment variable and CI output detection tests
+  test_config_validation.py # Validation of local configuration
+  test_constants.py    # Tests for internal constants and sentinels
   test_corner_cases.py # Edge case tests for TOML merge logic
-  test_whitespace.py   # Tests for whitespace/comment preservation during merge
+  test_deprecation.py  # Tests for handling of deprecated flags/settings
   test_e2e.py          # End-to-end tests using lifecycle TOML fixtures
+  test_formatters.py   # Serialization and formatting tests
+  test_git_fetch.py    # Mocked git repository fetching tests
+  test_pre_commit.py   # Pre-commit hook generation and sync tests
   test_project.py      # Tests that validate project config consistency
-  test_toml_operations.py  # Tests for low-level TOML operations
+  test_scaffold.py     # Tests for the new-case scaffold task
+  test_serialization.py # Tests for tomlkit serialization edge cases
+  test_toml_operations.py # Tests for low-level TOML operations
+  test_url_handling.py # Tests for GitHub and GitLab URL parsing
+  test_whitespace.py   # Tests for whitespace/comment preservation during merge
   lifecycle_tomls/     # TOML fixture files (*_initial.toml, *_upstream.toml, *_final.toml)
 ```
 
@@ -113,7 +130,7 @@ Use this to make informed decisions rather than blindly suppressing rules.
 uv run ruff format .
 ```
 
-- Line length: **90** characters.
+- Line length: **100** characters.
 - Docstring code formatting is enabled (`docstring-code-format = true`).
 - Preview formatting features are enabled.
 
@@ -207,6 +224,7 @@ Defined in `tasks.py`. **ALWAYS** run these through uv: `uv run invoke <task>`
 | `deps`       | `sync`                | Sync dependencies with uv              |
 | `new-case`   | `new-lifecycle-tomls` | Scaffold lifecycle TOML fixtures       |
 | `docs`       |                       | Build or serve documentation           |
+| `release`    |                       | Tag and create a GitHub release        |
 
 ## CI
 
@@ -223,3 +241,9 @@ CI is defined in `.github/workflows/ci.yaml`:
 3. **Pre-commit ruff version**: The ruff version in `.pre-commit-config.yaml` must stay in sync with the version in `pyproject.toml`. The test `test_pre_commit_versions_are_in_sync` enforces this.
 4. **Keep the ruff-sync-usage skill current**: After any change to CLI behavior (new flags, changed exit codes, new configuration keys, updated URL handling, etc.), update `.agents/skills/ruff-sync-usage/` accordingly. The `SKILL.md` covers quick start, workflows, exit codes, and gotchas. Detailed references live in `references/configuration.md`, `references/troubleshooting.md`, and `references/ci-integration.md`.
 5. **No `autouse=True` fixtures**: NEVER use `autouse=True` for pytest fixtures. All fixtures must be explicitly requested by the test functions that require them. This ensures dependencies are explicit and avoids hidden side effects.
+
+## Browser Tool Usage
+
+- **Prefer `read_url_content`**: If you only need to extract text or markdown from a public URL, use `read_url_content`. It is faster and lighter.
+- **Visual Interaction as Last Resort**: Only use `read_browser_page` or manual screen control when a page requires JavaScript execution, authentication, or complex visual interaction.
+- **Task Specificity**: When using the browser subagent, provide highly specific tasks and clear exit criteria to minimize redundant interactions.

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/CONTRIBUTING.md

@@ -51,6 +51,7 @@ The project uses a `src` layout. All source code lives in `src/ruff_sync/`. Deve
 | `uv run invoke deps` | `sync` | Sync dependencies with uv |
 | `uv run invoke new-case` | `new-lifecycle-tomls` | Scaffold lifecycle TOML test fixtures |
 | `uv run invoke docs` | | Build or serve documentation |
+| `uv run invoke release` | | Tag and create a GitHub release |
 
 ---
 

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ruff-sync
-Version: 0.1.4.dev1
+Version: 0.1.5.dev1
 Summary: Synchronize Ruff linter configuration across projects
 Project-URL: Homepage, https://github.com/Kilo59/ruff-sync
 Project-URL: Documentation, https://kilo59.github.io/ruff-sync/

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/docs/gen_ref_pages.py

@@ -6,7 +6,7 @@ import pathlib
 
 import mkdocs_gen_files
 
-nav = mkdocs_gen_files.Nav()  # type: ignore[attr-defined,no-untyped-call]
+nav = mkdocs_gen_files.Nav()
 
 for path in sorted(pathlib.Path("src").rglob("*.py")):
     module_path = path.relative_to("src").with_suffix("")

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/mkdocs.yml

@@ -25,6 +25,8 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+  version:
+    method: mike
   features:
     - content.code.copy
     - content.tabs.link
@@ -39,6 +41,10 @@ theme:
     - search.share
     - search.suggest
     - toc.follow
+    - navigation.footer
+  font:
+    text: Inter
+    code: JetBrains Mono
   icon:
     repo: fontawesome/brands/github
 
@@ -87,6 +93,8 @@ markdown_extensions:
 
 plugins:
   - search
+  - mike:
+      alias_type: copy
   - gen-files:
       scripts:
         - docs/gen_ref_pages.py

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ruff-sync"
-version = "0.1.4.dev1"
+version = "0.1.5.dev1"
 description = "Synchronize Ruff linter configuration across projects"
 keywords = ["ruff", "linter", "config", "synchronize", "python", "linting", "automation", "tomlkit", "pre-commit"]
 authors = [
@@ -42,6 +42,7 @@ ruff-sync = "ruff_sync:main"
 [dependency-groups]
 dev = [
     "coverage>=7.4.4",
+    "dirty-equals>=0.11",
     "invoke>=2.2.0",
     "mypy>=1.10.0",
     "packaging>=26.0",
@@ -61,6 +62,7 @@ docs = [
     "mkdocs-literate-nav>=0.6.2",
     "mkdocs-material>=9.7.5",
     "mkdocstrings[python]>=1.0.3",
+    "mike>=2.1.2",
 ]
 
 [tool.uv]
@@ -204,6 +206,7 @@ ignore = [
     "PLW1510", # subprocess check not needed in tests
     "PT013", # pytest import style, prevents importing param and or types in from style
     "TC002", # Move third-party import into type-checking block
+    "TID251", # allow cast in tests
 ]
 
 [tool.ruff.lint.pydocstyle]
@@ -220,6 +223,7 @@ docstring-code-line-length = "dynamic"
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 "unittest.mock".msg = "Prefer dedicated libraries to mock at external dependencies, such as `httpx` or `pyfakefs`."
+"typing.cast".msg = "Please fix the underlying type issues instead of using typing.cast."
 
 [tool.ruff.lint.flake8-import-conventions]
 # Declare the banned `from` imports.

{ruff_sync-0.1.4.dev1 → ruff_sync-0.1.5.dev1}/src/ruff_sync/__init__.py

@@ -11,6 +11,7 @@ from .cli import (
     get_config,
     main,
 )
+from .constants import OutputFormat
 from .core import (
     Config,
     FetchResult,
@@ -26,16 +27,19 @@ from .core import (
     to_git_url,
     toml_ruff_parse,
 )
+from .formatters import get_formatter
 
 __all__ = [
     "Arguments",
     "Config",
     "FetchResult",
+    "OutputFormat",
     "RuffConfigFileName",
     "__version__",
     "check",
     "fetch_upstream_config",
     "get_config",
+    "get_formatter",
     "get_ruff_config",
     "get_ruff_tool_table",
     "is_ruff_toml_file",