feat!: support hj clone --fork

Author: gaojunran

docs/.vitepress/config.mts

@@ -77,7 +77,9 @@ export default defineConfig({
 
         socialLinks: [
           { icon: 'github', link: 'https://github.com/gaojunran/hj' }
-        ]
+        ],
+
+        outline: [2, 3]
       }
     }
   },

docs/cn/clone.md

@@ -26,7 +26,9 @@ hj clone https://github.com/gaojunran/hj.git
 
 来克隆一个仓库。
 
-这样写并不简练！你可以用仓库全名来替代一个长 url：
+### 使用仓库全名替代 URL
+
+使用 URL 并不简练！你需要去网页中手动复制粘贴一个地址。你可以用仓库全名来替代一个长 URL：
 
 ```sh
 hj clone gaojunran/hj
@@ -48,7 +50,7 @@ hj clone gaojunran/hj  # 默认 host 是 gitlab.com
 hj clone hj # 默认 user 是 gaojunran
 ```
 
----
+### 指定目标文件夹
 
 也可以指定目标文件夹路径。默认是远程仓库的名字。如果你这样执行：
 
@@ -58,6 +60,16 @@ hj clone gaojunran/hj .  # 关注最后的 . 表示当前文件夹
 
 那么仓库内容将被克隆在当前文件夹内，而不是新建一个文件夹。
 
+### Fork 并克隆
+
+对于一个 GitHub 仓库，你可以用一行命令 Fork 某个仓库并克隆自己的分叉：
+
+```sh
+hj clone gaojunran/hj --fork
+```
+
+---
+
 ## 下载仓库
 
 很多情况下我们使用 GitHub 上的仓库，并不需要其历史版本，例如：

docs/cn/commit.md

@@ -46,6 +46,8 @@ hj commit "feat: add new feature"
 
 :::
 
+---
+
 ## 重命名提交
 
 ::: details 对于熟悉 git 的用户
@@ -68,6 +70,8 @@ hj describe REVSET -m "new message"
 
 `REVSET` 处填写一个具体的提交，如 `@-` 表示最近的一次提交；`-m` 参数填写新的提交描述信息。
 
+---
+
 ## 为提交增补变更
 
 ::: details 对于熟悉 git 的用户
@@ -217,6 +221,19 @@ hj squash -i --from A --into B
 
 ---
 
+
+## 从提交中移除变更
+
+上文中我们提到了 `hj reset` 可以把一个提交中的变更（默认为最新提交）撤回到工作副本。还有一个命令：
+
+```sh
+hj throw @-
+```
+
+可以交互式地将一个提交中的变更删除。它不会被移动到某个提交中，而是被丢弃掉。如果不指定提交，默认是工作副本提交。
+
+---
+
 ## 拆分提交
 
 ::: details 对于熟悉 git 的用户
