ruff-sync 0.1.0.dev2__tar.gz → 0.1.2.dev1__tar.gz

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/.pre-commit-config.yaml

@@ -7,12 +7,16 @@ repos:
       - id: check-yaml
         args: ["--unsafe"]
         exclude: .agents/skills/mkdocs-generation/templates/mkdocs.yml
+      - id: check-toml
+      - id: check-case-conflict
       - id: end-of-file-fixer
       - id: trailing-whitespace
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
       - id: no-commit-to-branch
         args: [--branch, develop, --branch, main]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.5"
+    rev: "v0.15.6"
     hooks:
       - id: ruff-check
         args: ["--fix"]

ruff_sync-0.1.2.dev1/.pre-commit-hooks.yaml

@@ -0,0 +1,15 @@
+- id: ruff-sync-pull
+  name: ruff-sync-pull
+  description: Pull and apply upstream ruff configuration.
+  entry: ruff-sync pull
+  language: python
+  files: ^(\.ruff\.toml|ruff\.toml|pyproject\.toml)$
+  pass_filenames: false
+
+- id: ruff-sync-check
+  name: ruff-sync-check
+  description: Check if ruff configuration is in sync with upstream.
+  entry: ruff-sync check --semantic
+  language: python
+  files: ^(\.ruff\.toml|ruff\.toml|pyproject\.toml)$
+  pass_filenames: false

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/AGENTS.md

@@ -87,7 +87,7 @@ uv run ruff check . --fix
 - Tests have additional overrides in `tests/ruff.toml` (extends the root config).
 - All Python files must include `from __future__ import annotations` (enforced by isort rule `I002`).
 - Use `uv run ruff check . --fix` to auto-fix issues. Use `--unsafe-fixes` only if explicitly asked.
