#41 - Settings page

2022-05-06 21:04:56 +02:00
parent abff5ecaca
commit 5eb75363bd
3 changed files with 125 additions and 26 deletions
--- a/src/settings.ts
+++ b/src/settings.ts
@@ -0,0 +1,104 @@
+import { Plugin, PluginSettingTab, Setting, SliderComponent } from 'obsidian'
+import type OmnisearchPlugin from './main'
+
+interface WeightingSettings {
+  weightBasename: number
+  weightH1: number
+  weightH2: number
+  weightH3: number
+}
+
+export interface OmnisearchSettings extends WeightingSettings {
+  showIndexingNotices: boolean
+  respectExcluded: boolean
+}
+
+export class SettingsTab extends PluginSettingTab {
+  plugin: OmnisearchPlugin
+
+  constructor(plugin: OmnisearchPlugin) {
+    super(app, plugin)
+    this.plugin = plugin
+  }
+
+  display(): void {
+    const { containerEl } = this
+    containerEl.empty()
+
+    // Title
+    const title = document.createElement('h2')
+    title.textContent = 'Omnisearch settings'
+    containerEl.appendChild(title)
+
+    // Show notices
+    new Setting(containerEl)
+      .setName('Show indexing notices')
+      .setDesc('Show a notice when indexing is done, usually at startup.')
+      .addToggle(toggle =>
+        toggle.setValue(settings.showIndexingNotices).onChange(async v => {
+          settings.showIndexingNotices = v
+          await saveSettings(this.plugin)
+        }),
+      )
+
+    // Respect excluded files
+    new Setting(containerEl)
+      .setName('Respect Obsidian\'s "Excluded Files"')
+      .setDesc(
+        'Files that are in Obsidian\'s "Options > Files & Links > Excluded Files" list will be downranked in results.',
+      )
+      .addToggle(toggle =>
+        toggle.setValue(settings.respectExcluded).onChange(async v => {
+          settings.respectExcluded = v
+          await saveSettings(this.plugin)
+        }),
+      )
+
+    new Setting(containerEl).setName('Results weighting').setHeading()
+
+    new Setting(containerEl)
+      .setName(`File name (default: ${DEFAULT_SETTINGS.weightBasename})`)
+      .addSlider(cb => this.weightSlider(cb, 'weightBasename'))
+
+    new Setting(containerEl)
+      .setName(`Headings level 1 (default: ${DEFAULT_SETTINGS.weightH1})`)
+      .addSlider(cb => this.weightSlider(cb, 'weightH1'))
+
+    new Setting(containerEl)
+      .setName(`Headings level 2 (default: ${DEFAULT_SETTINGS.weightH2})`)
+      .addSlider(cb => this.weightSlider(cb, 'weightH2'))
+
+    new Setting(containerEl)
+      .setName(`Headings level 3 (default: ${DEFAULT_SETTINGS.weightH3})`)
+      .addSlider(cb => this.weightSlider(cb, 'weightH3'))
+  }
+
+  weightSlider(cb: SliderComponent, key: keyof WeightingSettings): void {
+    cb.setLimits(1, 3, 0.1)
+    cb.setValue(settings[key])
+    cb.setDynamicTooltip()
+    cb.onChange(v => {
+      settings[key] = v
+      saveSettings(this.plugin)
+    })
+  }
+}
+
+export const DEFAULT_SETTINGS: OmnisearchSettings = {
+  showIndexingNotices: true,
+  respectExcluded: true,
+  weightBasename: 2,
+  weightH1: 1.5,
+  weightH2: 1.3,
+  weightH3: 1.1,
+} as const
+
+export let settings: OmnisearchSettings = Object.assign({}, DEFAULT_SETTINGS)
+
+export async function loadSettings(plugin: Plugin): Promise<void> {
+  settings = Object.assign({}, DEFAULT_SETTINGS, await plugin.loadData())
+}
+
+export async function saveSettings(plugin: Plugin): Promise<void> {
+  await plugin.saveData(settings)
+}