Improvements to repo cloning.

Author: desrosj

tools/gutenberg/checkout.js

@@ -3,22 +3,18 @@
 /**
  * Checkout Gutenberg Repository Script
  *
- * This script checks out the Gutenberg repository at a specific commit/branch/tag
- * as specified in the root package.json's "gutenberg" configuration.
- *
- * It handles:
- * - Initial clone if directory doesn't exist
- * - Updating existing checkout to correct ref
- * - Installing dependencies with npm ci
- * - Idempotent operation (safe to run multiple times)
+ * Clones the Gutenberg repository at the SHA pinned in package.json into the
+ * gutenberg/ directory, then installs its dependencies. Only runs in local
+ * repository mode (GUTENBERG_LOCAL_REPO=true). Pass --force to remove an
+ * existing clone and start fresh.
  *
  * @package WordPress
  */
 
 const { spawn } = require( 'child_process' );
 const fs = require( 'fs' );
 const path = require( 'path' );
-const { readGutenbergConfig, isLocalRepoMode, isGutenbergRepoClone, writeRepoHash } = require( './utils' );
+const { readGutenbergConfig, isLocalRepoMode, writeRepoHash } = require( './utils' );
 
 // Constants
 const GUTENBERG_REPO = 'https://github.com/WordPress/gutenberg.git';
@@ -98,15 +94,14 @@ async function main( force ) {
 		return;
 	}
 
-	if ( ! force && isGutenbergRepoClone() ) {
-		console.log( 'ℹ️  The `gutenberg` directory is already a git clone.' );
+	if ( ! force && fs.existsSync( gutenbergDir ) ) {
+		console.log( 'ℹ️  The `gutenberg` directory already exists.' );
 		console.log( '   Use `npm run grunt gutenberg:checkout -- --force` to remove and re-clone.' );
 		return;
 	}
 
 	console.log( '🔍 Checking Gutenberg configuration...' );
 
-	// Read Gutenberg SHA from package.json
 	let ref;
 	try {
 		( { sha: ref } = readGutenbergConfig() );
@@ -117,79 +112,41 @@ async function main( force ) {
 		process.exit( 1 );
 	}
 
-	// Check if Gutenberg directory exists
-	const gutenbergExists = fs.existsSync( gutenbergDir );
-
-	if ( ! gutenbergExists ) {
-		console.log( '\n📥 Cloning Gutenberg repository (shallow clone)...' );
-		try {
-			/*
-			 * Generic shallow clone approach that works for both branches and commit hashes.
-			 * 1. Clone with no checkout and shallow depth.
-			 */
-			await exec( 'git', [
-				'clone',
-				'--depth',
-				'1',
-				'--no-checkout',
-				GUTENBERG_REPO,
-				'gutenberg',
-			] );
-
-			// 2. Fetch the specific ref with depth 1 (works for branches, tags, and commits)
-			await exec( 'git', [ 'fetch', '--depth', '1', 'origin', ref ], {
-				cwd: gutenbergDir,
-			} );
-
-			// 3. Checkout FETCH_HEAD
-			await exec( 'git', [ 'checkout', 'FETCH_HEAD' ], {
-				cwd: gutenbergDir,
-			} );
-
-			console.log( '✅ Cloned successfully' );
-		} catch ( error ) {
-			console.error( '❌ Clone failed:', error.message );
-			process.exit( 1 );
-		}
-	} else {
-		console.log( '\n✅ Gutenberg directory already exists' );
+	if ( force && fs.existsSync( gutenbergDir ) ) {
+		console.log( '\n🗑️  Removing existing gutenberg directory...' );
+		fs.rmSync( gutenbergDir, { recursive: true, force: true } );
 	}
 
-	// Fetch and checkout target ref
-	console.log( `\n📡 Fetching and checking out: ${ ref }` );
+	console.log( '\n📥 Cloning Gutenberg repository (shallow clone)...' );
 	try {
-		// Fetch the specific ref (works for branches, tags, and commit hashes).
+		/*
+		 * Two-step shallow clone that works for both branches and commit SHAs.
+		 * `git clone` alone cannot shallow-clone an arbitrary commit hash, so
+		 * we clone with --no-checkout then fetch the pinned ref explicitly.
+		 */
+		await exec( 'git', [
+			'clone',
+			'--depth', '1',
+			'--no-checkout',
+			GUTENBERG_REPO,
+			'gutenberg',
+		] );
+
 		await exec( 'git', [ 'fetch', '--depth', '1', 'origin', ref ], {
 			cwd: gutenbergDir,
 		} );
 
-		if ( force ) {
-			// Hard-reset the index and working tree to FETCH_HEAD, discarding any local modifications.
-			await exec( 'git', [ 'reset', '--hard', 'FETCH_HEAD' ], {
-				cwd: gutenbergDir,
-			} );
-		} else {
-			await exec( 'git', [ 'checkout', 'FETCH_HEAD' ], {
-				cwd: gutenbergDir,
-			} );
-		}
+		await exec( 'git', [ 'checkout', 'FETCH_HEAD' ], {
+			cwd: gutenbergDir,
+		} );
 
-		console.log( '✅ Checked out successfully' );
+		console.log( '✅ Cloned successfully' );
 	} catch ( error ) {
-		console.error( '❌ Fetch/checkout failed:', error.message );
+		console.error( '❌ Clone failed:', error.message );
 		process.exit( 1 );
 	}
 
-	// Install dependencies
-	console.log( '\n📦 Installing dependencies...' );
-	const nodeModulesExists = fs.existsSync(
-		path.join( gutenbergDir, 'node_modules' )
-	);
-
-	if ( ! nodeModulesExists ) {
-		console.log( '   (This may take a few minutes on first run)' );
-	}
-
+	console.log( '\n📦 Installing dependencies (this may take a few minutes)...' );
 	try {
 		await exec( 'npm', [ 'ci' ], { cwd: gutenbergDir } );
 		console.log( '✅ Dependencies installed' );

tools/gutenberg/utils.js

@@ -126,7 +126,7 @@ function verifyGutenbergVersion() {
 		const currentSha = result.stdout.trim();
 		if ( currentSha !== sha ) {
 			console.warn(
-				`⚠️  Gutenberg HEAD (${ currentSha.slice( 0, 12 ) }) does not match the expected SHA (${ sha.slice( 0, 12 ) }).` +
+				`⚠️ Gutenberg HEAD (${ currentSha.slice( 0, 12 ) }) does not match the expected SHA (${ sha.slice( 0, 12 ) }).` +
 				` Run \`npm run grunt gutenberg:checkout -- --force\` to reset to the expected SHA.`
 			);
 		} else {