chore: manually clone git modules instead of using submodules (#2274)

closes #2231

Submodules are a blocker for beginners, we should make it clone on
demand.

It is also a blocker for people who wants to target this repo as a crate
for testing purposes, cargo will do a full clone if you specify
oxc_parser = { git = "this repo" } in Cargo.toml

.github/workflows/codecov.yml

@@ -22,14 +22,17 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          submodules: true # Pull submodules for `cargo coverage`
 
       - name: Install Rust Toolchain
         uses: ./.github/actions/rustup
 
       - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@cargo-llvm-cov
+        uses: taiki-e/install-action
+        with:
+          tool: cargo-llvm-cov,just
+
+      - name: Clone modules
+        run: just submodules
 
       - name: Install llvm-tools-preview for llvm-cov
         run: rustup component add llvm-tools-preview

.github/workflows/conformance.yml

@@ -42,12 +42,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          submodules: true # Pull submodules for `cargo coverage`
 
       - name: Install Rust Toolchain
         uses: ./.github/actions/rustup
 
+      - name: Install just
+        uses: taiki-e/install-action
+        with:
+          tool: just
+
+      - name: Clone modules
+        run: just submodules
+
       - name: Set up Bun
         uses: oven-sh/setup-bun@v1
 

justfile

@@ -23,10 +23,12 @@ ready:
   just lint
   git status
 
-# Update our local branch with the remote branch (this is for you to sync the git submodules)
-update:
-  git submodule sync
-  git submodule update --init --recursive
+# Clone or update submodules
+submodules:
+  just clone-submodule tasks/coverage/test262 [email protected]:tc39/test262.git 17ba9aea47e496f5b2bc6ce7405b3f32e3cfbf7a
+  just clone-submodule tasks/coverage/babel [email protected]:babel/babel.git eccbd203383487f6957dcf086aa83d773691560b
+  just clone-submodule tasks/coverage/typescript [email protected]:microsoft/TypeScript.git 64d2eeea7b9c7f1a79edf42cb99f302535136a2e
+  just clone-submodule tasks/prettier_conformance/prettier [email protected]:prettier/prettier.git ff83d55d05e92ceef10ec0cb1c0272ab894a00a0
 
 # --no-vcs-ignores: cargo-watch has a bug loading all .gitignores, including the ones listed in .gitignore
 # use .ignore file getting the ignore list
@@ -115,10 +117,10 @@ new-react-perf-rule name:
 new-n-rule name:
     cargo run -p rulegen {{name}} n
 
-# Sync all submodules with their own remote repos (this is for Boshen updating the submodules)
-sync-submodules:
-  git submodule update --init --remote
-
 # Upgrade all Rust dependencies
 upgrade:
   cargo upgrade --incompatible
+
+clone-submodule dir url sha:
+  git clone --depth=1 {{url}} {{dir}} || true
+  cd {{dir}} && git fetch origin {{sha}} && git reset --hard {{sha}}

tasks/coverage/src/suite.rs

@@ -111,15 +111,15 @@ pub trait Suite<T: Case> {
         if paths.is_empty() {
             println!("-------------------------------------------------------");
             println!("git submodule is empty for {name}");
-            println!("Running `git submodule update --init`");
+            println!("Running `just submodules` to clone the submodules");
             println!("This may take a while.");
             println!("-------------------------------------------------------");
-            Command::new("git")
-                .args(["submodule", "update", "--init", "--progress"])
+            Command::new("just")
+                .args(["submodules"])
                 .stdout(Stdio::inherit())
                 .stderr(Stdio::inherit())
                 .output()
-                .expect("failed to execute `git submodule update --init`");
+                .expect("failed to execute `just submodules`");
             paths = get_paths();
         }