@@ -252,6 +269,8 @@ hj split -r A -d B
 
 更多用法参见 [jj split](https://jj-vcs.github.io/jj/latest/cli-reference/#jj-split)。
 
+---
+
 ## 复制提交
 
 ::: details 对于熟悉 git 的用户
@@ -331,15 +350,3 @@ hj abandon REVSET
 这将移除这个提交，并将其子提交变基到其父提交上。
 
 特别地，如果不指定 `REVSET`，将默认为工作副本（`@`）。此时会清空工作副本的所有变更，并自动地创建一个新工作副本提交。
-
----
-
-## 从提交中移除变更
-
-上文中我们提到了 `hj reset` 可以把一个提交中的变更（默认为最新提交）撤回到工作副本。还有一个命令：
-
-```sh
-hj throw @-
-```
-
-可以交互式地将一个提交中的变更删除。它不会被移动到某个提交中，而是被丢弃掉。如果不指定提交，默认是工作副本提交。

docs/cn/faq.md

@@ -76,17 +76,17 @@ hj 的理念有所不同，「简单」是我们的第一设计理念。我们
 > ✅ 表示已经实现，🚧 表示正在实现，🤔 表示未来计划。你也可以在 [Issues](https://github.com/gaojunran/hj/issues) 里提出你的想法！
 
 - ✅　`clone` 支持省略 `owner`。
-- 🚧　`hj clone --fork`
+- ✅　`hj clone --fork`
+- ✅　`hj commit` 和 `hj describe` 时支持打开编辑器进行多行描述的编辑。
+- ✅　提供 Hooks 支持。
+- 🤔　发布到 scoop、homebrew；编写 PowerShell script 和 bash script。
 - 🤔　`hj download` 下载单个文件(夹) 时直接下载到指定的目录，而不包含远程仓库中的文件夹结构。
 - 🤔　`hj init` 时支持下载 `.gitignore`。（[来源](https://github.com/github/gitignore)）
 - 🤔　全面支持 GitLab。
-- ✅　`hj commit` 和 `hj describe` 时支持打开编辑器进行多行描述的编辑。
 - 🤔　`hj rollback`：交互式选择要回退的命令。
 - 🤔　优化与 Git 仓库共存时的体验。
-- 🤔　发布到 scoop、homebrew；编写 PowerShell script 和 bash script。
 - 🤔　提供更多与 `hj log` 相关的简化命令。
 - 🤔　完善的 Stacked PR 支持。
-- 🚧　提供 Hooks 支持。
 
 ## hj 是如何实现的？
 

hj.toml

@@ -1,2 +1,2 @@
 [hooks]
-post_commit = "just install"  # use just to install hj to PATH automatically
+post_commit = "just post-commit"  # use just to install hj to PATH automatically

src/clone.rs

@@ -8,13 +8,19 @@ pub(crate) fn command_clone(
     source: &str,
     destination: Option<&str>,
     colocate: bool,
+    fork: bool,
 ) -> anyhow::Result<()> {
-    let url = build_url(
+    let (mut url, mut user, _) = build_info(
         &config.clone.default_host,
         config.clone.default_user.as_deref(),
         source,
     )
     .ok_or(anyhow::anyhow!("Invalid URL or fullname"))?;
+    if fork && let Some(forker) = &config.clone.default_user {
+        cmd!("gh", "repo", "fork", &url).run()?;
+        url = url.replacen(&(user.clone() + "/"), &(forker.clone() + "/"), 1);
+        user = forker.to_string(); // unused now
+    }
     let mut args = vec!["git", "clone", &url];
     if let Some(destination) = destination {
         args.push(destination);
@@ -26,24 +32,37 @@ pub(crate) fn command_clone(
     Ok(())
 }
 
-fn build_url(
+pub(crate) fn build_info(
     default_host: &str,
     default_user: Option<&str>,
     url_or_fullname: &str,
-) -> Option<String> {
-    let re_url = Regex::new(r"^https://[^\s]*?\.git$").unwrap();
-    let re_fullname = Regex::new(r"^[^/]+/[^/]+$").unwrap();
+) -> Option<(String, String, String)> {
+    let re_url = Regex::new(r"^https://([^/]+)/([^/]+)/([^.]+)\.git$").unwrap();
+    let re_fullname = Regex::new(r"^([^/]+)/([^/]+)$").unwrap();
     let re_repo = Regex::new(r"^[^/]+$").unwrap();
 
-    if re_url.is_match(url_or_fullname) {
-        Some(url_or_fullname.to_string())
-    } else if re_fullname.is_match(url_or_fullname) {
+    if let Some(caps) = re_url.captures(url_or_fullname) {
+        // let _host = caps.get(1).unwrap().as_str();
+        let user = caps.get(2).unwrap().as_str();
+        let repo = caps.get(3).unwrap().as_str();
+        Some((
+            url_or_fullname.to_string(),
+            user.to_string(),
+            repo.to_string(),
+        ))
+    } else if let Some(caps) = re_fullname.captures(url_or_fullname) {
         // user/repo
-        Some(format!("https://{}/{}.git", default_host, url_or_fullname))
+        let user = caps.get(1).unwrap().as_str();
+        let repo = caps.get(2).unwrap().as_str();
+        let url = format!("https://{}/{}/{}.git", default_host, user, repo);
+        Some((url, user.to_string(), repo.to_string()))
     } else if re_repo.is_match(url_or_fullname) {
-        // pass repo only, needs `default_user`
-        default_user
-            .map(|user| format!("https://{}/{}/{}.git", default_host, user, url_or_fullname))
+        // repo only
+        default_user.map(|user| {
+            let repo = url_or_fullname;
+            let url = format!("https://{}/{}/{}.git", default_host, user, repo);
+            (url, user.to_string(), repo.to_string())
+        })
     } else {
         None
     }

src/download.rs

@@ -10,6 +10,7 @@ use std::io::Write;
 use std::path::{Path, PathBuf};
 use tar::Archive;
 
+use crate::clone::build_info;
 use crate::config::AppConfig;
 
 #[derive(Debug, Deserialize)]
@@ -30,7 +31,8 @@ pub(crate) fn command_download(
     destination: Option<&str>,
     entries: Vec<String>,
 ) -> Result<()> {
-    let (owner, repo) = parse_repo(source).context("Invalid URL or fullname")?;
+    let (_, owner, repo) = build_info("", config.clone.default_user.as_deref(), source)
+        .context("Invalid URL or fullname")?;
     let base_path = destination.unwrap_or(&repo);
 
     let mut headers = HeaderMap::new();

src/main.rs

@@ -74,6 +74,10 @@ enum Commands {
         /// Whether to colocate or not.
         #[arg(short, long, alias = "git")]
         colocate: bool,
+
+        /// Fork a github repo and clone your fork
+        #[arg(short, long)]
+        fork: bool,
     },
 
     /// Create a commit.
@@ -304,8 +308,10 @@ fn main() {
             source,
             destination,
             colocate,
+            fork,
         } => {
-            if let Err(e) = command_clone(&config, source, destination.as_deref(), *colocate) {
+            if let Err(e) = command_clone(&config, source, destination.as_deref(), *colocate, *fork)
+            {
                 error(&e.to_string());
             }
         }