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

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

@@ -88,6 +88,7 @@ jobs:
           ruff-sync --version
           ruff-sync https://github.com/Kilo59/ruff-sync
           ruff-sync check https://github.com/Kilo59/ruff-sync
+          ! ruff-sync check --semantic https://github.com/Kilo59/ruff-sync --path configs/kitchen-sink
 
   publish:
     name: Build and publish to PyPI

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ruff-sync
-Version: 0.0.4.dev1
+Version: 0.0.5.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
@@ -130,14 +130,6 @@ With [pip](https://pip.pypa.io/en/stable/):
 pip install ruff-sync
 ```
 
-#### From Source (Bleeding Edge)
-
-If you want the latest development version:
-
-```console
-uv tool install git+https://github.com/Kilo59/ruff-sync
-```
-
 ### Usage
 
 ```console
@@ -268,6 +260,24 @@ git diff pyproject.toml  # review the changes
 git commit -am "sync ruff config from upstream"
 ```
 
+### Curated Examples
+
+While `ruff-sync` is designed to sync from *any* repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+
+For example, to sync an exhaustive "kitchen-sink" configuration that explicitly enables all rules and documents them:
+
+```console
+ruff-sync https://github.com/Kilo59/ruff-sync/blob/main/configs/kitchen-sink/ruff.toml
+```
+
+Or configure it using `pyproject.toml` so it's always the default for your local project:
+
+```toml
+[tool.ruff-sync]
+upstream = "https://github.com/Kilo59/ruff-sync"
+path = "configs/kitchen-sink"
+```
+
 ## 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.

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

@@ -100,14 +100,6 @@ With [pip](https://pip.pypa.io/en/stable/):
 pip install ruff-sync
 ```
 
-#### From Source (Bleeding Edge)
-
-If you want the latest development version:
-
-```console
-uv tool install git+https://github.com/Kilo59/ruff-sync
-```
-
 ### Usage
 
 ```console
@@ -238,6 +230,24 @@ git diff pyproject.toml  # review the changes
 git commit -am "sync ruff config from upstream"
 ```
 
+### Curated Examples
+
+While `ruff-sync` is designed to sync from *any* repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+
+For example, to sync an exhaustive "kitchen-sink" configuration that explicitly enables all rules and documents them:
+
+```console
+ruff-sync https://github.com/Kilo59/ruff-sync/blob/main/configs/kitchen-sink/ruff.toml
+```
+
+Or configure it using `pyproject.toml` so it's always the default for your local project:
+
+```toml
+[tool.ruff-sync]
+upstream = "https://github.com/Kilo59/ruff-sync"
+path = "configs/kitchen-sink"
+```
+
 ## 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.

ruff_sync-0.0.5.dev1/configs/kitchen-sink/ruff.toml

@@ -0,0 +1,262 @@
+# ruff-sync Kitchen Sink Configuration
+# https://github.com/Kilo59/ruff-sync
+#
+# This file enables ALL possible Ruff rules as of Ruff v0.15.5
+# It explicitly lists all rule categories and provides links to their documentation.
+# This serves as a comprehensive reference for what is possible with Ruff.
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10. Consumers should override this to match
+# their project's supported Python version.
+target-version = "py310"
+
+[lint]
+# Enable all rule categories explicitly.
+select = [
+    # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F",      # Pyflakes: Essential checks for python bugs
+    # https://docs.astral.sh/ruff/rules/#error-e
+    "E",      # pycodestyle errors: PEP8 styling
+    # https://docs.astral.sh/ruff/rules/#warning-w
+    "W",      # pycodestyle warnings: PEP8 styling
+    # https://docs.astral.sh/ruff/rules/#mccabe-c90
+    "C90",    # mccabe: Code complexity (cyclomatic complexity)
+    # https://docs.astral.sh/ruff/rules/#isort-i
+    "I",      # isort: Import sorting
+    # https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "N",      # pep8-naming: Naming conventions
+    # https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "D",      # pydocstyle: Docstring conventions
+    # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "UP",     # pyupgrade: Upgrade syntax for newer Python versions
+    # https://docs.astral.sh/ruff/rules/#flake8-2020-ytt
+    "YTT",    # flake8-2020: Checks for sys.version and sys.version_info usage
+    # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+    "ANN",    # flake8-annotations: Type annotation checks
+    # https://docs.astral.sh/ruff/rules/#flake8-async-async
+    "ASYNC",  # flake8-async: Asynchronous code checks
+    # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
+    "S",      # flake8-bandit: Security testing
+    # https://docs.astral.sh/ruff/rules/#flake8-blind-except-ble
+    "BLE",    # flake8-blind-except: Checks for blind except: statements
+    # https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
+    "FBT",    # flake8-boolean-trap: Boolean trap checks
+    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "B",      # flake8-bugbear: Finding likely bugs and design problems
+    # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+    "A",      # flake8-builtins: Check for python builtins being used as variables or parameters
+    # https://docs.astral.sh/ruff/rules/#flake8-commas-com
+    "COM",    # flake8-commas: Trailing commas checks
+    # https://docs.astral.sh/ruff/rules/#flake8-copyright-cpy
+    # "CPY",    # flake8-copyright: Copyright notice checks (Note: requires `preview = true`)
+    # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "C4",     # flake8-comprehensions: Write better list/set/dict comprehensions
+    # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
+    "DTZ",    # flake8-datetimez: Usage of unsafe naive datetime class
+    # https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
+    "T10",    # flake8-debugger: Check for pdb/ipdb imports and set_traces
+    # https://docs.astral.sh/ruff/rules/#flake8-django-dj
+    "DJ",     # flake8-django: Django specific code quality checks
+    # https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
+    "EM",     # flake8-errmsg: Nicer error messages
+    # https://docs.astral.sh/ruff/rules/#flake8-executable-exe
+    "EXE",    # flake8-executable: Executable permissions and shebangs
+    # https://docs.astral.sh/ruff/rules/#flake8-future-annotations-fa
+    "FA",     # flake8-future-annotations: Verify python 3.7+ from __future__ import annotations
+    # https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc
+    "ISC",    # flake8-implicit-str-concat: Implicit string concatenation checks
+    # https://docs.astral.sh/ruff/rules/#flake8-import-conventions-icn
+    "ICN",    # flake8-import-conventions: Enforce standard naming for standard libraries
+    # https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
+    "G",      # flake8-logging-format: Validate logging format strings
+    # https://docs.astral.sh/ruff/rules/#flake8-no-pep420-inp
+    "INP",    # flake8-no-pep420: Ban PEP-420 implicit namespace packages
+    # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
+    "PIE",    # flake8-pie: Misc. lints
+    # https://docs.astral.sh/ruff/rules/#flake8-print-t20
+    "T20",    # flake8-print: Check for Print statements in python files
+    # https://docs.astral.sh/ruff/rules/#flake8-pyi-pyi
+    "PYI",    # flake8-pyi: Linting for .pyi files
+    # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
+    "PT",     # flake8-pytest-style: Checking common style issues or inconsistencies with pytest
+    # https://docs.astral.sh/ruff/rules/#flake8-quotes-q
+    "Q",      # flake8-quotes: Lint for quotes
+    # https://docs.astral.sh/ruff/rules/#flake8-raise-rse
+    "RSE",    # flake8-raise: Find and correct raise statements
+    # https://docs.astral.sh/ruff/rules/#flake8-return-ret
+    "RET",    # flake8-return: Check return values
+    # https://docs.astral.sh/ruff/rules/#flake8-self-slf
+    "SLF",    # flake8-self: Private member access checks
+    # https://docs.astral.sh/ruff/rules/#flake8-slots-slot
+    "SLOT",   # flake8-slots: Require __slots__ for subclasses of immutable types
+    # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "SIM",    # flake8-simplify: Code simplification
+    # https://docs.astral.sh/ruff/rules/#flake8-tidy-imports-tid
+    "TID",    # flake8-tidy-imports: Tidy imports
+    # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tc
+    "TC",     # flake8-type-checking: Move imports into type-checking blocks
+    # https://docs.astral.sh/ruff/rules/#flake8-gettext-int
+    "ARG",    # flake8-unused-arguments: Unused argument checks
+    # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "PTH",    # flake8-use-pathlib: Use pathlib instead of os.path
+    # https://docs.astral.sh/ruff/rules/#flake8-todos-td
+    "TD",     # flake8-todos: TODO comments formatting
+    # https://docs.astral.sh/ruff/rules/#flake8-fixme-fix
+    "FIX",    # flake8-fixme: Check for FIXME, XXX and other developer notes
+    # https://docs.astral.sh/ruff/rules/#eradicate-era
+    "ERA",    # eradicate: Found commented out code
+    # https://docs.astral.sh/ruff/rules/#pandas-vet-pd
+    "PD",     # pandas-vet: Pandas code checks
+    # https://docs.astral.sh/ruff/rules/#pygrep-hooks-pgh
+    "PGH",    # pygrep-hooks: Pygrep hooks
+    # https://docs.astral.sh/ruff/rules/#pylint-pl
+    "PL",     # Pylint: Pylint rules
+    # https://docs.astral.sh/ruff/rules/#tryceratops-try
+    "TRY",    # tryceratops: Prevent Exception Handling AntiPatterns
+    # https://docs.astral.sh/ruff/rules/#flynt-fly
+    "FLY",    # flynt: Convert string formatting to f-strings
+    # https://docs.astral.sh/ruff/rules/#numpy-specific-rules-npy
+    "NPY",    # NumPy-specific rules: NumPy conventions
+    # https://docs.astral.sh/ruff/rules/#airflow-air
+    "AIR",    # Airflow: Airflow best practices
+    # https://docs.astral.sh/ruff/rules/#perflint-perf
+    "PERF",   # Perflint: Performance anti-patterns
+    # https://docs.astral.sh/ruff/rules/#refurb-furb
+    "FURB",   # refurb: Modernize Python code
+    # https://docs.astral.sh/ruff/rules/#flake8-logging-log
+    "LOG",    # flake8-logging: Better logging practices
+    # https://docs.astral.sh/ruff/rules/#pydoclint-doc
+    # "DOC",    # pydoclint: Validate docstrings against function signatures (Note: requires `preview = true`)
+    # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+    "RUF"     # Ruff-specific rules: Rules unique to Ruff
+]
+
+# We don't ignore any rules in this config, as it aims to be exhaustive.
+# WARNING: Some of the rules enabled above may be mutually exclusive or
+# conflict with each other (e.g., D212 and D213). You will likely need to
+# remove some rules from the `select` list or add them to the `ignore`
+# list below based on your preferences and project conventions.
+#
+# Below is a list of lint rules that conflict with the Ruff formatter.
+# We ignore these by default so `ruff format` will run without warnings.
+# See: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+ignore = [
+    "W191",   # tab-indentation
+    "E111",   # indentation-with-invalid-multiple
+    "E114",   # indentation-with-invalid-multiple-comment
+    "E117",   # over-indented
+    "D206",   # docstring-tab-indentation
+    "D300",   # triple-single-quotes
+    "Q000",   # bad-quotes-inline-string
+    "Q001",   # bad-quotes-multiline-string
+    "Q002",   # bad-quotes-docstring
+    "Q003",   # avoidable-escaped-quote
+    "Q004",   # unnecessary-escaped-quote
+    "COM812", # missing-trailing-comma
+    "COM819", # prohibited-trailing-comma
+    "ISC001", # single-line-implicit-string-concatenation
+    "ISC002", # multi-line-implicit-string-concatenation
+]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.mccabe]
+# Flag errors (`C901`) whenever the complexity level exceeds 10.
+# Default: 10
+max-complexity = 10
+
+[lint.pydocstyle]
+# Which style to use for docstrings. Can be "google", "numpy", or "pep257".
+# Default: "pep257"
+convention = "pep257"
+
+[lint.flake8-quotes]
+# The style to use for inline strings: "single" or "double"
+# Default: "double"
+inline-quotes = "double"
+# The style to use for multiline strings
+# Default: "double"
+multiline-quotes = "double"
+# The style to use for docstrings
+# Default: "double"
+docstring-quotes = "double"
+# Whether to avoid escaping quotes if the other quote type would save an escape
+# Default: true
+avoid-escape = true
+
+[lint.flake8-tidy-imports]
+# Ban absolute imports from specific modules
+# ban-relative-imports = "all" # Default: "parents"
+
+[lint.isort]
+# How to group imports: "std", "third-party", "first-party", "local-folder".
+# Default: ["future", "standard-library", "third-party", "first-party", "local-folder"]
+# section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[lint.flake8-pytest-style]
+# Whether to require parentheses for pytest fixtures.
+# Default: true
+fixture-parentheses = true
+# The type of pytest.mark.parametrize names to use: "tuple", "list", or "csv"
+# Default: "tuple"
+parametrize-names-type = "tuple"
+
+[lint.pylint]
+# The maximum number of arguments allowed for a function.
+# Default: 5
+max-args = 5
+# The maximum return statements allowed for a function.
+# Default: 6
+max-returns = 6
+# The maximum number of branches allowed for a function.
+# Default: 12
+max-branches = 12
+# The maximum number of local variables allowed for a function.
+# Default: 15
+max-locals = 15
+
+[lint.pep8-naming]
+# Additional functions or methods that should be exempt from the lower_case_with_underscores rule.
+# Default: []
+ignore-names = []
+# Additional decorators that should be treated as classmethod.
+# Default: []
+classmethod-decorators = [
+    "pydantic.validator",
+    "pydantic.root_validator",
+]

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

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

