Merge pull request #1 from rca-umb/dev

Dev

Author: rca-umb

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.2.0] - 2024-11-29
+
+### Added
+
+- Option to pick which headings to include in link display text when linking to multiple headings.
+- Options to change where the note name goes in relation to the headings in the link display text.
+- Option to change the message of the optional notice that appears whenever the plugin auto changes the display text.
+
+### Fixed
+
+- Incorrect display text when the link includes multiple headings.

main.ts

@@ -1,15 +1,19 @@
 import { App, Editor, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
 
-// Remember to rename these classes and interfaces!
-
 interface HeaderDisplayTextSettings {
-	displayTextFormat: string;
+	includeNoteName : string;
+	whichHeadings: string;
 	includeNotice: boolean;
+	noticeText: string;
+	sep : string;
 }
 
 const DEFAULT_SETTINGS: HeaderDisplayTextSettings = {
-	displayTextFormat: 'headerOnly',
-	includeNotice: false
+	includeNoteName: 'headersOnly',
+	whichHeadings: 'allHeaders',
+	includeNotice: false,
+	noticeText: 'Link changed!',
+	sep: ' '
 }
 
 export default class HeaderDisplayText extends Plugin {
@@ -18,31 +22,41 @@ export default class HeaderDisplayText extends Plugin {
 	async onload() {
 		await this.loadSettings();
 
-		// This adds a settings tab so the user can configure various aspects of the plugin
 		this.addSettingTab(new HeaderDisplayTextSettingTab(this.app, this));
 
-		// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
-		// Using this function will automatically remove the event listener when this plugin is disabled.
+		// look for header link creation
 		this.registerEvent(
 			this.app.workspace.on('editor-change', (editor: Editor) => {
 				// get what is being typed
 				const cursor = editor.getCursor();
 				const currentLine = editor.getLine(cursor.line);
-				// Wikilink format
 				// match links to other note headings WITHOUT an already defined display text
-				const headerLinkPattern = /\[\[([^\]]+)#([^|]+)\]\]/;
+				const headerLinkPattern = /\[\[([^\]]+#[^|]+)\]\]/;
 				const match = currentLine.slice(0, cursor.ch).match(headerLinkPattern);
 				if (match) {
-					const noteName = match[1];
-					const heading = match[2];
+					// handle multiple subheadings
+					const headings = match[1].split('#')
+					let displayText = ''
+					if (this.settings.whichHeadings === 'lastHeader') {
+						displayText = headings[headings.length - 1];
+					} else {
+						displayText = headings[1];
+						if (this.settings.whichHeadings === 'allHeaders') {
+							for (let i = 2; i < headings.length; i++) {
+								displayText += this.settings.sep + headings[i];
+							}
+						}
+					}
 					const startIndex = (match.index ?? 0) + match[0].length - 2;
-					if (this.settings.displayTextFormat === 'headerOnly') {
-						editor.replaceRange(`|${heading}`, {line: cursor.line, ch: startIndex}, undefined, 'headerAliases')
-					} else if (this.settings.displayTextFormat === 'withNoteName'){
-						editor.replaceRange(`|${noteName} ${heading}`, {line: cursor.line, ch: startIndex}, undefined, 'headerAliases')
+					if (this.settings.includeNoteName === 'headersOnly') {
+						editor.replaceRange(`|${displayText}`, {line: cursor.line, ch: startIndex}, undefined, 'headerDisplayText');
+					} else if (this.settings.includeNoteName === 'noteNameFirst') {
+						editor.replaceRange(`|${headings[0]}${this.settings.sep}${displayText}`, {line: cursor.line, ch: startIndex}, undefined, 'headerDisplayText');
+					} else if (this.settings.includeNoteName === 'noteNameLast') {
+						editor.replaceRange(`|${displayText}${this.settings.sep}${headings[0]}`, {line: cursor.line, ch: startIndex}, undefined, 'headerDisplayText');
 					}
 					if (this.settings.includeNotice) {
-						new Notice ('Link changed!')
+						new Notice (this.settings.noticeText)
 					}
 				}
 			})
@@ -74,27 +88,65 @@ class HeaderDisplayTextSettingTab extends PluginSettingTab {
 	display(): void {
 		const {containerEl} = this;
 		containerEl.empty();
+
+		containerEl.createEl('h2', {text: 'Link display text'})
 		new Setting(containerEl)
-			.setName('Display Text Format')
-			.setDesc('Change the format of the auto populated display text.')
+			.setName('Include note name')
+			.setDesc('Include the title of the note in the display text.')
 			.addDropdown(dropdown => {
-				dropdown.addOption('headerOnly', 'Header Only');
-				dropdown.addOption('withNoteName', 'Note Name and Header');
-				dropdown.setValue('headerOnly');
+				dropdown.addOption('headersOnly', 'Don\'t include note name');
+				dropdown.addOption('noteNameFirst', 'Note name and then heading(s)');
+				dropdown.addOption('noteNameLast', 'Heading(s) and then note name');
+				dropdown.setValue(this.plugin.settings.includeNoteName);
 				dropdown.onChange(value => {
-					this.plugin.settings.displayTextFormat = value;
+					this.plugin.settings.includeNoteName = value;
 					this.plugin.saveSettings();
 				});
-			})
+			});
+		new Setting(containerEl)
+			.setName('Headings to include')
+			.setDesc('Change which headings and subheadings are in the display text.')
+			.addDropdown(dropdown => {
+				dropdown.addOption('allHeaders', 'All linked headings');
+				dropdown.addOption('lastHeader', 'Last heading only');
+				dropdown.addOption('firstHeader', 'First heading only');
+				dropdown.setValue(this.plugin.settings.whichHeadings);
+				dropdown.onChange(value => {
+					this.plugin.settings.whichHeadings = value;
+					this.plugin.saveSettings();
+				});
+			});
 		new Setting(containerEl)
-			.setName('Notifications')
-			.setDesc('Have a notification pop up whenever a link is automatically changed.')
+			.setName('Set seperators')
+			.setDesc('Choose what to insert between headings, instead of #. Ex: , , ->, :, etc.')
+			.addText(text => {
+				text.setValue(this.plugin.settings.sep);
+				text.onChange(value => {
+					this.plugin.settings.sep = value;
+					this.plugin.saveSettings();
+				});
+			});
+
+		containerEl.createEl('h2', {text: 'Notifications'})
+		new Setting(containerEl)
+			.setName('Enable notifications')
+			.setDesc('Have a notice pop up whenever a link is automatically changed.')
 			.addToggle(toggle => {
 				toggle.setValue(this.plugin.settings.includeNotice);
 				toggle.onChange(value => {
 					this.plugin.settings.includeNotice = value;
 					this.plugin.saveSettings();
 				});
-			})
+			});
+		new Setting(containerEl)
+			.setName('Notification text')
+			.setDesc('Set the text to appear in the notification.')
+			.addText(text => {
+				text.setValue(this.plugin.settings.noticeText);
+				text.onChange(value => {
+					this.plugin.settings.noticeText = value;
+					this.plugin.saveSettings();
+				});
+			});
 	}
 }

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "header-display-text",
 	"name": "Header Display Text",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"minAppVersion": "0.15.0",
 	"description": "Automatically uses linked headers as the display text for the link.",
 	"author": "Robert Arsenault",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "header-display-text-plugin",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"description": "Plugin for Obsidian (https://obsidian.md) that sets the display text of linked headers to the name of the header.",
 	"main": "main.js",
 	"scripts": {

versions.json

@@ -1,3 +1,3 @@
 {
-	"0.1.0": "0.15.0"
+	"0.2.0": "0.15.0"
 }