refactor: add internal plugin modifications to experimental feature

Author: FlorianWoelki

src/main.ts

@@ -88,20 +88,22 @@ export default class IconizePlugin extends Plugin {
   async onload() {
     console.log(`loading ${config.PLUGIN_NAME}`);
 
-    // Registers all modified internal plugins.
-    // Only adds star plugin for obsidian under v0.12.6.
-    if (!requireApiVersion('0.12.6')) {
-      this.modifiedInternalPlugins.push(new StarredInternalPlugin(this));
-    } else if (requireApiVersion('1.2.0')) {
-      this.modifiedInternalPlugins.push(new BookmarkInternalPlugin(this));
-    }
-
-    this.modifiedInternalPlugins.push(new OutlineInternalPlugin(this));
-
     await this.loadIconFolderData();
     logger.toggleLogging(this.getSettings().debugMode);
     setPath(this.getSettings().iconPacksPath);
 
+    if (this.getSettings().useInternalPlugins) {
+      // Registers all modified internal plugins.
+      // Only adds star plugin for obsidian under v0.12.6.
+      if (!requireApiVersion('0.12.6')) {
+        this.modifiedInternalPlugins.push(new StarredInternalPlugin(this));
+      } else if (requireApiVersion('1.2.0')) {
+        this.modifiedInternalPlugins.push(new BookmarkInternalPlugin(this));
+      }
+
+      this.modifiedInternalPlugins.push(new OutlineInternalPlugin(this));
+    }
+
     await createDefaultDirectory(this);
     await this.checkRecentlyUsedIcons();
 

src/settings/data.ts

@@ -180,6 +180,12 @@ export interface IconFolderSettings {
    * in the console.
    */
   debugMode?: boolean;
+  /**
+   * Adds icons to internal plugins such as the bookmarks and outline plugins.
+   * This is experimental.
+   * @default false
+   */
+  useInternalPlugins?: boolean;
 }
 
 export const DEFAULT_SETTINGS: IconFolderSettings = {
@@ -209,4 +215,5 @@ export const DEFAULT_SETTINGS: IconFolderSettings = {
   iconIdentifier: ':',
   lucideIconPackType: 'native',
   debugMode: false,
+  useInternalPlugins: false,
 };

src/settings/ui/index.ts

@@ -17,6 +17,7 @@ import ToggleIconsInNotes from './toggleIconsInNotes';
 import ToggleIconsInLinks from './toggleIconsInLinks';
 import IconIdentifierSetting from './iconIdentifier';
 import DebugMode from './debugMode';
+import UseInternalPlugins from './useInternalPlugins';
 
 export default class IconFolderSettings extends PluginSettingTab {
   private plugin: IconizePlugin;
@@ -37,6 +38,7 @@ export default class IconFolderSettings extends PluginSettingTab {
     new IconPacksBackgroundChecker(plugin, containerEl).display();
     new EmojiStyleSetting(plugin, containerEl).display();
     new IconIdentifierSetting(plugin, containerEl).display();
+    new UseInternalPlugins(plugin, containerEl).display();
     new DebugMode(plugin, containerEl).display();
 
     containerEl.createEl('h3', { text: 'Visibility of icons' });

src/settings/ui/useInternalPlugins.ts

@@ -0,0 +1,24 @@
+import { Notice, Setting } from 'obsidian';
+import IconFolderSetting from './iconFolderSetting';
+import config from '@app/config';
+
+export default class UseInternalPlugins extends IconFolderSetting {
+  public display(): void {
+    new Setting(this.containerEl)
+      .setName('EXPERIMENTAL: Use internal plugins')
+      .setDesc(
+        'Toggles whether to try to add icons to the bookmark and outline internal plugins.',
+      )
+      .addToggle((toggle) => {
+        toggle
+          .setValue(this.plugin.getSettings().useInternalPlugins)
+          .onChange(async (enabled) => {
+            this.plugin.getSettings().useInternalPlugins = enabled;
+            await this.plugin.saveIconFolderData();
+            new Notice(
+              `[${config.PLUGIN_NAME}] Obsidian has to be restarted for this change to take effect.`,
+            );
+          });
+      });
+  }
+}