Merge branch 'fix/gutenberg-clean-before-build' into fix/missing-new-files

Author: desrosj

Gruntfile.js

@@ -47,7 +47,7 @@ module.exports = function(grunt) {
 			'wp-includes/js/',
 		],
 
-		// All files copied from the Gutenberg repository excluded from version control.
+		// Unversioned files copied from the Gutenberg repository.
 		gutenbergFiles = [
 			'wp-includes/js/dist',
 			'wp-includes/css/dist',
@@ -56,6 +56,14 @@ module.exports = function(grunt) {
 			'wp-includes/icons',
 		],
 
+		// Files copied from Gutenberg subject to version control.
+		gutenbergVersionedFiles = [
+			'wp-includes/images/icon-library',
+			'wp-includes/build',
+			'wp-includes/blocks/*',
+			'!wp-includes/blocks/index.php',
+		],
+
 		// All files built by Webpack, in /src or /build.
 		// Webpack only builds Core-specific media files and development scripts.
 		// Blocks, packages, script modules, and vendors come from the Gutenberg build.
@@ -246,6 +254,25 @@ module.exports = function(grunt) {
 			gutenberg: gutenbergFiles.map( function( file ) {
 				return setFilePath( WORKING_DIR, file );
 			}),
+
+			/*
+			 * Delete directories and files subjet to version control where the contents come from Gutenberg.
+			 *
+			 * This handles instances where a file remains present even after being deleted upstream.
+			 *
+			 * This task is intentionally skipped unless the current task will re-copy the corresponding files.
+			 */
+			'gutenberg-versioned': {
+				filter: function() {
+					var allowedTasks = [ 'build', 'build:dev', 'build:gutenberg', 'clean:gutenberg-versioned' ];
+					return allowedTasks.some( function( task ) {
+						return grunt.cli.tasks.indexOf( task ) !== -1;
+					} );
+				},
+				src: gutenbergVersionedFiles.map( function( file ) {
+					return setFilePath( SOURCE_DIR, file );
+				} ),
+			},
 			dynamic: {
 				dot: true,
 				expand: true,
@@ -667,7 +694,7 @@ module.exports = function(grunt) {
 						'constants.php',
 						'pages/**/*.php',
 					],
-					dest: WORKING_DIR + 'wp-includes/build/',
+					dest: SOURCE_DIR + 'wp-includes/build/',
 				} ],
 			},
 			/*
@@ -684,7 +711,7 @@ module.exports = function(grunt) {
 				expand: true,
 				cwd: 'gutenberg/build',
 				src: [],
-				dest: WORKING_DIR + 'wp-includes/build/',
+				dest: SOURCE_DIR + 'wp-includes/build/',
 			},
 			'gutenberg-js': {
 				files: [ {
@@ -693,7 +720,7 @@ module.exports = function(grunt) {
 					src: [
 						'pages/**/*.js',
 					],
-					dest: WORKING_DIR + 'wp-includes/build/',
+					dest: SOURCE_DIR + 'wp-includes/build/',
 				} ],
 			},
 			'gutenberg-modules': {
@@ -707,7 +734,7 @@ module.exports = function(grunt) {
 						// with no debugging value over the minified versions.
 						'!vips/!(*.min).js',
 					],
-					dest: WORKING_DIR + 'wp-includes/js/dist/script-modules/',
+					dest: SOURCE_DIR + 'wp-includes/js/dist/script-modules/',
 				} ],
 			},
 			'gutenberg-styles': {
@@ -720,7 +747,7 @@ module.exports = function(grunt) {
 						// Per-block CSS is copied to wp-includes/blocks/ by tools/gutenberg/copy.js.
 						'!block-library/*/**',
 					],
-					dest: WORKING_DIR + 'wp-includes/css/dist/',
+					dest: SOURCE_DIR + 'wp-includes/css/dist/',
 				} ],
 			},
 			'gutenberg-theme-json': {
@@ -739,11 +766,11 @@ module.exports = function(grunt) {
 				files: [
 					{
 						src: 'gutenberg/lib/theme.json',
-						dest: WORKING_DIR + 'wp-includes/theme.json',
+						dest: SOURCE_DIR + 'wp-includes/theme.json',
 					},
 					{
 						src: 'gutenberg/lib/theme-i18n.json',
-						dest: WORKING_DIR + 'wp-includes/theme-i18n.json',
+						dest: SOURCE_DIR + 'wp-includes/theme-i18n.json',
 					},
 				],
 			},
@@ -752,7 +779,7 @@ module.exports = function(grunt) {
 					expand: true,
 					cwd: 'gutenberg/packages/icons/src/library',
 					src: '*.svg',
-					dest: WORKING_DIR + 'wp-includes/images/icon-library',
+					dest: SOURCE_DIR + 'wp-includes/images/icon-library',
 				} ],
 			},
 			'icon-library-manifest': {
@@ -774,7 +801,7 @@ module.exports = function(grunt) {
 				},
 				files: [ {
 					src: 'gutenberg/packages/icons/src/manifest.php',
-					dest: WORKING_DIR + 'wp-includes/assets/icon-library-manifest.php',
+					dest: SOURCE_DIR + 'wp-includes/assets/icon-library-manifest.php',
 				} ],
 			},
 		},