-- **Do NOT disable or ignore rules** unless the user explicitly asks you to.
+- **Do NOT disable or ignore rules** unless the user explicitly asks you to. You must **fix the underlying code** to pass the linter, rather than appending `# noqa` directives or adding rules to `ignore` in `pyproject.toml`.
 
 #### Understanding a Rule
 

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ruff-sync
-Version: 0.1.0.dev2
+Version: 0.1.2.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/
@@ -54,6 +54,7 @@ Description-Content-Type: text/markdown
 - [Quick Start](#quick-start)
 - [Key Features](#key-features)
 - [Configuration](#configuration)
+- [Pre-commit Integration](#pre-commit-integration)
 - [CI Integration](#ci-integration)
 - [Example Workflow](#example-workflow)
 - [Detailed Check Logic](#detailed-check-logic)
@@ -132,33 +133,60 @@ pip install ruff-sync
 
 ### Usage
 
+**The Basic Sync**
+
 ```console
-# Sync from a GitHub/GitLab repository (root or specific directory)
+# Pull rules from a central repository into your current project
 ruff-sync https://github.com/my-org/standards
-ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
+```
+
+**Persistent Configuration**
+
+```console
+# If configured in pyproject.toml (see Configuration), simply run:
+ruff-sync
+```
+
+**Initializing a New Project**
 
-# Or a direct blob/file URL (auto-converts to raw)
+```console
+# Scaffold a new pyproject.toml if your directory is empty
+ruff-sync https://github.com/my-org/standards --init
+```
+
+**Syncing Subdirectories or Specific Files**
+
+```console
+ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
+```
 
-# Clone from any git repository (using SSH or HTTP, defaults to --depth 1)
-# You can use the --branch flag to specify a branch (default: main)
+**Using Git (SSH/HTTP)**
+
+```console
+# Clones efficiently (depth 1, blob:none) to extract the config
 ruff-sync git@github.com:my-org/standards.git
-ruff-sync ssh://git@gitlab.com/my-org/standards.git
+```
 
-# Or if configured in pyproject.toml (see Configuration), simply run:
-ruff-sync
+**Excluding Specific Rules**
 
+```console
 # Exclude specific sections from being overwritten using dotted paths
-ruff-sync --exclude lint.per-file-ignores lint.ignore
+ruff-sync --exclude lint.ignore
+```
+
+**Checking for Drift (CI)**
 
-# Check if your local config is in sync (useful in CI)
+```console
+# Verify local config matches upstream. Exits 1 if config is out of sync.
+# If opted in via --pre-commit, exits 2 if only the pre-commit hook is out of sync.
 ruff-sync check https://github.com/my-org/standards
 
-# Semantic check — ignore cosmetic differences like comments and whitespace
+# Semantic check — ignores cosmetic differences like comments and whitespace
 ruff-sync check --semantic
 ```
 
-Run `ruff-sync --help` for full details on all available options.
+See the [Usage documentation](https://kilo59.github.io/ruff-sync/usage/) for more detailed examples and advanced workflows.
 
 ## Key Features
 
@@ -171,6 +199,7 @@ Run `ruff-sync --help` for full details on all available options.
 - 🌍 **Works with any host** — GitHub, GitLab, Bitbucket, private SSH servers, or any raw URL that serves a `pyproject.toml` or `ruff.toml`.
 - 🤖 **CI-ready `check` command** — Verify that your local config is in sync without modifying anything. Exits 1 if out of sync, making it perfect for pre-merge gates. ([See detailed logic](#detailed-check-logic))
 - 🧠 **Semantic mode** — Use `--semantic` to ignore cosmetic differences (comments, whitespace) and only fail on real value changes.
+- 🔗 **Pre-commit hook sync** — Use `--pre-commit` to automatically keep your `ruff-pre-commit` hook version in `.pre-commit-config.yaml` matching your project's Ruff version.
 
 ## Configuration
 
@@ -181,6 +210,9 @@ You can configure `ruff-sync` itself in your `pyproject.toml`:
 # The source of truth for your Ruff configuration
 upstream = "https://github.com/my-org/standards"
 
+# Automatically sync the pre-commit Ruff hook version
+pre-commit-version-sync = true
+
 # Use simple names for top-level keys, and dotted paths for nested keys
 exclude = [
     "target-version",                      # Top-level [tool.ruff] key — projects target different Python versions
@@ -215,14 +247,30 @@ exclude = [
 # The branch, tag, or commit hash to use when resolving a Git repository URL. (Default: "main")
 branch = "develop"
 
-# A directory prefix to use when looking for a configuration file in a repository. (Default: "")
+# The directory path within the repository where the config is located. (Default: "")
 # Useful if the upstream config is not at the repository root.
 path = "config/ruff"
 
 # The local target directory or file to sync into. (Default: ".")
 to = "."
+
+# Keep the pre-commit Ruff hook version in sync with the project's Ruff version. (Default: false)
+pre-commit-version-sync = true
 ```
 
+## Pre-commit Integration
+
+Ensure your configuration is always in sync before every commit. Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/Kilo59/ruff-sync
+  rev: v0.1.0  # Use the latest version
+  hooks:
+    - id: ruff-sync-check
+```
+
+See the [Pre-commit Guide](https://kilo59.github.io/ruff-sync/pre-commit/) for more details.
+
 ## CI Integration
 
 The `check` command is designed for use in CI pipelines. Add it as a step to catch config drift before it merges:
@@ -252,6 +300,10 @@ $ ruff-sync check --semantic
    ]
 ```
 
+> [!TIP]
+> See the [Best Practices](https://kilo59.github.io/ruff-sync/best-practices/) guide for recommendations on whether to make your CI checks blocking or informational.
+
+
 ## Example Workflow
 
 A typical setup for an organization:
@@ -319,7 +371,7 @@ By default, `ruff-sync` requires an existing configuration file (`pyproject.toml
 
 ```console
 # Create a new pyproject.toml (or ruff.toml) pre-configured with upstream settings
-ruff-sync pull https://github.com/my-org/standards --init
+ruff-sync https://github.com/my-org/standards --init
 ```
 
 `ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your local target is a directory, it will look for configuration files in the following order: `ruff.toml` -> `.ruff.toml` -> `pyproject.toml`. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
@@ -349,18 +401,25 @@ flowchart TD
 
     Merge --> Comparison
 
-    CompareVal --> ResultNode{Match?}
+    CompareVal --> ResultNode{Ruff Sync Match?}
     CompareFull --> ResultNode
 
-    ResultNode -- Yes --> Success([Exit 0: In Sync])
+    ResultNode -- Yes --> PCNode{--pre-commit?}
+    PCNode -- Yes --> CheckPC[Check pre-commit hook version]
+    CheckPC -- Match --> Success([Exit 0: In Sync])
+    CheckPC -- Mismatch --> PCOut([Exit 2: Pre-commit Out of Sync])
+    PCNode -- No --> Success
+
     ResultNode -- No --> Diff[Generate Diff]
-    Diff --> Fail([Exit 1: Out of Sync])
+    Diff --> Fail([Exit 1: Ruff Config Out of Sync])
 
     %% Styling
     style Start fill:#4a90e2,color:#fff,stroke:#357abd
     style Success fill:#48c774,color:#fff,stroke:#36975a
     style Fail fill:#f14668,color:#fff,stroke:#b2334b
+    style PCOut fill:#ff9800,color:#fff,stroke:#e65100
     style ResultNode fill:#ffdd57,color:#4a4a4a,stroke:#d4b106
+    style PCNode fill:#ffdd57,color:#4a4a4a,stroke:#d4b106
     style Comparison fill:none,stroke:#9e9e9e,stroke-dasharray: 5 5,stroke-width:2px
     style SemanticNode fill:#f4f4f4,color:#363636,stroke:#dbdbdb
 ```

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/README.md

@@ -23,6 +23,7 @@
 - [Quick Start](#quick-start)
 - [Key Features](#key-features)
 - [Configuration](#configuration)
+- [Pre-commit Integration](#pre-commit-integration)
 - [CI Integration](#ci-integration)
 - [Example Workflow](#example-workflow)
 - [Detailed Check Logic](#detailed-check-logic)
@@ -101,33 +102,60 @@ pip install ruff-sync
 
 ### Usage
 
+**The Basic Sync**
+
 ```console
-# Sync from a GitHub/GitLab repository (root or specific directory)
+# Pull rules from a central repository into your current project
 ruff-sync https://github.com/my-org/standards
-ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
+```
+
+**Persistent Configuration**
+
+```console
+# If configured in pyproject.toml (see Configuration), simply run:
+ruff-sync
+```
+
+**Initializing a New Project**
 
-# Or a direct blob/file URL (auto-converts to raw)
+```console
+# Scaffold a new pyproject.toml if your directory is empty
+ruff-sync https://github.com/my-org/standards --init
+```
+
+**Syncing Subdirectories or Specific Files**
+
+```console
+ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
+```
 
-# Clone from any git repository (using SSH or HTTP, defaults to --depth 1)
-# You can use the --branch flag to specify a branch (default: main)
+**Using Git (SSH/HTTP)**
+
+```console
+# Clones efficiently (depth 1, blob:none) to extract the config
 ruff-sync git@github.com:my-org/standards.git
-ruff-sync ssh://git@gitlab.com/my-org/standards.git
+```
 
-# Or if configured in pyproject.toml (see Configuration), simply run:
-ruff-sync
+**Excluding Specific Rules**
 
+```console
 # Exclude specific sections from being overwritten using dotted paths
-ruff-sync --exclude lint.per-file-ignores lint.ignore
+ruff-sync --exclude lint.ignore
+```
+
+**Checking for Drift (CI)**
 
-# Check if your local config is in sync (useful in CI)
+```console
+# Verify local config matches upstream. Exits 1 if config is out of sync.
+# If opted in via --pre-commit, exits 2 if only the pre-commit hook is out of sync.
 ruff-sync check https://github.com/my-org/standards
 
-# Semantic check — ignore cosmetic differences like comments and whitespace
+# Semantic check — ignores cosmetic differences like comments and whitespace
 ruff-sync check --semantic
 ```
 
-Run `ruff-sync --help` for full details on all available options.
+See the [Usage documentation](https://kilo59.github.io/ruff-sync/usage/) for more detailed examples and advanced workflows.
 
 ## Key Features
 
@@ -140,6 +168,7 @@ Run `ruff-sync --help` for full details on all available options.
 - 🌍 **Works with any host** — GitHub, GitLab, Bitbucket, private SSH servers, or any raw URL that serves a `pyproject.toml` or `ruff.toml`.
 - 🤖 **CI-ready `check` command** — Verify that your local config is in sync without modifying anything. Exits 1 if out of sync, making it perfect for pre-merge gates. ([See detailed logic](#detailed-check-logic))
 - 🧠 **Semantic mode** — Use `--semantic` to ignore cosmetic differences (comments, whitespace) and only fail on real value changes.
+- 🔗 **Pre-commit hook sync** — Use `--pre-commit` to automatically keep your `ruff-pre-commit` hook version in `.pre-commit-config.yaml` matching your project's Ruff version.
 
 ## Configuration
 
@@ -150,6 +179,9 @@ You can configure `ruff-sync` itself in your `pyproject.toml`:
 # The source of truth for your Ruff configuration
 upstream = "https://github.com/my-org/standards"
 
+# Automatically sync the pre-commit Ruff hook version
+pre-commit-version-sync = true
+
 # Use simple names for top-level keys, and dotted paths for nested keys
 exclude = [
     "target-version",                      # Top-level [tool.ruff] key — projects target different Python versions
@@ -184,14 +216,30 @@ exclude = [
 # The branch, tag, or commit hash to use when resolving a Git repository URL. (Default: "main")
 branch = "develop"
 
-# A directory prefix to use when looking for a configuration file in a repository. (Default: "")
+# The directory path within the repository where the config is located. (Default: "")
 # Useful if the upstream config is not at the repository root.
 path = "config/ruff"
 
 # The local target directory or file to sync into. (Default: ".")
 to = "."
+
+# Keep the pre-commit Ruff hook version in sync with the project's Ruff version. (Default: false)
+pre-commit-version-sync = true
 ```
 
+## Pre-commit Integration
+
+Ensure your configuration is always in sync before every commit. Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/Kilo59/ruff-sync
+  rev: v0.1.0  # Use the latest version
+  hooks:
+    - id: ruff-sync-check
+```
+
+See the [Pre-commit Guide](https://kilo59.github.io/ruff-sync/pre-commit/) for more details.
+
 ## CI Integration
 
 The `check` command is designed for use in CI pipelines. Add it as a step to catch config drift before it merges:
@@ -221,6 +269,10 @@ $ ruff-sync check --semantic
    ]
 ```
 
+> [!TIP]
+> See the [Best Practices](https://kilo59.github.io/ruff-sync/best-practices/) guide for recommendations on whether to make your CI checks blocking or informational.
+
+
 ## Example Workflow
 
 A typical setup for an organization:
@@ -288,7 +340,7 @@ By default, `ruff-sync` requires an existing configuration file (`pyproject.toml
 
 ```console
 # Create a new pyproject.toml (or ruff.toml) pre-configured with upstream settings
-ruff-sync pull https://github.com/my-org/standards --init
+ruff-sync https://github.com/my-org/standards --init
 ```
 
 `ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your local target is a directory, it will look for configuration files in the following order: `ruff.toml` -> `.ruff.toml` -> `pyproject.toml`. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
@@ -318,18 +370,25 @@ flowchart TD
 
     Merge --> Comparison
 
-    CompareVal --> ResultNode{Match?}
+    CompareVal --> ResultNode{Ruff Sync Match?}
     CompareFull --> ResultNode
 
-    ResultNode -- Yes --> Success([Exit 0: In Sync])
+    ResultNode -- Yes --> PCNode{--pre-commit?}
+    PCNode -- Yes --> CheckPC[Check pre-commit hook version]
+    CheckPC -- Match --> Success([Exit 0: In Sync])
+    CheckPC -- Mismatch --> PCOut([Exit 2: Pre-commit Out of Sync])
+    PCNode -- No --> Success
+
     ResultNode -- No --> Diff[Generate Diff]
-    Diff --> Fail([Exit 1: Out of Sync])
+    Diff --> Fail([Exit 1: Ruff Config Out of Sync])
 
     %% Styling
     style Start fill:#4a90e2,color:#fff,stroke:#357abd
     style Success fill:#48c774,color:#fff,stroke:#36975a
     style Fail fill:#f14668,color:#fff,stroke:#b2334b
+    style PCOut fill:#ff9800,color:#fff,stroke:#e65100
     style ResultNode fill:#ffdd57,color:#4a4a4a,stroke:#d4b106
+    style PCNode fill:#ffdd57,color:#4a4a4a,stroke:#d4b106
     style Comparison fill:none,stroke:#9e9e9e,stroke-dasharray: 5 5,stroke-width:2px
     style SemanticNode fill:#f4f4f4,color:#363636,stroke:#dbdbdb
 ```

ruff_sync-0.1.2.dev1/configs/data-science-engineering/ruff.toml

@@ -0,0 +1,25 @@
+# configs/data-science-engineering/ruff.toml
+
+# Enable Jupyter notebook linting
+extend-include = ["*.ipynb"]
+extend-exclude = [".ipynb_checkpoints"]
+
+[lint]
+# Enable rules tailored for data science and engineering.
+extend-select = [
+    # https://docs.astral.sh/ruff/rules/#isort-i
+    "I",      # isort: Import sorting
+    # https://docs.astral.sh/ruff/rules/#numpy-specific-rules-npy
+    "NPY",    # NumPy-specific rules: NumPy conventions
+    # https://docs.astral.sh/ruff/rules/#pandas-vet-pd
+    "PD",     # pandas-vet: Pandas code checks
+]
+# Ignore rules that conflict with `ruff format` (formatter-managed concerns).
+# Keep this in sync with other curated configs (e.g. fastapi/ruff.toml).
+ignore = [
+    "E111",  # indentation is handled by the formatter
+    "E114",  # indentation with comments is handled by the formatter
+    "E117",  # over-indented code is handled by the formatter
+    "E501",  # line length is handled by the formatter
+    "W191",  # tabs vs spaces is handled by the formatter
+]

ruff_sync-0.1.2.dev1/docs/best-practices.md

@@ -0,0 +1,79 @@
+# Best Practices
+
+When managing linter configurations across multiple projects with `ruff-sync`, following these best practices helps ensure a smooth, predictable, and manageable workflow for your entire organization.
+
+---
+
+## 📌 Pin Upstream Versions
+
+Instead of syncing directly from the `main` branch, it can be beneficial to **pin to specific tags, releases, or stable branches**.
+
+Linting rules evolve. If you sync from `main`, a new rule added to the central repository could instantly break CI across dozens of downstream projects the next time they run `ruff-sync` in an automated pipeline.
+
+Instead, configure your upstream like this:
+
+```toml
+[tool.ruff-sync]
+# Pin to a specific tag or commit for stability
+upstream = "https://github.com/my-org/standards/blob/v1.2.0/pyproject.toml"
+```
+
+When you are ready to roll out new linting rules, you can update the version across repositories in a controlled manner.
+
+---
+
+## 🎯 Use Strategic Exclusions
+
+Not every setting should be centralized. Some configurations are inherently project-specific.
+
+Use the `exclude` option to prevent `ruff-sync` from overwriting configurations that should remain local.
+
+For example, do not force all repositories to use the same Python target version, and allow projects to selectively ignore specific upstream rules that don't make sense locally:
+
+```toml
+[tool.ruff-sync]
+upstream = "https://github.com/my-org/standards"
+exclude = [
+    # Always preserve local file-level exceptions (excluded by default)
+    "lint.per-file-ignores",
+    # Allow projects to define their own Python version
+    "target-version",
+    # Preserve local ignored rules that don't apply to this specific project
+    "lint.ignore"
+]
+```
+
+By excluding `lint.ignore`, a project can adopt the organization's standard `lint.select` list, but gracefully opt out of specific rules that cause issues in their specific domain without breaking the sync process.
+
+---
+
+## 🚦 Semantic Checks in CI
+
+To ensure your repository hasn't drifted from your organization's unified standards, you should run `ruff-sync check --semantic` in your Continuous Integration pipeline.
+
+**If you pin to a stable tag (as recommended above):**
+Make this a **blocking check**. Since the upstream configuration won't change unexpectedly, any drift means a developer inadvertently modified the local rules. Failing the build ensures the repository stays perfectly compliant.
+
+**If you sync directly from a moving branch (like `main`):**
+We recommend making this an **informational, non-failing check**. If a new rule is added upstream while a developer is working on a feature, blocking their PR can cause frustration. Instead, pair the informational check with a **weekly automated workflow** that pulls down the latest configuration and opens a pull request. This groups linter updates into a single controllable PR that can be reviewed and tested in isolation.
+
+See the [CI Integration Guide](ci-integration.md#automated-sync-prs) for an example GitHub Actions workflow that automatically syncs the configuration and opens a PR.
+
+---
+
+## 🏢 Hierarchical Configuration
+
+For large organizations with distinct teams or sub-projects (like a frontend-heavy full stack repo vs. a pure backend service), you can define multiple upstreams to create a hierarchy.
+
+Because `ruff-sync` merges multiple upstreams sequentially (from top to bottom), the "last one wins." This allows you to have a strict company-wide base config, and a slightly looser (or tighter) team-specific config.
+
+```toml
+[tool.ruff-sync]
+upstream = [
+    # 1. Base company rules
+    "https://github.com/my-org/standards/blob/main/base.toml",
+
+    # 2. Team-specific tweaks (these override the base rules)
+    "https://github.com/my-org/standards/blob/main/team-alpha.toml",
+]
+```

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/docs/ci-integration.md

@@ -47,7 +47,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: astral-sh/setup-uv@v5
       - name: Pull upstream
-        run: uvx ruff-sync pull
+        run: uvx ruff-sync
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:
@@ -72,35 +72,27 @@ ruff-sync-check:
 
 ---
 
-## 🛠️ Pre-commit Integration
-
 You can use `ruff-sync` with `pre-commit` to ensure your configuration is always in sync before pushing.
 
-Add this to your `.pre-commit-config.yaml`:
-
-```yaml
-repos:
-  - repo: local
-    hooks:
-      - id: ruff-sync-check
-        name: ruff-sync-check
-        entry: uvx ruff-sync check --semantic
-        language: system
-        files: ^pyproject\.toml$
-        pass_filenames: false
-```
-
-!!! note
-    Running `ruff-sync check` in pre-commit is fast because it only performs a network request if the local `pyproject.toml` is older than the upstream or if no cache exists.
+See the [Pre-commit Guide](pre-commit.md) for details on using the official hooks.
 
 ---
 
 ## 💡 Best Practices
 
+> [!TIP]
+> Read the complete [Best Practices](best-practices.md) guide for a broader look at organizing `ruff-sync` deployments, including when semantic checks should be blocking vs. informational.
+
 ### Use `--semantic`
 
 In CI, you usually only care about the functional configuration. Using `--semantic` ensures that minor formatting changes don't break your builds, while still guaranteeing that the actual rules are identical.
 
+### Handle Exclusions Properly
+
+If your project intentionally diverges from the upstream (e.g., using different `per-file-ignores` or ignoring a specific rule), ensure those overrides are listed in the `[tool.ruff-sync]` `exclude` list in your `pyproject.toml`.
+
+The `check` command respects your local `exclude` list. If you exclude a setting, `ruff-sync check` will completely ignore it when comparing against the upstream, ensuring that intended deviations never cause CI to fail!
+
 ### Use a Dedicated Workflow
 
 Running `ruff-sync` as a separate job in your linting workflow makes it easy to identify when a failure is due to configuration drift rather than a code quality issue.

{ruff_sync-0.1.0.dev2 → ruff_sync-0.1.2.dev1}/docs/configuration.md

@@ -13,11 +13,15 @@
 | `path` | `str` | `""` | The directory path within the repository where the config is located. |
 | `semantic` | `bool` | `false` | Whether `check` should default to semantic matching. |
 | `diff` | `bool` | `true` | Whether `check` should show a diff by default. |
+| `pre-commit-version-sync` | `bool` | `false` | Sync the pre-commit Ruff hook version with the project's Ruff version. |
 
 ## Exclude Patterns
 
 The `exclude` setting is powerful. It allows you to adopt most of an upstream configuration while keeping some parts specific to your repository.
 
+> [!TIP]
+> See [Strategic Exclusions](best-practices.md#use-strategic-exclusions) in our Best Practices guide for recommendations on what settings to keep local.
+
 Exclusions use dotted paths to target specific sections or keys.
 
 ### Examples
@@ -60,16 +64,19 @@ exclude = ["target-version"]
 
 #### Sequential merging of multiple sources
 
-You can specify multiple upstream sources as a list. They will be merged in order, with later sources overriding earlier ones.
+You can specify multiple upstream sources as a list. They will be merged in order—from top to bottom—with later sources overriding or extending earlier ones.
 
 ```toml
 [tool.ruff-sync]
 upstream = [
-    "https://github.com/my-org/shared-config",
-    "https://github.com/my-org/team-overrides",
+    "https://github.com/my-org/shared-config",  # 1. Base rules
+    "https://github.com/my-org/team-overrides", # 2. Team-specific tweaks (wins)
 ]
 ```
 
+!!! tip "Last One Wins"
+    The merge logic follows a "last one wins" approach for simple keys (like `line-length`), while performing a deep merge for configuration tables like `lint.per-file-ignores`.
+
 ## Deprecation Notes
 
 - The key `source` in `[tool.ruff-sync]` is deprecated and will be removed in a future version. Use `to` instead.