feat(ex/import): Settings export and import by command and menu.

Author: walkthunder

src/langs/en.json

@@ -37,6 +37,8 @@
   "command_startsync": "start sync the folder",
   "command_startsync_file": "start sync current file",
   "command_forcesync": "Force full synchronization",
+  "command_import_settings": "Import settings from clipboard",
+  "command_export_settings": "Export settings to clipboard",
   "command_drynrun": "start sync (dry run only)",
   "command_exportsyncplans_json": "export sync plans in json format",
   "command_exportsyncplans_table": "export sync plans in table format",

src/langs/zh_cn.json

@@ -37,6 +37,8 @@
   "command_startsync": "开始同步文件夹",
   "command_startsync_file": "开始同步当前文件",
   "command_forcesync": "强制全量同步",
+  "command_import_settings": "剪切板导入配置",
+  "command_export_settings": "导出配置到剪贴板",
   "command_drynrun": "开始同步（空跑模式）",
   "command_exportsyncplans_json": "导出同步计划为 json 格式（export sync plans in json format）",
   "command_exportsyncplans_table": "导出同步计划为表格格式（export sync plans in table format）",

src/langs/zh_tw.json

@@ -37,6 +37,8 @@
   "command_startsync": "开始同步文件夹",
   "command_startsync_file": "开始同步当前文件",
   "command_forcesync": "强制全量同步",
+  "command_import_settings": "剪切板导入配置",
+  "command_export_settings": "导出配置到剪贴板",
   "command_drynrun": "开始同步（空跑模式）",
   "command_exportsyncplans_json": "匯出同步計劃為 json 格式（export sync plans in json format）",
   "command_exportsyncplans_table": "匯出同步計劃為表格格式（export sync plans in table format）",

src/main.ts

@@ -709,7 +709,7 @@ export default class InvioPlugin extends Plugin {
             .setIcon("document")
           })
 
-          if (file.path !== this.settings.localWatchDir) {
+          if ((file.path !== this.settings.localWatchDir) && (file.path.indexOf('/') < 0) ) {
             menu.addItem((item) => {
               item
                 .setTitle(`${Menu_Tab}Set as working folder`)
@@ -727,6 +727,14 @@ export default class InvioPlugin extends Plugin {
                   this.syncRun("manual")
                 });
             })
+            menu.addItem((item) => {
+              item
+                .setTitle(`${Menu_Tab}Share This Folder`)
+                .setIcon("document")
+                .onClick(async () => {
+                  await InvioSettingTab.exportSettings(this)
+                });
+            })
           }
           menu.addSeparator();
         } else if (file instanceof TFile) {
@@ -886,6 +894,26 @@ export default class InvioPlugin extends Plugin {
       }
     })
 
+    this.addCommand({
+      id: 'export-settings',
+      name: t('command_export_settings'),
+      icon: iconNameSyncLogo,
+      callback: async () => {
+        await InvioSettingTab.exportSettings(this);
+      }
+    })
+
+
+    this.addCommand({
+      id: 'import-settings',
+      name: t('command_import_settings'),
+      icon: iconNameSyncLogo,
+      callback: async () => {
+        const str = await navigator.clipboard.readText();
+        InvioSettingTab.importSettings(this, str);
+      }
+    })
+
     this.addSettingTab(new InvioSettingTab(this.app, this));
 
     // this.registerDomEvent(document, "click", (evt: MouseEvent) => {

src/settings.ts

@@ -32,7 +32,7 @@ import {
   insertLoggerOutputByVault,
   clearExpiredLoggerOutputRecords,
 } from "./localdb";
-import type InvioPlugin from "./main"; // unavoidable
+import InvioPlugin from "./main"; // unavoidable
 import { RemoteClient } from "./remote";
 import { messyConfigToNormal } from "./configPersist";
 import type { TransItemType } from "./i18n";
@@ -46,6 +46,8 @@ import {
   restoreLogWritterInplace,
 } from "./moreOnLog";
 
