Add .deployignore support to Site Sync

apps/cli/commands/export.ts

@@ -1,10 +1,12 @@
 import path from 'path';
 import { DEFAULT_PHP_VERSION } from '@studio/common/constants';
+import { createDeployIgnoreFilter } from '@studio/common/lib/deploy-ignore';
 import {
 	ExportEvents,
 	ExportEventTuple,
 	ExportIpcEvent,
 } from '@studio/common/lib/import-export-events';
+import { SYNC_IGNORE_DEFAULTS } from '@studio/common/lib/sync/constants';
 import { SiteCommandLoggerAction as LoggerAction } from '@studio/common/logger-actions';
 import { __, _n, sprintf } from '@wordpress/i18n';
 import { getSiteByFolder } from 'cli/lib/cli-config/sites';
@@ -124,7 +126,8 @@ export async function runCommand(
 	exportPath: string,
 	mode: 'full' | 'content' | 'db' = 'full',
 	splitDbDumpByTable = false,
-	includeOnlyPaths?: string[]
+	includeOnlyPaths?: string[],
+	applyDeployIgnore = false
 ): Promise< void > {
 	try {
 		logger.reportStart( LoggerAction.START_DAEMON, __( 'Starting process daemon…' ) );
@@ -150,13 +153,18 @@ export async function runCommand(
 			includes.database = false;
 		}
 
+		const ignoreFilter = applyDeployIgnore
+			? await createDeployIgnoreFilter( site.path, SYNC_IGNORE_DEFAULTS )
+			: undefined;
+
 		const exporter = await getExporter( {
 			site,
 			backupFile: exportPath,
 			phpVersion: DEFAULT_PHP_VERSION,
 			includes,
 			splitDatabaseDumpByTable: splitDbDumpByTable,
 			specificSelectionPaths: includeOnlyPaths,
+			ignoreFilter,
 		} );
 
 		if ( ! exporter ) {
@@ -230,6 +238,12 @@ export const registerCommand = ( yargs: StudioArgv ) => {
 						return value.map( String );
 					},
 					hidden: true,
+				} )
+				.option( 'apply-deploy-ignore', {
+					type: 'boolean',
+					default: false,
+					description: __( 'Apply .deployignore patterns when exporting' ),
+					hidden: true,
 				} );
 		},
 		handler: async ( argv ) => {
@@ -262,7 +276,8 @@ export const registerCommand = ( yargs: StudioArgv ) => {
 					exportFile,
 					argv.mode,
 					argv.splitDbDumpByTable,
-					argv.includeOnly
+					argv.includeOnly,
+					argv.applyDeployIgnore
 				);
 			} catch ( error ) {
 				if ( error instanceof LoggerError ) {

apps/cli/commands/push.ts

@@ -1,8 +1,10 @@
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
+import { createDeployIgnoreFilter } from '@studio/common/lib/deploy-ignore';
 import { readAuthToken } from '@studio/common/lib/shared-config';
 import {
+	SYNC_IGNORE_DEFAULTS,
 	SYNC_MAX_STALLED_ATTEMPTS,
 	SYNC_POLL_INTERVAL_MS,
 	SYNC_PUSH_SIZE_LIMIT_BYTES,
@@ -105,13 +107,16 @@ export async function runCommand(
 			};
 		}
 
+		const deployIgnore = await createDeployIgnoreFilter( site.path, SYNC_IGNORE_DEFAULTS );
+
 		const exporter = await getExporter( {
 			site,
 			backupFile: archivePath,
 			includes,
 			phpVersion: site.phpVersion,
 			splitDatabaseDumpByTable: true,
 			specificSelectionPaths,
+			ignoreFilter: deployIgnore,
 		} );
 
 		if ( ! exporter ) {

apps/cli/commands/tests/export.test.ts

@@ -11,6 +11,10 @@ import { Logger, LoggerError } from 'cli/logger';
 import { registerCommand, runCommand } from '../export';
 import type { SiteData } from 'cli/lib/cli-config/core';
 
+vi.mock( '@studio/common/lib/deploy-ignore', () => ( {
+	createDeployIgnoreFilter: vi.fn().mockResolvedValue( { ignores: vi.fn() } ),
+} ) );
+
 function getYargsArgvMock() {
 	return yargs().option( 'path', {
 		type: 'string',
@@ -82,10 +86,21 @@ describe( 'CLI: studio export', () => {
 			},
 			specificSelectionPaths: undefined,
 			splitDatabaseDumpByTable: false,
+			ignoreFilter: undefined,
 		} );
 		expect( disconnectFromDaemon ).toHaveBeenCalled();
 	} );
 
+	it( 'applies deploy-ignore filter when applyDeployIgnore is set', async () => {
+		await runCommand( testSitePath, testExportPath, 'full', false, undefined, true );
+
+		expect( getExporter ).toHaveBeenCalledWith(
+			expect.objectContaining( {
+				ignoreFilter: expect.objectContaining( { ignores: expect.any( Function ) } ),
+			} )
+		);
+	} );
+
 	it( 'maps export events to logger actions', async () => {
 		const reportStartSpy = vi.spyOn( Logger.prototype, 'reportStart' );
 		const reportProgressSpy = vi.spyOn( Logger.prototype, 'reportProgress' );

apps/cli/lib/import-export/export/exporters/default-exporter.ts

@@ -17,7 +17,13 @@ import { getWordPressVersionFromInstallation } from 'cli/lib/dependency-manageme
 import { runWpCliCommand } from 'cli/lib/run-wp-cli-command';
 import { ImportExportEventEmitter } from '../../events';
 import { exportDatabaseToFile, exportDatabaseToMultipleFiles } from '../export-database';
-import { ExportOptions, BackupContents, Exporter, StudioJson } from '../types';
+import {
+	ExportOptions,
+	BackupContents,
+	Exporter,
+	StudioJson,
+	StudioJsonPluginOrTheme,
+} from '../types';
 
 export class DefaultExporter extends ImportExportEventEmitter implements Exporter {
 	private archiveBuilder!: archiver.Archiver;
@@ -208,6 +214,10 @@ export class DefaultExporter extends ImportExportEventEmitter implements Exporte
 					continue;
 				}
 
+				if ( this.options.ignoreFilter?.ignores( archivePath ) ) {
+					continue;
+				}
+
 				const stat = await fsPromises.stat( fullPath );
 				if ( stat.isDirectory() ) {
 					this.archiveBuilder.directory( fullPath, archivePath, ( entry ) => {
@@ -218,14 +228,18 @@ export class DefaultExporter extends ImportExportEventEmitter implements Exporte
 						);
 						if (
 							this.isExactPathExcluded( entryPathRelativeToArchiveRoot ) ||
-							this.isPathExcludedByPattern( fullEntryPathOnDisk )
+							this.isPathExcludedByPattern( fullEntryPathOnDisk ) ||
+							this.options.ignoreFilter?.ignores( entryPathRelativeToArchiveRoot )
 						) {
 							return false;
 						}
 						return entry;
 					} );
 				} else {
-					if ( this.isExactPathExcluded( archivePath ) ) {
+					if (
+						this.isExactPathExcluded( archivePath ) ||
+						this.options.ignoreFilter?.ignores( archivePath )
+					) {
 						continue;
 					}
 					this.archiveBuilder.file( fullPath, { name: archivePath } );
@@ -284,8 +298,18 @@ export class DefaultExporter extends ImportExportEventEmitter implements Exporte
 			this.getSiteThemes( this.options.site.path ),
 		] );
 
-		studioJson.plugins = plugins;
-		studioJson.themes = themes;
+		studioJson.plugins = this.options.ignoreFilter
+			? plugins.filter(
+					( p: StudioJsonPluginOrTheme ) =>
+						! this.options.ignoreFilter!.ignores( `wp-content/plugins/${ p.name }` )
+			  )
+			: plugins;
+		studioJson.themes = this.options.ignoreFilter
+			? themes.filter(
+					( t: StudioJsonPluginOrTheme ) =>
+						! this.options.ignoreFilter!.ignores( `wp-content/themes/${ t.name }` )
+			  )
+			: themes;
 
 		const tempDir = await fsPromises.mkdtemp( path.join( os.tmpdir(), 'studio-export-' ) );
 		const studioJsonPath = path.join( tempDir, 'meta.json' );

apps/cli/lib/import-export/export/types.ts

@@ -1,5 +1,6 @@
 import { SiteData } from 'cli/lib/cli-config/core';
 import type { ImportExportEventEmitter } from '../events';
+import type { Ignore } from 'ignore';
 
 export interface ExportOptions {
 	site: SiteData;
@@ -8,6 +9,7 @@ export interface ExportOptions {
 	phpVersion: string;
 	splitDatabaseDumpByTable?: boolean;
 	specificSelectionPaths?: string[];
+	ignoreFilter?: Ignore;
 }
 
 export type ExportOptionsIncludes = 'wpContent' | 'database';

apps/cli/lib/sync-file-tree.ts

@@ -1,27 +1,37 @@
 import fs from 'fs';
 import nodePath from 'path';
-import { shouldExcludeFromSync, shouldLimitDepth } from '@studio/common/lib/sync/tree-utils';
+import { createDeployIgnoreFilter } from '@studio/common/lib/deploy-ignore';
+import { SYNC_IGNORE_DEFAULTS } from '@studio/common/lib/sync/constants';
+import { shouldExcludeFromSync } from '@studio/common/lib/sync/exclude-from-sync';
+import { shouldLimitDepth } from '@studio/common/lib/sync/tree-utils';
 import type { RawDirectoryEntry } from '@studio/common/types/sync-tree';
+import type { Ignore } from 'ignore';
 
 export async function listLocalFileTree(
 	sitePath: string,
 	relativePath: string,
 	maxDepth: number = 2,
-	currentDepth: number = 0
+	currentDepth: number = 0,
+	deployIgnore?: Ignore
 ): Promise< RawDirectoryEntry[] > {
+	if ( ! deployIgnore ) {
+		deployIgnore = await createDeployIgnoreFilter( sitePath, SYNC_IGNORE_DEFAULTS );
+	}
+
 	const fullPath = nodePath.join( sitePath, relativePath );
 
 	try {
 		const entries = await fs.promises.readdir( fullPath, { withFileTypes: true } );
 		const result: RawDirectoryEntry[] = [];
 
 		for ( const entry of entries ) {
-			if ( shouldExcludeFromSync( entry.name ) ) {
+			const itemPath = nodePath.join( relativePath, entry.name ).replace( /\\/g, '/' );
+
+			if ( shouldExcludeFromSync( itemPath, deployIgnore ) ) {
 				continue;
 			}
 
 			const isDirectory = entry.isDirectory();
-			const itemPath = nodePath.join( relativePath, entry.name ).replace( /\\/g, '/' );
 
 			const directoryEntry: RawDirectoryEntry = {
 				name: entry.name,
@@ -36,7 +46,8 @@ export async function listLocalFileTree(
 						sitePath,
 						itemPath,
 						maxDepth,
-						currentDepth + 1
+						currentDepth + 1,
+						deployIgnore
 					);
 				} catch {
 					directoryEntry.children = [];

apps/cli/package.json

@@ -43,6 +43,7 @@
 		"cli-table3": "^0.6.5",
 		"fs-extra": "^11.3.4",
 		"http-proxy": "^1.18.1",
+		"ignore": "^7.0.5",
 		"node-forge": "^1.3.3",
 		"patch-package": "^8.0.1",
 		"picospinner": "^3.0.0",

apps/studio/package.json

@@ -57,6 +57,7 @@
 		"fs-extra": "^11.3.2",
 		"hpagent": "1.2.0",
 		"http-proxy": "^1.18.1",
+		"ignore": "^7.0.5",
 		"lockfile": "^1.0.4",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",

apps/studio/src/ipc-handlers.ts

@@ -34,6 +34,7 @@ import {
 } from '@studio/common/lib/agent-skills';
 import { validateBlueprintData } from '@studio/common/lib/blueprint-validation';
 import { parseCliError, errorMessageContains } from '@studio/common/lib/cli-error';
+import { createDeployIgnoreFilter } from '@studio/common/lib/deploy-ignore';
 import { extractZip } from '@studio/common/lib/extract-zip';
 import {
 	calculateDirectorySizeForArchive,
@@ -55,7 +56,9 @@ import {
 	readSharedConfig,
 	updateSharedConfig,
 } from '@studio/common/lib/shared-config';
-import { shouldExcludeFromSync, shouldLimitDepth } from '@studio/common/lib/sync/tree-utils';
+import { SYNC_IGNORE_DEFAULTS } from '@studio/common/lib/sync/constants';
+import { shouldExcludeFromSync } from '@studio/common/lib/sync/exclude-from-sync';
+import { shouldLimitDepth } from '@studio/common/lib/sync/tree-utils';
 import { isWordPressDevVersion } from '@studio/common/lib/wordpress-version-utils';
 import { __, sprintf, LocaleData, defaultI18n } from '@wordpress/i18n';
 import {
@@ -120,6 +123,7 @@ import { Blueprint } from 'src/stores/wpcom-api';
 import { captureSiteThumbnail } from './lib/capture-site-thumbnail';
 import type { AiSessionSummary, LoadedAiSession } from '@studio/common/ai/sessions/types';
 import type { RawDirectoryEntry } from '@studio/common/types/sync-tree';
+import type { Ignore } from 'ignore';
 import type { WpCliResult } from 'src/site-server';
 
 export {
@@ -1845,24 +1849,30 @@ export async function listLocalFileTree(
 	siteId: string,
 	path: string,
 	maxDepth: number = 3,
-	currentDepth: number = 0
+	currentDepth: number = 0,
+	deployIgnore?: Ignore
 ): Promise< RawDirectoryEntry[] > {
 	const server = SiteServer.get( siteId );
 	if ( ! server ) throw new Error( 'Site not found' );
 
+	if ( ! deployIgnore ) {
+		deployIgnore = await createDeployIgnoreFilter( server.details.path, SYNC_IGNORE_DEFAULTS );
+	}
+
 	const fullPath = nodePath.join( server.details.path, path );
 
 	try {
 		const entries = await fs.promises.readdir( fullPath, { withFileTypes: true } );
 		const result = [];
 
 		for ( const entry of entries ) {
-			if ( shouldExcludeFromSync( entry.name ) ) {
+			const itemPath = nodePath.join( path, entry.name ).replace( /\\/g, '/' );
+
+			if ( shouldExcludeFromSync( itemPath, deployIgnore ) ) {
 				continue;
 			}
 
 			const isDirectory = entry.isDirectory();
-			const itemPath = nodePath.join( path, entry.name ).replace( /\\/g, '/' );
 
 			const directoryEntry: RawDirectoryEntry = {
 				name: entry.name,
@@ -1878,7 +1888,8 @@ export async function listLocalFileTree(
 						siteId,
 						itemPath,
 						maxDepth,
-						currentDepth + 1
+						currentDepth + 1,
+						deployIgnore
 					);
 				} catch ( childErr ) {
 					console.warn( `Failed to load children for ${ itemPath }:`, childErr );

apps/studio/src/modules/import-export/lib/ipc-handlers.ts

@@ -180,6 +180,7 @@ type ExportOptions = {
 	showNotification?: boolean;
 	splitDatabaseDumpByTable?: boolean;
 	specificSelectionPaths?: string[];
+	applyDeployIgnore?: boolean;
 	abortSignal?: AbortSignal;
 };
 
@@ -201,6 +202,7 @@ export async function exportSite(
 		showNotification = false,
 		splitDatabaseDumpByTable = false,
 		specificSelectionPaths = [],
+		applyDeployIgnore = false,
 		abortSignal,
 	} = options;
 
@@ -211,6 +213,10 @@ export async function exportSite(
 		args.push( '--split-db-dump-by-table' );
 	}
 
+	if ( applyDeployIgnore ) {
+		args.push( '--apply-deploy-ignore' );
+	}
+
 	if ( specificSelectionPaths.length > 0 ) {
 		args.push( '--include-only', ...specificSelectionPaths );
 	}

apps/studio/src/modules/sync/lib/ipc-handlers.ts

@@ -190,6 +190,7 @@ export async function exportSiteForPush(
 			mode,
 			splitDatabaseDumpByTable: true,
 			specificSelectionPaths: configuration?.specificSelectionPaths,
+			applyDeployIgnore: true,
 			abortSignal: abortController.signal,
 		} );