Added filtering of ampersand symbol to fix bug that stops TTS from be…

…ing generated and added option to settings for how to handle its removal

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "edge-tts",
 	"name": "Edge TTS",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"minAppVersion": "0.15.0",
 	"description": "Read notes aloud using Microsoft Edge Read Aloud API (free, high quality text-to-speech).",
 	"author": "Travis",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-edge-tts",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"description": "This is a TTS plugin for Obsidian (https://obsidian.md).",
 	"main": "main.js",
 	"scripts": {

src/main.ts

@@ -33,6 +33,8 @@ interface EdgeTTSPluginSettings {
 	outputFolder: string;
 	embedInNote: boolean;
 	replaceSpacesInFilenames: boolean;
+
+	replaceAmpersand: boolean;
 }
 
 const DEFAULT_SETTINGS: EdgeTTSPluginSettings = {
@@ -48,6 +50,8 @@ const DEFAULT_SETTINGS: EdgeTTSPluginSettings = {
 	outputFolder: 'Note Narration Audio',
 	embedInNote: false,
 	replaceSpacesInFilenames: false,
+
+	replaceAmpersand: true,
 }
 
 const defaultSelectedTextMp3Name = 'note'
@@ -362,7 +366,7 @@ export default class EdgeTTSPlugin extends Plugin {
 		}
 
 		if (selectedText.trim()) {
-			cleanText = filterMarkdown(filterFrontmatter(selectedText));
+			cleanText = filterMarkdown(filterFrontmatter(selectedText), this.settings.replaceAmpersand);
 
 			if (cleanText.trim()) {
 				try {
@@ -427,7 +431,7 @@ export default class EdgeTTSPlugin extends Plugin {
 		}
 
 		if (selectedText.trim()) {
-			cleanText = filterMarkdown(filterFrontmatter(selectedText));
+			cleanText = filterMarkdown(filterFrontmatter(selectedText), this.settings.replaceAmpersand);
 
 			if (cleanText.trim()) {
 				try {
@@ -718,5 +722,18 @@ class EdgeTTSPluginSettingTab extends PluginSettingTab {
 				rel: 'noopener'
 			}
 		});
+
+		containerEl.createEl('h3', { text: 'Extra Settings' });
+
+		new Setting(containerEl)
+			.setName('Replace ampersand (&) with "and"')
+			.setDesc('Enable replacement of & with "and". Otherwise, it is removed, as the TTS cannot handle the symbol natively. (Note: this will not replace the actual text in your note)')
+			.addToggle(toggle => {
+				toggle.setValue(this.plugin.settings.replaceAmpersand);
+				toggle.onChange(async (value) => {
+					this.plugin.settings.replaceAmpersand = value;
+					await this.plugin.saveSettings();
+				});
+			});
 	}
 }

src/utils.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-inferrable-types */
 /* eslint-disable no-useless-escape */
 
 /**
@@ -14,7 +15,20 @@ export function filterFrontmatter(text: string): string {
   return text.replace(frontmatterRegex, '').trim();
 }
 
-export function filterMarkdown(text: string): string {
+/**
+ * Replaces or removes all ampersands (&) in the text.
+ * @param text - The input text.
+ * @param replaceWithAnd - If true, replaces ampersands with "and"; otherwise, removes them.
+ * @returns The text with ampersands processed.
+ */
+export function processAmpersands(text: string, replaceWithAnd: boolean): string {
+  return replaceWithAnd ? text.replace(/&/g, 'and') : text.replace(/&/g, '');
+}
+
+export function filterMarkdown(text: string, replaceAmpersandsWithAnd: boolean = true): string {
+  // Process ampersands
+  text = processAmpersands(text, replaceAmpersandsWithAnd);
+
   // Remove URLs
   text = text.replace(/https?:\/\/[^\s]+/g, '');
 
@@ -44,4 +58,4 @@ export function filterMarkdown(text: string): string {
   text = text.trim();
 
   return text;
-}
+}

versions.json

@@ -11,5 +11,6 @@
 	"1.2.0": "0.15.0",
 	"1.3.0": "0.15.0",
 	"1.4.0": "0.15.0",
-	"1.5.0": "0.15.0"
+	"1.5.0": "0.15.0",
+	"1.6.0": "0.15.0"
 }