+const settingsPrefix = `Invio-Settings>`;
+const settingsSuffix = `<&`
 class PasswordModal extends Modal {
   plugin: InvioPlugin;
   newPassword: string;
@@ -354,6 +356,45 @@ export class InvioSettingTab extends PluginSettingTab {
     plugin.saveSettings();
   }
 
+
+  static async exportSettings(plugin: InvioPlugin) {
+    const t = (x: TransItemType, vars?: any) => {
+      return plugin.i18n.t(x, vars);
+    };
+    const data = await plugin.loadData();
+    await navigator.clipboard.writeText(`${settingsPrefix} ${data.d} ${settingsSuffix}`);
+    new Notice(t("settings_export_msg"));
+  }
+
+  static async importSettings(plugin: InvioPlugin, restoredStr: string) {
+    const t = (x: TransItemType, vars?: any) => {
+      return plugin.i18n.t(x, vars);
+    };
+    if (!restoredStr) {
+      new Notice(t("settings_import_err")); 
+      return;
+    }
+    if (!(restoredStr.startsWith(settingsPrefix) && restoredStr.endsWith(settingsSuffix))) {
+      new Notice(t("settings_import_err"));
+      return;
+    }
+
+    await plugin.loadSettings(restoredStr.replace(settingsPrefix, '').replace(settingsSuffix, '').trim());
+    // Create dir if necessary.
+    const dir = plugin.settings.localWatchDir;
+    if (dir && (typeof dir === 'string')) {
+      await mkdirpInVault(dir, plugin.app.vault);
+      await plugin.switchWorkingDir(dir);
+
+      setTimeout(() => {
+        plugin.syncRun('auto');
+      }, 100)
+    } else {
+      log.error('Imported settings not configured correctly.')
+    }
+    await plugin.saveSettings();
+  }
+
   display(): void {
     let { containerEl } = this;
 
@@ -838,18 +879,15 @@ export class InvioSettingTab extends PluginSettingTab {
       text: t("settings_importexport"),
     });
 
-    const settingsPrefix = `Invio-Settings>`;
-    const settingsSuffix = `<&`
+
     new Setting(importExportDiv)
       .setName(t("settings_export"))
       .setDesc(t("settings_export_desc"))
       .addButton(async (button) => {
         button.setButtonText(t("settings_export_desc_button"));
         button.onClick(async () => {
           // new ExportSettingsQrCodeModal(this.app, this.plugin).open();
-          const data = await this.plugin.loadData();
-          await navigator.clipboard.writeText(`${settingsPrefix} ${data.d} ${settingsSuffix}`);
-          new Notice(t("settings_export_msg"));
+          InvioSettingTab.exportSettings(this.plugin);
         });
       });
 
@@ -868,29 +906,7 @@ export class InvioSettingTab extends PluginSettingTab {
       .addButton(async (button) => {
         button.setButtonText(t("settings_import_desc_button"));
         button.onClick(async () => {
-          if (!restoredStr) {
-            new Notice(t("settings_import_err")); 
-            return;
-          }
-          if (!(restoredStr.startsWith(settingsPrefix) && restoredStr.endsWith(settingsSuffix))) {
-            new Notice(t("settings_import_err"));
-            return;
-          }
-
-          await this.plugin.loadSettings(restoredStr.replace(settingsPrefix, '').replace(settingsSuffix, '').trim());
-          // Create dir if necessary.
-          const dir = this.plugin.settings.localWatchDir;
-          if (dir && (typeof dir === 'string')) {
-            await mkdirpInVault(dir, this.plugin.app.vault);
-            await this.plugin.switchWorkingDir(dir);
-
-            setTimeout(() => {
-              this.plugin.syncRun('auto');
-            }, 100)
-          } else {
-            log.error('Imported settings not configured correctly.')
-          }
-          await this.plugin.saveSettings();
+          await InvioSettingTab.importSettings(this.plugin, restoredStr);
           this.hide();
           this.display();
         });