Merge pull request #8 from camelChief/2-support-bible-linker-style

2 support bible linker style

main.ts

@@ -1,5 +1,5 @@
 import { Plugin } from 'obsidian';
-import LocalBibleRefSettingTab from 'src/local-bible-ref-setting-tab';
+import LocalBibleRefSettingTab, { BibleFormat } from 'src/local-bible-ref-setting-tab';
 import { PassageFormat } from 'src/passage-reference';
 import { PassageSuggest } from 'src/passage-suggest';
 import { LocalBibleRefSettings } from 'src/settings';
@@ -20,7 +20,8 @@ export default class LocalBibleRefPlugin extends Plugin {
 		this.settings ??= {
 			biblesPath: '',
 			defaultVersionShorthand: '',
-			defaultPassageFormat: PassageFormat.Callout
+			defaultPassageFormat: PassageFormat.Callout,
+			bibleFormat: BibleFormat.LocalBibleRef,
 		};
 	}
 

src/local-bible-ref-setting-tab.ts

@@ -16,6 +16,10 @@ export default class LocalBibleRefSettingTab extends PluginSettingTab {
 		const { containerEl } = this;
 		containerEl.empty();
 
+        new Setting(containerEl)
+            .setName('Configurations')
+            .setHeading();
+
         let biblesPathTimeout: number;
         new Setting(containerEl)
 			.setName('Bibles path')
@@ -48,6 +52,10 @@ export default class LocalBibleRefSettingTab extends PluginSettingTab {
                 new PathSuggest(this.app, text.inputEl);
             });
 
+        new Setting(containerEl)
+            .setName('Defaults')
+            .setHeading();
+
         let defaultVersionTimeout: number;
         const defaultVersionSetting = new Setting(containerEl)
             .setName('Default version shorthand')
@@ -81,6 +89,7 @@ export default class LocalBibleRefSettingTab extends PluginSettingTab {
             .setDesc('The markdown format to use for passages by default.')
             .addDropdown(dropdown => dropdown
                 .addOptions({
+                    manuscript: 'Manuscript',
                     paragraph: 'Paragraph',
                     quote: 'Quote',
                     callout: 'Callout',
@@ -90,5 +99,24 @@ export default class LocalBibleRefSettingTab extends PluginSettingTab {
                     this.plugin.settings.defaultPassageFormat = value as PassageFormat;
                     await this.plugin.saveSettings();
                 }));
+
+        new Setting(containerEl)
+            .setName('Bible Format')
+            .setDesc('The formatting style you use for your vault bibles. Local Bible Ref relies on this to parse passages correctly.')
+            .addDropdown(dropdown => dropdown
+                .addOptions({
+                    localBibleRef: 'Local Bible Ref',
+                    bibleLinker: 'Bible Linker',
+                })
+                .setValue(this.plugin.settings.bibleFormat)
+                .onChange(async (value) => {
+                    this.plugin.settings.bibleFormat = value as BibleFormat;
+                    await this.plugin.saveSettings();
+                }));
 	}
+}
+
+export enum BibleFormat {
+    LocalBibleRef = 'localBibleRef',
+    BibleLinker = 'bibleLinker',
 }

src/passage-suggest.ts

@@ -12,6 +12,7 @@ import {
 } from "obsidian";
 import { PassageFormat, PassageReference } from "./passage-reference";
 import { LocalBibleRefSettings } from "./settings";
+import { BibleFormat } from "./local-bible-ref-setting-tab";
 
 export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 	private settings: LocalBibleRefSettings;
@@ -105,7 +106,7 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		});
 
 		// suggest
-        const excerpt = this.generateExcerpt(texts[0]);
+		const excerpt = this.generateExcerpt(texts[0]);
 		const text = this.formatTexts(texts, passageRef, context);
 		return [{ excerpt, text }];
 	}
