Combine community plugins sync config

Author: suho

README.md

@@ -157,7 +157,7 @@ No. History here is based on Google Drive revisions, not Obsidian Sync snapshots
 
 ### Does it sync all `.obsidian` files?
 
-No. Only configured categories are synced (for example editor settings, appearance, hotkeys, community plugin list).
+No. Only configured categories are synced (for example editor settings, appearance, hotkeys, community plugins).
 Unsafe and transient files (for example workspace and cache files) are intentionally excluded.
 
 ## Known limitations

src/main.ts

@@ -26,6 +26,12 @@ interface LegacySelectiveSyncSettings {
 	syncNonImageFiles?: boolean;
 }
 
+interface LegacyVaultConfigSyncSettings {
+	syncCommunityPluginList?: boolean;
+	syncCommunityPluginFiles?: boolean;
+	syncCommunityPlugins?: boolean;
+}
+
 function resolveLegacyNonImageSyncSetting(
 	settings: LegacySelectiveSyncSettings | null
 ): boolean | null {
@@ -46,6 +52,22 @@ function resolveLegacyNonImageSyncSetting(
 	return legacyValues.some(value => value);
 }
 
+function resolveLegacyCommunityPluginSyncSetting(
+	settings: LegacyVaultConfigSyncSettings | null
+): boolean | null {
+	if (!settings || typeof settings.syncCommunityPlugins === 'boolean') {
+		return null;
+	}
+
+	const hasLegacyList = typeof settings.syncCommunityPluginList === 'boolean';
+	const hasLegacyFiles = typeof settings.syncCommunityPluginFiles === 'boolean';
+	if (!hasLegacyList && !hasLegacyFiles) {
+		return null;
+	}
+
+	return !!settings.syncCommunityPluginList || !!settings.syncCommunityPluginFiles;
+}
+
 export default class GDriveSyncPlugin extends Plugin {
 	settings: GDrivePluginSettings;
 	authManager!: GoogleAuthManager;
@@ -256,12 +278,27 @@ export default class GDriveSyncPlugin extends Plugin {
 	}
 
 	async loadSettings() {
-		const loaded = await this.loadData() as (Partial<GDrivePluginSettings> & LegacySelectiveSyncSettings) | null;
+		const loaded = await this.loadData() as (
+			Partial<GDrivePluginSettings> &
+			LegacySelectiveSyncSettings &
+			LegacyVaultConfigSyncSettings
+		) | null;
 		this.settings = Object.assign({}, DEFAULT_SETTINGS, loaded ?? {});
+		let shouldPersist = false;
 
 		const migratedNonImageSync = resolveLegacyNonImageSyncSetting(loaded);
 		if (migratedNonImageSync !== null) {
 			this.settings.syncNonImageFiles = migratedNonImageSync;
+			shouldPersist = true;
+		}
+
+		const migratedCommunityPluginSync = resolveLegacyCommunityPluginSyncSetting(loaded);
+		if (migratedCommunityPluginSync !== null) {
+			this.settings.syncCommunityPlugins = migratedCommunityPluginSync;
+			shouldPersist = true;
+		}
+
+		if (shouldPersist) {
 			await this.saveData(this.settings);
 		}
 	}

src/settings.ts

@@ -68,9 +68,8 @@ export interface GDrivePluginSettings {
 	syncEditorSettings: boolean;
 	syncAppearance: boolean;
 	syncHotkeys: boolean;
-	syncCommunityPluginList: boolean;
+	syncCommunityPlugins: boolean;
 	syncCorePluginSettings: boolean;
-	syncCommunityPluginFiles: boolean;
 
 	// Internal state
 	setupComplete: boolean;        // false triggers the setup wizard on first load
@@ -115,9 +114,8 @@ export const DEFAULT_SETTINGS: GDrivePluginSettings = {
 	syncEditorSettings: true,
 	syncAppearance: true,
 	syncHotkeys: false,
-	syncCommunityPluginList: false,
+	syncCommunityPlugins: false,
 	syncCorePluginSettings: false,
-	syncCommunityPluginFiles: false,
 
 	// Internal
 	setupComplete: false,
@@ -468,12 +466,12 @@ export class GDriveSettingTab extends PluginSettingTab {
 			);
 
 		new Setting(containerEl)
-			.setName('Sync community plugin list')
-			.setDesc('Sync community-plugins.json only, not plugin binaries.')
+			.setName('Sync community plugins')
+			.setDesc('Sync community-plugins.json plus each installed plugin\'s manifest.json, data.json, styles.css, and main.js.')
 			.addToggle(t =>
-				t.setValue(this.plugin.settings.syncCommunityPluginList).onChange(v => {
+				t.setValue(this.plugin.settings.syncCommunityPlugins).onChange(v => {
 					void this.updateSelectiveSyncSettings(() => {
-						this.plugin.settings.syncCommunityPluginList = v;
+						this.plugin.settings.syncCommunityPlugins = v;
 					});
 				})
 			);
@@ -489,17 +487,6 @@ export class GDriveSettingTab extends PluginSettingTab {
 				})
 			);
 
-		new Setting(containerEl)
-			.setName('Sync community plugin files')
-			.setDesc('Sync manifest.json, data.json, styles.css, and main.js for each installed community plugin.')
-			.addToggle(t =>
-				t.setValue(this.plugin.settings.syncCommunityPluginFiles).onChange(v => {
-					void this.updateSelectiveSyncSettings(() => {
-						this.plugin.settings.syncCommunityPluginFiles = v;
-					});
-				})
-			);
-
 		// ── Version history ───────────────────────────────────────────
 		new Setting(containerEl).setName('Version history').setHeading();
 

src/sync/SyncManager.ts

@@ -96,9 +96,8 @@ export interface SelectiveSyncSnapshot {
 	syncEditorSettings: boolean;
 	syncAppearance: boolean;
 	syncHotkeys: boolean;
-	syncCommunityPluginList: boolean;
+	syncCommunityPlugins: boolean;
 	syncCorePluginSettings: boolean;
-	syncCommunityPluginFiles: boolean;
 }
 
 interface CleanupDuplicateArtifactsOptions {
@@ -1455,9 +1454,8 @@ export class SyncManager {
 			syncEditorSettings: this.plugin.settings.syncEditorSettings,
 			syncAppearance: this.plugin.settings.syncAppearance,
 			syncHotkeys: this.plugin.settings.syncHotkeys,
-			syncCommunityPluginList: this.plugin.settings.syncCommunityPluginList,
+			syncCommunityPlugins: this.plugin.settings.syncCommunityPlugins,
 			syncCorePluginSettings: this.plugin.settings.syncCorePluginSettings,
-			syncCommunityPluginFiles: this.plugin.settings.syncCommunityPluginFiles,
 		};
 	}
 

src/sync/exclusions.ts

@@ -24,9 +24,8 @@ type SelectiveSettings = Pick<
 	| 'syncEditorSettings'
 	| 'syncAppearance'
 	| 'syncHotkeys'
-	| 'syncCommunityPluginList'
+	| 'syncCommunityPlugins'
 	| 'syncCorePluginSettings'
-	| 'syncCommunityPluginFiles'
 >;
 
 export interface ExclusionDescriptionContext {
@@ -139,9 +138,9 @@ function isAllowedVaultConfigPath(relativePath: string, settings: SelectiveSetti
 	if (relativePath === 'app.json') return settings.syncEditorSettings;
 	if (relativePath === 'appearance.json') return settings.syncAppearance;
 	if (relativePath === 'hotkeys.json') return settings.syncHotkeys;
-	if (relativePath === 'community-plugins.json') return settings.syncCommunityPluginList;
+	if (relativePath === 'community-plugins.json') return settings.syncCommunityPlugins;
 	if (isCorePluginSettingsPath(relativePath)) return settings.syncCorePluginSettings;
-	if (isCommunityPluginAssetPath(relativePath)) return settings.syncCommunityPluginFiles;
+	if (isCommunityPluginAssetPath(relativePath)) return settings.syncCommunityPlugins;
 	if (relativePath.startsWith('themes/') || relativePath.startsWith('snippets/')) return settings.syncAppearance;
 	return false;
 }
@@ -341,13 +340,13 @@ export function describeUserAdjustableExclusionReason(
 			return `Vault config file "${configPathLabel}" is disabled by Sync hotkeys.`;
 		}
 		if (relativePath === 'community-plugins.json') {
-			return `Vault config file "${configPathLabel}" is disabled by Sync community plugin list.`;
+			return `Vault config file "${configPathLabel}" is disabled by Sync community plugins.`;
 		}
 		if (relativePath && isCorePluginSettingsPath(relativePath)) {
 			return `Vault config file "${configPathLabel}" is disabled by Sync core plugin settings.`;
 		}
 		if (relativePath && isCommunityPluginAssetPath(relativePath)) {
-			return `Vault config file "${configPathLabel}" is disabled by Sync community plugin files.`;
+			return `Vault config file "${configPathLabel}" is disabled by Sync community plugins.`;
 		}
 		if (relativePath?.startsWith('themes/') || relativePath?.startsWith('snippets/')) {
 			return `Vault config path "${configPathLabel}" is disabled by Sync appearance.`;