tests(config-variations): Git schemes in repo URLs (#490)

tony · web-flow · commit 00acfa15d219 · 2025-06-22T08:53:46.000-05:00
Related to vcs-python/vcspull#49, vcs-python/vcspull#426 **In main repo URLs:** Main repo URLs require `libvcs.url.git.GitURL` support: Scheme: `user@domain.tld:org/repo.git` Example: `git@github.com:tmux-python/tmuxp.git` Note: The workaround is to prepend `git+ssh://git@github.com:tmux-python/tmuxp.git`
diff --git a/CHANGES b/CHANGES
@@ -11,7 +11,12 @@ $ pip install --user --upgrade --pre libvcs
 
 ## libvcs 0.36.x (unreleased)
 
-- _Notes on upcoming releases will be added here_
+### Iprovements
+
+- Add support for SCP-style Git URLs without requiring `git+ssh://` prefix (#490)
+  - URLs like `git@github.com:org/repo.git` are now recognized as Git repositories
+  - `create_project()` can now auto-detect VCS type for these URLs
+  - Addresses issues reported in [vcspull#49](https://github.com/vcs-python/vcspull/issues/49) and [vcspull#426](https://github.com/vcs-python/vcspull/pull/426)
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
diff --git a/docs/url/registry.md b/docs/url/registry.md
@@ -12,7 +12,7 @@ Detect VCS from `git`, `hg`, and `svn` URLs.
 [ParserMatch(vcs='git', match=GitURL(...))]
 
 >>> registry.match('git@invent.kde.org:plasma/plasma-sdk.git', is_explicit=True)
-[]
+[ParserMatch(vcs='git', match=GitURL(...))]
 
 >>> registry.match('git+ssh://git@invent.kde.org:plasma/plasma-sdk.git')
 [ParserMatch(vcs='git', match=GitURL(...))]
diff --git a/src/libvcs/_internal/shortcuts.py b/src/libvcs/_internal/shortcuts.py
@@ -68,6 +68,17 @@ def create_project(
 ) -> HgSync: ...
 
 
+@t.overload
+def create_project(
+    *,
+    url: str,
+    path: StrPath,
+    vcs: None = None,
+    progress_callback: ProgressCallbackProtocol | None = None,
+    **kwargs: dict[t.Any, t.Any],
+) -> GitSync | HgSync | SvnSync: ...
+
+
 def create_project(
     *,
     url: str,
@@ -98,6 +109,15 @@ def create_project(
     ...     path=tmp_path
     ... )
 
+    >>> isinstance(r, GitSync)
+    True
+
+    It also supports unprefixed SSH-style Git URLs:
+
+    >>> r = create_project(
+    ...     url='git@github.com:tmux-python/tmuxp.git',
+    ...     path=tmp_path
+    ... )
     >>> isinstance(r, GitSync)
     True
     """
diff --git a/src/libvcs/url/git.py b/src/libvcs/url/git.py
@@ -61,6 +61,7 @@
         """,
             re.VERBOSE,
         ),
+        is_explicit=True,
     ),
     # ends with .git. Including ones starting with https://
     # e.g. https://github.com/vcs-python/libvcs.git
@@ -77,6 +78,7 @@
             re.VERBOSE,
         ),
         defaults={"username": "git"},
+        is_explicit=True,
     ),
     # SCP-style URLs, e.g. git@
 ]
@@ -392,7 +394,7 @@ def is_valid(cls, url: str, is_explicit: bool | None = None) -> bool:
         >>> GitBaseURL.is_valid(
         ...     url='git@github.com:vcs-python/libvcs.git', is_explicit=True
         ... )
-        False
+        True
 
         In this case, check :meth:`GitPipURL.is_valid` or :meth:`GitURL.is_valid`'s
         examples.
@@ -764,7 +766,7 @@ def is_valid(cls, url: str, is_explicit: bool | None = None) -> bool:
         >>> GitURL.is_valid(
         ...     url='git@github.com:vcs-python/libvcs.git', is_explicit=True
         ... )
-        False
+        True
 
         You could create a GitHub rule that consider github.com hostnames to be
         exclusively git:
diff --git a/tests/test_shortcuts.py b/tests/test_shortcuts.py
@@ -70,3 +70,11 @@ def test_create_project(
     else:
         repo = create_project(**repo_dict)
         assert isinstance(repo, repo_class)
+
+
+def test_create_project_infer_scp_git(tmp_path: pathlib.Path) -> None:
+    """Test create_project infers Git VCS for SCP-style URLs."""
+    url = "git@github.com:tmux-python/tmuxp.git"
+    path = tmp_path / "tmuxp_repo"
+    repo = create_project(url=url, path=path)
+    assert isinstance(repo, GitSync)
diff --git a/tests/url/test_registry.py b/tests/url/test_registry.py
@@ -53,6 +53,8 @@ class DetectVCSFixture(t.NamedTuple):
             "codecommit::ap-northeast-1://MyDemoRepo",
             "https://git-codecommit.us-east-1.amazonaws.com/v1/repos/test",
             "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/test",
+            # plain SCP-style Git URLs should be recognized explicitly
+            "git@github.com:tmux-python/tmuxp.git",
         ]
     ],
     *[

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,8 @@ class DetectVCSFixture(t.NamedTuple):`
`53`	`53`	`"codecommit::ap-northeast-1://MyDemoRepo",`
`54`	`54`	`"https://git-codecommit.us-east-1.amazonaws.com/v1/repos/test",`
`55`	`55`	`"ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/test",`
	`56`	`+ # plain SCP-style Git URLs should be recognized explicitly`
	`57`	`+ "git@github.com:tmux-python/tmuxp.git",`
`56`	`58`	`]`
`57`	`59`	`],`
`58`	`60`	`*[`