@@ -164,9 +165,17 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		text: string,
 		ref: PassageReference
 	): string | null {
-		const regExp = new RegExp(
+		let pattern = '';
-			`(?:[>-] )*(?:\\*\\*\\d{1,3}\\*\\* )?<sup>${ref.startVerse}</sup>`
+		if (this.settings.bibleFormat === BibleFormat.BibleLinker) {
-		);
+			pattern = `#{1,6} [a-zA-Z]*${ref.startVerse}[a-zA-Z]*\\n\\w+`;
+		} else {
+			const quoteOrList = '(?:[>-] )*';
+			const chapterNum = '(?:\\*\\*\\d{1,3}\\*\\* )?';
+			const verseNum = `<sup>${ref.startVerse}</sup>`;
+			pattern = quoteOrList + chapterNum + verseNum;
+		}
+		
+		const regExp = new RegExp(pattern);
 		const match = text.match(regExp);
 		if (!match) return null;
 
@@ -181,10 +190,17 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		ref: PassageReference
 	): string | null {
 		if (ref.endVerse === -1) return text;
-		const regex = new RegExp(
+
-			`(?:^(?:> |- )*)?<sup>${ref.endVerse + 1}</sup>`,
+		let pattern = '';
-			"m"
+		if (this.settings.bibleFormat === BibleFormat.BibleLinker) {
-		);
+			pattern = `#{1,6} [a-zA-Z]*${ref.endVerse + 1}[a-zA-Z]*\\n\\w+`;
+		} else {
+			const quoteOrList = '(?:[>-] )*';
+			const verseNum = `<sup>${ref.endVerse + 1}</sup>`;
+			pattern = quoteOrList + verseNum;
+		}
+
+		const regex = new RegExp(pattern);
 		return text.split(regex, 1)[0].trim();
 	}
 
@@ -193,12 +209,20 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		chapterNumber: number,
 		multipleChapters: boolean
 	): string {
+		if (this.settings.bibleFormat === BibleFormat.BibleLinker) {
+			text = this.formatBibleLinkerVerses(text);
+		}
+
 		text = this.removeChapterNumbers(text);
 		text = this.removeHeadings(text);
 		text = this.removeFootnoteRefs(text);
 		text = this.removeBOF(text);
 		text = this.removeEOF(text);
 
+		if (this.settings.bibleFormat === BibleFormat.BibleLinker) {
+			text = this.removeVerseSpacing(text);
+		}
+
 		const chapterMd = multipleChapters ? `**${chapterNumber}**` : "";
 		if (text.startsWith("> ")) {
 			const quoteMd = text.match(/^(?:> )+/)![0];
@@ -213,6 +237,14 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		return (text = `${chapterMd} ${text}`);
 	}
 
+	/** Formats verses that use Bible Linker formatting. */
+	private formatBibleLinkerVerses(text: string): string {
+		return text.replace(
+			/#{1,6} [a-zA-Z]*(\d{1,3})[a-zA-Z]*\n(\w+)/g,
+			"<sup>$1</sup> $2",
+		);
+	}
+
 	/** Removes chapter numbers from the given text. */
 	private removeChapterNumbers(text: string): string {
 		return text.replace(/\*\*\d{1,3}\*\* /g, "");
@@ -245,6 +277,11 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		return split[0].trim();
 	}
 
+	/** Removes extra spacing between verses in Bible Linker formatting. */
+	private removeVerseSpacing(text: string): string {
+		return text.replace(/\n{2,}/g, " ");
+	}
+
 	/** Generates an excerpt for the suggestion. */
 	private generateExcerpt(text: string): string {
 		text = text.split(/<\/sup>/, 2)[1];
@@ -302,15 +339,17 @@ export class PassageSuggest extends EditorSuggest<PassageSuggestion> {
 		ref: PassageReference,
 		context: EditorSuggestContext
 	): string {
-		const { version, book, startChapter } = ref;
+		const { version, book, startChapter, startVerse } = ref;
 		const path = `${this.settings.biblesPath}/${version}/${book.name}/${book.name} ${startChapter}.md`;
 		const file = this.app.vault.getFileByPath(normalizePath(path));
 		if (!file) return ref.stringify();
-		
+
 		return this.app.fileManager.generateMarkdownLink(
 			file,
 			context.file.path,
-			undefined,
+			this.settings.bibleFormat === BibleFormat.BibleLinker
+				? `#${startVerse}`
+				: undefined,
 			ref.stringify(),
 		);
 	}

src/settings.ts

@@ -1,7 +1,9 @@
+import { BibleFormat } from "./local-bible-ref-setting-tab";
 import { PassageFormat } from "./passage-reference";
 
 export interface LocalBibleRefSettings {
     biblesPath: string;
     defaultVersionShorthand: string;
     defaultPassageFormat: PassageFormat;
-}
+    bibleFormat: BibleFormat;
+}