{ruff_sync-0.0.4.dev1 → ruff_sync-0.0.5.dev1}/ruff_sync.py

@@ -23,7 +23,7 @@ from tomlkit import TOMLDocument, table
 from tomlkit.items import Table
 from tomlkit.toml_file import TOMLFile
 
-__version__ = "0.0.4.dev1"
+__version__ = "0.0.5.dev1"
 
 _DEFAULT_EXCLUDE: Final[set[str]] = {"lint.per-file-ignores"}
 _GITHUB_REPO_PATH_PARTS_COUNT: Final[int] = 2
@@ -216,17 +216,35 @@ def _get_cli_parser() -> ArgumentParser:
     return parser
 
 
+def _get_target_path(path: str | None) -> str:
+    """Resolve the target path for configuration files.
+
+    If the path indicates a .toml file, it's treated as a direct file path.
+    Otherwise, it appends 'pyproject.toml' to the path.
+    """
+    if not path:
+        return "pyproject.toml"
+
+    # Use PurePosixPath to handle URL-style paths consistently
+    posix_path = pathlib.PurePosixPath(path.strip("/"))
+    if posix_path.suffix == ".toml":
+        return str(posix_path)
+
+    return str(posix_path / "pyproject.toml")
+
+
 def _convert_github_url(url: URL, branch: str = "main", path: str = "") -> URL:
     """Convert a GitHub URL to its corresponding raw content URL.
 
     Supports:
     - Blob URLs: https://github.com/org/repo/blob/branch/path/to/file
-    - Repo URLs: https://github.com/org/repo (defaults to {branch}/{path}/pyproject.toml)
+    - Repo URLs: https://github.com/org/repo (defaults to {branch}/{path}/pyproject.toml if path
+      doesn't end in .toml)
 
     Args:
         url (URL): The GitHub URL to be converted.
         branch (str): The default branch to use for repo URLs.
-        path (str): The directory prefix for pyproject.toml.
+        path (str): The directory prefix for pyproject.toml, or a direct path to a .toml file.
 
     Returns:
         URL: The corresponding raw content URL.
@@ -243,10 +261,10 @@ def _convert_github_url(url: URL, branch: str = "main", path: str = "") -> URL:
     path_parts = [p for p in url.path.split("/") if p]
     if len(path_parts) == _GITHUB_REPO_PATH_PARTS_COUNT:
         org, repo = path_parts
-        target_path = f"{path.strip('/')}/pyproject.toml" if path else "pyproject.toml"
+        target_path = _get_target_path(path)
         raw_url = url.copy_with(
             host=_GITHUB_RAW_HOST,
-            path=f"/{org}/{repo}/{branch}/{target_path}",
+            path=str(pathlib.PurePosixPath("/", org, repo, branch, target_path)),
         )
         LOGGER.info(f"Converting GitHub repo URL to raw content URL: {raw_url}")
         return raw_url
@@ -260,12 +278,13 @@ def _convert_gitlab_url(url: URL, branch: str = "main", path: str = "") -> URL:
 
     Supports:
     - Blob URLs: https://gitlab.com/org/repo/-/blob/branch/path/to/file
-    - Repo URLs: https://gitlab.com/org/repo (defaults to {branch}/{path}/pyproject.toml)
+    - Repo URLs: https://gitlab.com/org/repo (defaults to {branch}/{path}/pyproject.toml if path
+      doesn't end in .toml)
 
     Args:
         url (URL): The GitLab URL to be converted.
         branch (str): The default branch to use for repo URLs.
-        path (str): The directory prefix for pyproject.toml.
+        path (str): The directory prefix for pyproject.toml, or a direct path to a .toml file.
 
     Returns:
         URL: The corresponding raw content URL.
@@ -283,8 +302,10 @@ def _convert_gitlab_url(url: URL, branch: str = "main", path: str = "") -> URL:
         # Avoid empty paths or just a slash
         path_prefix = url.path.rstrip("/")
         if path_prefix:
-            target_path = f"{path.strip('/')}/pyproject.toml" if path else "pyproject.toml"
-            raw_url = url.copy_with(path=f"{path_prefix}/-/raw/{branch}/{target_path}")
+            target_path = _get_target_path(path)
+            raw_url = url.copy_with(
+                path=str(pathlib.PurePosixPath(path_prefix, "-", "raw", branch, target_path))
+            )
             LOGGER.info(f"Converting GitLab repo URL to raw content URL: {raw_url}")
             return raw_url
 
@@ -297,6 +318,32 @@ def is_git_url(url: URL) -> bool:
     return str(url).startswith("git@") or url.scheme in ("ssh", "git", "git+ssh")
 
 
+def to_git_url(url: URL) -> URL | None:
+    """
+    Attempt to convert a browser or raw URL to a git (SSH) URL.
+
+    Supports GitHub and GitLab.
+    """
+    if is_git_url(url):
+        return url
+
+    if url.host in _GITHUB_HOSTS or url.host == _GITHUB_RAW_HOST:
+        path_parts = [p for p in url.path.split("/") if p]
+        if len(path_parts) >= _GITHUB_REPO_PATH_PARTS_COUNT:
+            org, repo = path_parts[:_GITHUB_REPO_PATH_PARTS_COUNT]
+            repo = repo.removesuffix(".git")
+            return URL(f"git@github.com:{org}/{repo}.git")
+
+    if url.host in _GITLAB_HOSTS:
+        path = url.path.strip("/")
+        project_path = path.split("/-/")[0] if "/-/" in path else path
+        if project_path:
+            project_path = project_path.removesuffix(".git")
+            return URL(f"git@{url.host}:{project_path}.git")
+
+    return None
+
+
 def resolve_raw_url(url: URL, branch: str = "main", path: str | None = None) -> URL:
     """Convert a GitHub or GitLab repository/blob URL to a raw content URL.
 
