Add custom tag option in the settings

crybot · Jun 1, 2024 · 24b17b2 · 24b17b2
1 parent 853aa31
commit 24b17b2
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 11 deletions.
diff --git a/main.js b/main.js
diff --git a/src/components.ts b/src/components.ts
@@ -33,6 +33,17 @@ export class InputModal extends Modal {
       })
     );
 
+    new Setting(contentEl)
+    .setName("Flashcards tag")
+    .addText((text) =>
+      text
+      .setPlaceholder("#flashcards")
+      .setValue(this.plugin.settings.tag)
+      .onChange(async (value) => {
+        this.configuration.tag = value
+      })
+    );
+
     new Setting(contentEl)
     .setName("Additional prompt")
     .addText((text) =>

diff --git a/src/main.ts b/src/main.ts
@@ -7,7 +7,6 @@ import { FlashcardsSettings, FlashcardsSettingsTab } from "./settings"
 // TODO:
 // - Status bar
 // - Enforce newline separation (stream post processing)
-// - Always append flashcards at the end of the file (ch:0, line: last)
 // - Disable user input while generating
 // - Custom tag for flashcards blocks
 // - Insert an optional header before flashcards
@@ -21,7 +20,8 @@ const DEFAULT_SETTINGS: FlashcardsSettings = {
   additionalPrompt: "",
   maxTokens: 300,
   streaming: true,
-  hideInPreview: true
+  hideInPreview: true,
+  tag: "#flashcards"
 };
 
 export default class FlashcardsLLMPlugin extends Plugin {
@@ -65,10 +65,11 @@ export default class FlashcardsLLMPlugin extends Plugin {
       }
 
       const blocks = element.findAll("blockquote");
+      const tag = this.settings.tag;
 
       for(let block of blocks) {
         const anchors = Array.from(block.querySelectorAll("a"));
-        if (anchors.some((a) => a.getAttribute("href")?.startsWith("#flashcards"))) {
+        if (anchors.some((a) => a.getAttribute("href")?.startsWith(`${tag}`))) {
           block.style.display = 'none'
         }
       }
@@ -107,15 +108,17 @@ export default class FlashcardsLLMPlugin extends Plugin {
       maxTokens = 300
     }
 
+    const tag = configuration.tag;
+
     const wholeText = editor.getValue()
     const currentText = (editor.somethingSelected() ? editor.getSelection() : wholeText)
     // Check if the header is already present
     const headerRegex = /\n\n### Generated Flashcards\n/;
     const hasHeader = headerRegex.test(wholeText);
 
     // Check if the #flashcards tag is already present
-    const tagRegex = /\n#flashcards.*\n/;
-    const hasTag = tagRegex.test(wholeText);
+    // const tagRegex = /\n#flashcards.*\n/;
+    // const hasTag = tagRegex.test(wholeText);
 
 
     const streaming = configuration.streaming
@@ -147,7 +150,7 @@ export default class FlashcardsLLMPlugin extends Plugin {
       // if (!hasTag) {
       //   updatedText += "> #flashcards\n> \n> ";
       // }
-      updatedText += "\n\n> #flashcards\n> \n> ";
+      updatedText += `\n\n> ${tag}\n> \n> `;
 
       editor.setCursor(editor.lastLine())
       editor.replaceRange(updatedText, editor.getCursor())

diff --git a/src/settings.ts b/src/settings.ts
@@ -2,6 +2,9 @@ import { App, MarkdownView, PluginSettingTab, Setting } from 'obsidian';
 import { availableChatModels, availableCompletionModels } from "./models";
 import FlashcardsLLMPlugin from "./main"
 
+// TODO:
+// - make additional prompt a resizable textarea
+
 export interface FlashcardsSettings {
   apiKey: string;
   model: string;
@@ -12,6 +15,7 @@ export interface FlashcardsSettings {
   maxTokens: number;
   streaming: boolean;
   hideInPreview: boolean;
+  tag: string;
 }
 
 
@@ -84,6 +88,20 @@ export class FlashcardsSettingsTab extends PluginSettingTab {
       })
     );
 
+    new Setting(containerEl)
+    .setName("Flashcards tag")
+    .setDesc("Set which tag to append upon flashcards generation. " +
+      "See the Spaced Repetition plugin for details")
+    .addText((text) =>
+      text
+      .setPlaceholder("#flashcards")
+      .setValue(this.plugin.settings.tag)
+      .onChange(async (value) => {
+        this.plugin.settings.tag = value;
+        await this.plugin.saveSettings();
+      })
+    );
+
     new Setting(containerEl)
     .setName("Number of flashcards to generate")
     .setDesc("Set this to the total number of flashcards the model should "+
@@ -98,6 +116,7 @@ export class FlashcardsSettingsTab extends PluginSettingTab {
       })
     );
 
+
     new Setting(containerEl)
     .setName("Additional prompt")
     .setDesc("Provide additional instructions to the language model")