@@ -1678,10 +1705,9 @@ module.exports = function(grunt) {
 
 	grunt.registerTask( 'gutenberg:copy', 'Copies Gutenberg JS packages and block assets to WordPress Core.', function() {
 		const done = this.async();
-		const buildDir = grunt.option( 'dev' ) ? 'src' : 'build';
 		grunt.util.spawn( {
 			cmd: 'node',
-			args: [ 'tools/gutenberg/copy.js', `--build-dir=${ buildDir }` ],
+			args: [ 'tools/gutenberg/copy.js' ],
 			opts: { stdio: 'inherit' }
 		}, function( error ) {
 			done( ! error );
@@ -2158,6 +2184,8 @@ module.exports = function(grunt) {
 	} );
 
 	grunt.registerTask( 'build:gutenberg', [
+		'gutenberg:verify',
+		'clean:gutenberg-versioned',
 		'clean:gutenberg',
 		'copy:gutenberg-php',
 		'routes:setup',
@@ -2174,24 +2202,22 @@ module.exports = function(grunt) {
 	grunt.registerTask( 'build', function() {
 		if ( grunt.option( 'dev' ) ) {
 			grunt.task.run( [
-				'gutenberg:verify',
+				'build:gutenberg',
 				'build:js',
 				'build:css',
 				'build:codemirror',
-				'build:gutenberg',
-				'build:certificates'
+				'build:certificates',
 			] );
 		} else {
 			grunt.task.run( [
-				'gutenberg:verify',
-				'build:certificates',
+				'build:gutenberg',
 				'build:files',
 				'build:js',
 				'build:css',
 				'build:codemirror',
-				'build:gutenberg',
+				'build:certificates',
 				'replace:source-maps',
-				'verify:build'
+				'verify:build',
 			] );
 		}
 	} );

tools/gutenberg/copy.js

@@ -19,21 +19,10 @@ const rootDir = path.resolve( __dirname, '../..' );
 const gutenbergDir = path.join( rootDir, 'gutenberg' );
 const gutenbergBuildDir = path.join( gutenbergDir, 'build' );
 
-/*
- * Determine build target from command line argument (--dev or --build-dir).
- * Default to 'src' for development.
- */
-const args = process.argv.slice( 2 );
-const buildDirArg = args.find( ( arg ) => arg.startsWith( '--build-dir=' ) );
-const buildTarget = buildDirArg
-	? buildDirArg.split( '=' )[ 1 ]
-	: args.includes( '--dev' )
-	? 'src'
-	: 'build';
-
-const wpIncludesDir = path.join( rootDir, buildTarget, 'wp-includes' );
+// All files handled in this script are subject to version control, so they should always be placed into src/.
+const wpIncludesDir = path.join( rootDir, 'src', 'wp-includes' );
 
-/**
+/*
  * Copy configuration.
  * Defines what to copy from Gutenberg build and where it goes in Core.
  */
@@ -508,7 +497,7 @@ function generateBlocksJson() {
  * Main execution function.
  */
 async function main() {
-	console.log( `📦 Copying Gutenberg build to ${ buildTarget }/...` );
+	console.log( '📦 Copying versioned Gutenberg files to src/...' );
 
 	if ( ! fs.existsSync( gutenbergBuildDir ) ) {
 		console.error( '❌ Gutenberg build directory not found' );