@@ -367,11 +414,7 @@ async def fetch_upstream_config(
                         capture_output=True,
                         text=True,
                     )
-                    target_path = (
-                        pathlib.Path(path.strip("/")) / "pyproject.toml"
-                        if path
-                        else pathlib.Path("pyproject.toml")
-                    )
+                    target_path = pathlib.Path(_get_target_path(path))
 
                     # Restore just the pyproject_toml file
                     restore_cmd = [
@@ -424,7 +467,29 @@ async def fetch_upstream_config(
         content = await asyncio.to_thread(_git_clone_and_read)
         return StringIO(content)
 
-    return await download(url, client)
+    try:
+        return await download(url, client)
+    except httpx.HTTPStatusError as e:
+        msg = f"HTTP error {e.response.status_code} when downloading from {url}"
+        git_url = to_git_url(url)
+        if git_url:
+            # sys.argv[1] might be -v or something else when running via pytest
+            try:
+                cmd = sys.argv[1]
+                if cmd not in ("pull", "check"):
+                    cmd = "pull"
+            except IndexError:
+                cmd = "pull"
+            msg += (
+                f"\n\n💡 Check the URL and your permissions. "
+                "You might want to try cloning via git instead:\n\n"
+                f"   ruff-sync {cmd} {git_url}"
+            )
+        else:
+            msg += "\n\n💡 Check the URL and your permissions."
+
+        # Re-raise with a more helpful message while preserving the original exception context
+        raise httpx.HTTPStatusError(msg, request=e.request, response=e.response) from None
 
 
 def is_ruff_toml_file(path_or_url: str) -> bool:

{ruff_sync-0.0.4.dev1 → ruff_sync-0.0.5.dev1}/tests/test_url_handling.py

@@ -1,9 +1,32 @@
 from __future__ import annotations
 
+import httpx
 import pytest
-from httpx import URL
+from httpx import URL, AsyncClient
 
-from ruff_sync import resolve_raw_url
+from ruff_sync import fetch_upstream_config, is_ruff_toml_file, resolve_raw_url, to_git_url
+
+
+@pytest.mark.parametrize(
+    "path_or_url,expected",
+    [
+        ("ruff.toml", True),
+        (".ruff.toml", True),
+        ("configs/ruff.toml", True),
+        ("pyproject.toml", False),
+        ("https://example.com/ruff.toml", True),
+        ("https://example.com/ruff.toml?ref=main", True),
+        ("https://example.com/ruff.toml#L10", True),
+        ("https://example.com/path/to/ruff.toml?query=1#frag", True),
+        ("https://example.com/pyproject.toml?file=ruff.toml", False),
+        ("https://example.com/ruff.toml/other", False),
+        # Case where it's not a URL but has query/fragment characters
+        ("ruff.toml?raw=1", True),
+        ("ruff.toml#section", True),
+    ],
+)
+def test_is_ruff_toml_file(path_or_url: str, expected: bool):
+    assert is_ruff_toml_file(path_or_url) is expected
 
 
 @pytest.mark.parametrize(
@@ -111,3 +134,85 @@ def test_raw_url_with_branch_and_path(input_url: str, branch: str, path: str, ex
     url = URL(input_url)
     result = resolve_raw_url(url, branch=branch, path=path)
     assert str(result) == expected_url
+
+
+@pytest.mark.parametrize(
+    "input_url, expected_git_url",
+    [
+        # GitHub Browser URLs
+        (
+            "https://github.com/pydantic/pydantic/blob/main/pyproject.toml",
+            "git@github.com:pydantic/pydantic.git",
+        ),
+        (
+            "https://github.com/org/repo/blob/develop/config/ruff.toml",
+            "git@github.com:org/repo.git",
+        ),
+        # GitHub Repo URLs
+        (
+            "https://github.com/pydantic/pydantic",
+            "git@github.com:pydantic/pydantic.git",
+        ),
+        # GitHub Raw URLs
+        (
+            "https://raw.githubusercontent.com/pydantic/pydantic/main/pyproject.toml",
+            "git@github.com:pydantic/pydantic.git",
+        ),
+        # GitLab Repo URLs
+        (
+            "https://gitlab.com/gitlab-org/gitlab",
+            "git@gitlab.com:gitlab-org/gitlab.git",
+        ),
+        (
+            "https://gitlab.com/gitlab-org/nested/group/sub-a/sub-b/project",
+            "git@gitlab.com:gitlab-org/nested/group/sub-a/sub-b/project.git",
+        ),
+        # GitLab Blob URLs
+        (
+            "https://gitlab.com/gitlab-org/gitlab/-/blob/master/pyproject.toml",
+            "git@gitlab.com:gitlab-org/gitlab.git",
+        ),
+        # Already git URLs
+        (
+            "git@github.com:org/repo.git",
+            "git@github.com:org/repo.git",
+        ),
+        # Non-matching URLs
+        (
+            "https://example.com/pyproject.toml",
+            None,
+        ),
+    ],
+)
+def test_to_git_url(input_url: str, expected_git_url: str | None):
+    url = URL(input_url)
+    result = to_git_url(url)
+    if expected_git_url is None:
+        assert result is None
+    else:
+        assert str(result) == expected_git_url
+
+
+@pytest.mark.asyncio
+async def test_fetch_upstream_config_http_error_with_git_suggestion(monkeypatch):
+    url = URL("https://github.com/org/repo/blob/main/pyproject.toml")
+
+    async def mock_get(*args, **kwargs):
+        # Create a mock response with 404 status
+        request = httpx.Request("GET", url)
+        response = httpx.Response(404, request=request)
+        response.raise_for_status()
+
+    # We need to mock the client's get method
+    # Since fetch_upstream_config uses the client passed to it
+
+    async with AsyncClient() as client:
+        monkeypatch.setattr(client, "get", mock_get)
+
+        with pytest.raises(httpx.HTTPStatusError) as excinfo:
+            await fetch_upstream_config(url, client, branch="main", path="")
+
+        error_msg = str(excinfo.value)
+        assert "HTTP error 404" in error_msg
+        assert "git@github.com:org/repo.git" in error_msg
+        assert "ruff-sync pull" in error_msg

{ruff_sync-0.0.4.dev1 → ruff_sync-0.0.5.dev1}/uv.lock

@@ -990,7 +990,7 @@ wheels = [
 
 [[package]]
 name = "ruff-sync"
-version = "0.0.4.dev1"
+version = "0.0.5.dev1"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },

ruff_sync-0.0.4.dev1/tests/test_url_parsing.py

@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-import pytest
-
-from ruff_sync import is_ruff_toml_file
-
-
-@pytest.mark.parametrize(
-    "path_or_url,expected",
-    [
-        ("ruff.toml", True),
-        (".ruff.toml", True),
-        ("configs/ruff.toml", True),
-        ("pyproject.toml", False),
-        ("https://example.com/ruff.toml", True),
-        ("https://example.com/ruff.toml?ref=main", True),
-        ("https://example.com/ruff.toml#L10", True),
-        ("https://example.com/path/to/ruff.toml?query=1#frag", True),
-        ("https://example.com/pyproject.toml?file=ruff.toml", False),
-        ("https://example.com/ruff.toml/other", False),
-        # Case where it's not a URL but has query/fragment characters
-        ("ruff.toml?raw=1", True),
-        ("ruff.toml#section", True),
-    ],
-)
-def test_is_ruff_toml_file(path_or_url: str, expected: bool):
-    assert is_ruff_toml_file(path_or_url) is expected
-
-
-if __name__ == "__main__":
-    pytest.main([__file__, "-vv"])