Add .deployignore support to Site Sync

apps/studio/src/ipc-handlers.ts

@@ -24,6 +24,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 {
 	calculateDirectorySizeForArchive,
 	isWordPressDirectory,
@@ -93,6 +94,7 @@ import {
 import { editSiteViaCli, EditSiteOptions } from 'src/modules/cli/lib/cli-site-editor';
 import { isStudioCliInstalled } from 'src/modules/cli/lib/ipc-handlers';
 import { STABLE_BIN_DIR_PATH } from 'src/modules/cli/lib/windows-installation-manager';
+import { SYNC_ADDITIONAL_DEFAULTS } from 'src/modules/sync/constants';
 import { shouldExcludeFromSync, shouldLimitDepth } from 'src/modules/sync/lib/tree-utils';
 import { supportedEditorConfig, SupportedEditor } from 'src/modules/user-settings/lib/editor';
 import { getUserEditor, getUserTerminal } from 'src/modules/user-settings/lib/ipc-handlers';
@@ -107,6 +109,7 @@ import {
 	updateAppdata,
 } from 'src/storage/user-data';
 import { Blueprint } from 'src/stores/wpcom-api';
+import type { Ignore } from 'ignore';
 import type { RawDirectoryEntry } from 'src/modules/sync/types';
 import type { WpCliResult } from 'src/site-server';
 
@@ -1635,24 +1638,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_ADDITIONAL_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,
@@ -1668,7 +1677,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/lib/import-export/export/exporters/default-exporter.ts

@@ -226,14 +226,20 @@ export class DefaultExporter extends EventEmitter implements Exporter {
 						);
 						if (
 							this.isExactPathExcluded( entryPathRelativeToArchiveRoot ) ||
-							this.isPathExcludedByPattern( fullEntryPathOnDisk )
+							this.isPathExcludedByPattern( fullEntryPathOnDisk ) ||
+							this.options.deployIgnore?.ignores(
+								entryPathRelativeToArchiveRoot.replace( /\\/g, '/' )
+							)
 						) {
 							return false;
 						}
 						return entry;
 					} );
 				} else {
-					if ( this.isExactPathExcluded( archivePath ) ) {
+					if (
+						this.isExactPathExcluded( archivePath ) ||
+						this.options.deployIgnore?.ignores( archivePath.replace( /\\/g, '/' ) )
+					) {
 						continue;
 					}
 					this.archiveBuilder.file( fullPath, { name: archivePath } );

apps/studio/src/lib/import-export/export/types.ts

@@ -1,5 +1,6 @@
 import type { ProgressData } from 'archiver';
 import type { EventEmitter } from 'events';
+import type { Ignore } from 'ignore';
 
 export interface ExportOptions {
 	site: SiteDetails;
@@ -8,6 +9,7 @@ export interface ExportOptions {
 	phpVersion: string;
 	splitDatabaseDumpByTable?: boolean;
 	specificSelectionPaths?: string[];
+	deployIgnore?: Ignore;
 }
 
 export type ExportOptionsIncludes = 'wpContent' | 'database';

apps/studio/src/modules/sync/constants.ts

@@ -1,11 +1,11 @@
-export const SYNC_EXCLUSIONS = [
+/**
+ * Studio-internal exclusions that should always be excluded from sync,
+ * in addition to the base deploy-ignore defaults.
+ */
+export const SYNC_ADDITIONAL_DEFAULTS = [
 	'database',
 	'db.php',
 	'debug.log',
 	'sqlite-database-integration',
-	'.DS_Store',
-	'Thumbs.db',
-	'.git',
-	'node_modules',
 	'cache',
 ];

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

@@ -3,6 +3,7 @@ import fs from 'fs';
 import fsPromises from 'fs/promises';
 import { randomUUID } from 'node:crypto';
 import path from 'node:path';
+import { createDeployIgnoreFilter } from '@studio/common/lib/deploy-ignore';
 import { getCurrentUserId } from '@studio/common/lib/shared-config';
 import wpcomFactory from '@studio/common/lib/wpcom-factory';
 import wpcomXhrRequest from '@studio/common/lib/wpcom-xhr-request-factory';
@@ -20,6 +21,7 @@ import { exportBackup } from 'src/lib/import-export/export/export-manager';
 import { ExportOptions } from 'src/lib/import-export/export/types';
 import { getAuthenticationToken } from 'src/lib/oauth';
 import { keepSqliteIntegrationUpdated } from 'src/lib/sqlite-versions';
+import { SYNC_ADDITIONAL_DEFAULTS } from 'src/modules/sync/constants';
 import { SyncSite } from 'src/modules/sync/types';
 import { SiteServer } from 'src/site-server';
 import { loadUserData, lockAppdata, saveUserData, unlockAppdata } from 'src/storage/user-data';
@@ -163,6 +165,11 @@ export async function exportSiteForPush(
 
 		await keepSqliteIntegrationUpdated( site.details.path );
 
+		const deployIgnore = await createDeployIgnoreFilter(
+			site.details.path,
+			SYNC_ADDITIONAL_DEFAULTS
+		);
+
 		const shouldIncludeSyncOption = (
 			optionsToSync: SyncOption[] | undefined,
 			option: SyncOption
@@ -186,6 +193,7 @@ export async function exportSiteForPush(
 			phpVersion: site.details.phpVersion,
 			splitDatabaseDumpByTable: true,
 			specificSelectionPaths: configuration?.specificSelectionPaths,
+			deployIgnore,
 		};
 
 		const onEvent = () => {};

apps/studio/src/modules/sync/lib/tree-utils.ts

@@ -1,17 +1,13 @@
 import { TreeNode } from 'src/components/tree-view';
-import { SYNC_EXCLUSIONS } from '../constants';
 import type { RawDirectoryEntry } from '../types';
+import type { Ignore } from 'ignore';
 
-export const shouldExcludeFromSync = ( itemName: string ): boolean => {
+export const shouldExcludeFromSync = ( relativePath: string, deployIgnore: Ignore ): boolean => {
+	const itemName = relativePath.split( '/' ).pop() || '';
 	if ( itemName.startsWith( '.' ) ) {
 		return true;
 	}
-
-	if ( SYNC_EXCLUSIONS.includes( itemName ) ) {
-		return true;
-	}
-
-	return false;
+	return deployIgnore.ignores( relativePath );
 };
 
 export const shouldLimitDepth = ( relativePath: string ): boolean => {

tools/common/lib/deploy-ignore.ts

@@ -16,9 +16,16 @@ const DEPLOY_IGNORE_FILENAME = '.deployignore';
  * and any patterns from a .deployignore file at the given root.
  *
  * @param rootPath - The site root directory to look for .deployignore in
+ * @param additionalDefaults - Extra patterns to include as built-in defaults
  */
-export async function createDeployIgnoreFilter( rootPath: string ): Promise< Ignore > {
+export async function createDeployIgnoreFilter(
+	rootPath: string,
+	additionalDefaults?: string[]
+): Promise< Ignore > {
 	const ig = ignore().add( DEPLOY_IGNORE_DEFAULTS );
+	if ( additionalDefaults ) {
+		ig.add( additionalDefaults );
+	}
 
 	const deployIgnorePath = path.join( rootPath, DEPLOY_IGNORE_FILENAME );
 	try {

tools/common/package.json

@@ -13,7 +13,7 @@
 		"cross-port-killer": "^1.4.0",
 		"date-fns": "^3.3.1",
 		"fast-deep-equal": "^3.1.3",
-		"ignore": "^7.0.5",
+		"ignore": "^5.3.2",
 		"lockfile": "^1.0.4",
 		"wpcom": "^7.1.1",
 		"wpcom-xhr-request": "^1.3.0",