ruff-sync 0.0.3.dev1__tar.gz → 0.0.4.dev1__tar.gz

{ruff_sync-0.0.3.dev1 → ruff_sync-0.0.4.dev1}/.agents/TESTING.md

@@ -48,6 +48,22 @@ def test_merge_scenarios(source, upstream, expected_keys):
     # ... test logic ...
 ```
 
+### 3.3 No Autouse Fixtures
+`autouse=True` fixtures are **never allowed**. They hide setup logic and can cause non-obvious side effects or dependencies between tests. All fixtures used by a test must be explicitly requested in the test function's arguments.
+
+### 3.4 Main Entry Point
+Every test file **must** end with a main entry point block. This ensures each file is independently executable as a script (`python tests/test_foo.py`).
+
+```python
+if __name__ == "__main__":
+    pytest.main([__file__, "-vv"])
+```
+
+**Why this matters:**
+1.  **Direct Execution**: Developers can run a single test file using standard Python without needing to remember complex `pytest` filter flags.
+2.  **IDE Workflow Integration**: Many IDEs (like VS Code or PyCharm) allow you to run the "Current File" with a single click or keyboard shortcut. Having a main block ensures this works out of the box with the correct verbosity and scope.
+3.  **Cleaner Diffs**: By terminating the file with this standard block, it prevents "no newline at end of file" warnings and ensures that new tests added above it produce clean, isolated diff segments. It also ensures that when debugging with `--icdiff` or similar tools, the output is scoped correctly to the specific file.
+
 ## 4. Handling TOML and `tomlkit`
 
 `tomlkit` is central to this project but its dynamic type system can be tricky for mypy.

{ruff_sync-0.0.3.dev1 → ruff_sync-0.0.4.dev1}/.github/workflows/ci.yaml

@@ -64,10 +64,35 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: Kilo59/ruff-sync
 
+  pre-publish:
+    name: Test package installation
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [static-analysis, tests]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Build package
+        run: uv build
+
+      - name: Install and test packaged program
+        run: |
+          uv tool install $(ls dist/*.whl)
+          ruff-sync --version
+          ruff-sync https://github.com/Kilo59/ruff-sync
+          ruff-sync check https://github.com/Kilo59/ruff-sync
+
   publish:
     name: Build and publish to PyPI
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs: [static-analysis, tests]
+    needs: [pre-publish]
     runs-on: ubuntu-latest
     permissions:
       # This permission is required for trusted publishing

{ruff_sync-0.0.3.dev1 → ruff_sync-0.0.4.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ruff-sync
-Version: 0.0.3.dev1
+Version: 0.0.4.dev1
 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
@@ -42,7 +42,7 @@ Description-Content-Type: text/markdown
 
 **Keep your Ruff config consistent across multiple projects.**
 
-`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, or any raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
+`ruff-sync` is a CLI tool that pulls a canonical [Ruff](https://docs.astral.sh/ruff/) configuration from an upstream `pyproject.toml` or `ruff.toml` (hosted anywhere — GitHub, GitLab, or any raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
 
 ---
 
@@ -141,21 +141,20 @@ uv tool install git+https://github.com/Kilo59/ruff-sync
 ### Usage
 
 ```console
-# Sync from a GitHub repository (defaults to main/pyproject.toml)
+# Sync from a GitHub/GitLab repository (defaults to main/pyproject.toml)
 ruff-sync https://github.com/my-org/standards
 
 # Or a direct blob/file URL (auto-converts to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
 
-# GitLab support (including nested projects)
-ruff-sync https://gitlab.com/my-org/my-group/nested/standards
+# 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)
+ruff-sync git@github.com:my-org/standards.git
+ruff-sync ssh://git@gitlab.com/my-org/standards.git
 
-# Once configured in pyproject.toml (see Configuration), simply run:
+# Or if configured in pyproject.toml (see Configuration), simply run:
 ruff-sync
 
-# Sync into a specific project directory
-ruff-sync --source ./my-project
-
 # Exclude specific sections from being overwritten using dotted paths
 ruff-sync --exclude lint.per-file-ignores lint.ignore
 
@@ -170,12 +169,13 @@ Run `ruff-sync --help` for full details on all available options.
 
 ## Key Features
 
-- **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
-- **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
-- **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
-- **Works with any host** — GitHub, GitLab, Bitbucket, or any raw URL that serves a `pyproject.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.
+- 🏗️ **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
+- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
+- 📥 **Git clone support** — If the URL starts with `git@` or uses the `ssh://`, `git://`, or `git+ssh://` schemes, `ruff-sync` will perform an efficient shallow clone (using `--filter=blob:none` and `--no-checkout`) to safely extract the configuration with minimal network traffic.
+- 🛡️ **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
+- 🌍 **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.
 
 ## Configuration
 
@@ -202,16 +202,25 @@ This sets the default upstream and exclusions so you don't need to pass them on
 
 ### Advanced Configuration
 
-For more complex setups, you can also configure the default branch and parent directory used when resolving repository URLs (e.g. `https://github.com/my-org/standards`):
+Here are all the possible values that can be provided in `[tool.ruff-sync]` along with their explanations and defaults:
 
 ```toml
 [tool.ruff-sync]
+# The source of truth URL for your Ruff configuration. (Required, unless passed via CLI)
 upstream = "https://github.com/my-org/standards"
 
-# Use a specific branch or tag (default: "main")
+# A list of config keys to exclude from being synced. (Default: ["lint.per-file-ignores"])
+# Use simple names for top-level keys, and dotted paths for nested keys.
+exclude = [
+    "target-version",
+    "lint.per-file-ignores",
+]
+
+# The branch, tag, or commit hash to use when resolving a Git repository URL. (Default: "main")
 branch = "develop"
 
-# Specify a parent directory if pyproject.toml is not at the repo root
+# A directory prefix to use when looking for a configuration file in a repository. (Default: "")
+# Useful if the upstream pyproject.toml is not at the repository root.
 path = "config/ruff"
 ```
 
@@ -259,6 +268,18 @@ git diff pyproject.toml  # review the changes
 git commit -am "sync ruff config from upstream"
 ```
 
+## Bootstrapping a New Project
+
+By default, `ruff-sync` requires an existing configuration file (`pyproject.toml` or `ruff.toml`) to merge into. If you are starting a fresh project and want to initialize it with your organization's Ruff settings, you can use the `--init` flag to scaffold a new file automatically.
+
+```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` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. 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.
+
+
 ## Detailed Check Logic
 
 When you run `ruff-sync check`, it follows this process to determine if your project has drifted from the upstream source:
@@ -297,40 +318,23 @@ flowchart TD
     style SemanticNode fill:#f4f4f4,color:#363636,stroke:#dbdbdb
 ```
 
-## Contributing
-
-This project uses:
-
-- [uv](https://docs.astral.sh/uv/) for dependency management
-- [Ruff](https://docs.astral.sh/ruff/) for linting and formatting
-- [mypy](https://mypy-lang.org/) for type checking (strict mode)
-- [pytest](https://docs.pytest.org/) for testing
-
-```console
-# Setup
-uv sync --group dev
-
-# Run checks
-uv run ruff check . --fix   # lint
-uv run ruff format .        # format
-uv run mypy .               # type check
-uv run pytest -vv           # test
-```
-
 ## Dogfooding
 
-To see `ruff-sync` in action, you can "dogfood" it on this project's own config.
+To see `ruff-sync` in action, you can ["dogfood" it on this project's own config](./scripts).
 
-**Check if this project is in sync with its upstream:**
+[**Check if this project is in sync with its upstream:**](./scripts/check_dogfood.sh)
 
 ```console
-./scripts/dogfood_check.sh
+./scripts/check_dogfood.sh
 ```
 
-**Or sync from a large upstream like Pydantic's config:**
+[**Or sync from a large upstream like Pydantic's config:**](./scripts/pull_dogfood.sh)
 
 ```console
-./scripts/dogfood.sh
+# Using a HTTP URL
+./scripts/pull_dogfood.sh
+# Using a Git URL
+./scripts/gitclone_dogfood.sh
 ```
 
 This will download Pydantic's Ruff configuration and merge it into the local `pyproject.toml`. You can then use `git diff` to see how it merged the keys while preserving the existing structure and comments.

{ruff_sync-0.0.3.dev1 → ruff_sync-0.0.4.dev1}/README.md

@@ -12,7 +12,7 @@
 
 **Keep your Ruff config consistent across multiple projects.**
 
-`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, or any raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
+`ruff-sync` is a CLI tool that pulls a canonical [Ruff](https://docs.astral.sh/ruff/) configuration from an upstream `pyproject.toml` or `ruff.toml` (hosted anywhere — GitHub, GitLab, or any raw URL) and merges it into your local project, preserving your comments, formatting, and project-specific overrides.
 
 ---
 
@@ -111,21 +111,20 @@ uv tool install git+https://github.com/Kilo59/ruff-sync
 ### Usage
 
 ```console
-# Sync from a GitHub repository (defaults to main/pyproject.toml)
+# Sync from a GitHub/GitLab repository (defaults to main/pyproject.toml)
 ruff-sync https://github.com/my-org/standards
 
 # Or a direct blob/file URL (auto-converts to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
 
-# GitLab support (including nested projects)
-ruff-sync https://gitlab.com/my-org/my-group/nested/standards
+# 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)
+ruff-sync git@github.com:my-org/standards.git
+ruff-sync ssh://git@gitlab.com/my-org/standards.git
 
-# Once configured in pyproject.toml (see Configuration), simply run:
+# Or if configured in pyproject.toml (see Configuration), simply run:
 ruff-sync
 
-# Sync into a specific project directory
-ruff-sync --source ./my-project
-
 # Exclude specific sections from being overwritten using dotted paths
 ruff-sync --exclude lint.per-file-ignores lint.ignore
 
@@ -140,12 +139,13 @@ Run `ruff-sync --help` for full details on all available options.
 
 ## Key Features
 
-- **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
-- **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
-- **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
-- **Works with any host** — GitHub, GitLab, Bitbucket, or any raw URL that serves a `pyproject.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.
+- 🏗️ **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
+- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
+- 📥 **Git clone support** — If the URL starts with `git@` or uses the `ssh://`, `git://`, or `git+ssh://` schemes, `ruff-sync` will perform an efficient shallow clone (using `--filter=blob:none` and `--no-checkout`) to safely extract the configuration with minimal network traffic.
+- 🛡️ **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
+- 🌍 **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.
 
 ## Configuration
 
@@ -172,16 +172,25 @@ This sets the default upstream and exclusions so you don't need to pass them on
 
 ### Advanced Configuration
 
-For more complex setups, you can also configure the default branch and parent directory used when resolving repository URLs (e.g. `https://github.com/my-org/standards`):
+Here are all the possible values that can be provided in `[tool.ruff-sync]` along with their explanations and defaults:
 
 ```toml
 [tool.ruff-sync]
+# The source of truth URL for your Ruff configuration. (Required, unless passed via CLI)
 upstream = "https://github.com/my-org/standards"
 
-# Use a specific branch or tag (default: "main")
+# A list of config keys to exclude from being synced. (Default: ["lint.per-file-ignores"])
+# Use simple names for top-level keys, and dotted paths for nested keys.
+exclude = [
+    "target-version",
+    "lint.per-file-ignores",
+]
+
+# The branch, tag, or commit hash to use when resolving a Git repository URL. (Default: "main")
 branch = "develop"
 
-# Specify a parent directory if pyproject.toml is not at the repo root
+# A directory prefix to use when looking for a configuration file in a repository. (Default: "")
+# Useful if the upstream pyproject.toml is not at the repository root.
 path = "config/ruff"
 ```
 
@@ -229,6 +238,18 @@ git diff pyproject.toml  # review the changes
 git commit -am "sync ruff config from upstream"
 ```
 
+## Bootstrapping a New Project
+
+By default, `ruff-sync` requires an existing configuration file (`pyproject.toml` or `ruff.toml`) to merge into. If you are starting a fresh project and want to initialize it with your organization's Ruff settings, you can use the `--init` flag to scaffold a new file automatically.
+
+```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` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. 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.
+
+
 ## Detailed Check Logic
 
 When you run `ruff-sync check`, it follows this process to determine if your project has drifted from the upstream source:
@@ -267,40 +288,23 @@ flowchart TD
     style SemanticNode fill:#f4f4f4,color:#363636,stroke:#dbdbdb
 ```
 
-## Contributing
-
-This project uses:
-
-- [uv](https://docs.astral.sh/uv/) for dependency management
-- [Ruff](https://docs.astral.sh/ruff/) for linting and formatting
-- [mypy](https://mypy-lang.org/) for type checking (strict mode)
-- [pytest](https://docs.pytest.org/) for testing
-
-```console
-# Setup
-uv sync --group dev
-
-# Run checks
-uv run ruff check . --fix   # lint
-uv run ruff format .        # format
-uv run mypy .               # type check
-uv run pytest -vv           # test
-```
-
 ## Dogfooding
 
-To see `ruff-sync` in action, you can "dogfood" it on this project's own config.
+To see `ruff-sync` in action, you can ["dogfood" it on this project's own config](./scripts).
 
-**Check if this project is in sync with its upstream:**
+[**Check if this project is in sync with its upstream:**](./scripts/check_dogfood.sh)
 
 ```console
-./scripts/dogfood_check.sh
+./scripts/check_dogfood.sh
 ```
 
-**Or sync from a large upstream like Pydantic's config:**
+[**Or sync from a large upstream like Pydantic's config:**](./scripts/pull_dogfood.sh)
 
 ```console
-./scripts/dogfood.sh
+# Using a HTTP URL
+./scripts/pull_dogfood.sh
+# Using a Git URL
+./scripts/gitclone_dogfood.sh
 ```
 
 This will download Pydantic's Ruff configuration and merge it into the local `pyproject.toml`. You can then use `git diff` to see how it merged the keys while preserving the existing structure and comments.

{ruff_sync-0.0.3.dev1 → ruff_sync-0.0.4.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ruff-sync"
-version = "0.0.3.dev1"
+version = "0.0.4.dev1"
 description = "Synchronize Ruff linter configuration across projects"
 keywords = ["ruff", "linter", "config", "synchronize", "python", "linting", "automation", "tomlkit"]
 authors = [