changes to debounce, match autoinsert logic in suggestions, bump version

Author: rca-umb

CHANGELOG.md

@@ -4,7 +4,7 @@ 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/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [1.2.0] - 2025-2-25
 
 ### Added
 
@@ -16,6 +16,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ### Fixed
 
+- `^` character will not be included in the display text when linking to a block.
 - Minor typos.
 
 ## [1.1.0] - 2025-1-25

README.md

@@ -1,6 +1,20 @@
 # Anchor Link Display Text
 
-This is a plugin for [Obsidian](https://obsidian.md).
+This is a plugin for [Obsidian](https://obsidian.md) which automatically sets the display text of anchor links.
+
+## What's New in v1.2
+
+### Added
+
+- Display text suggestions. A suggestions popup will appear when the cursor is directly after an anchor link with display text. There will be three suggestions one, for each of the display text formats that can be used with this plugin (no note name, note name and then heading(s), heading(s) and then note name).
+
+### Changed
+
+- Heading separators are now validated to not include link breaking characters `[]|#^`. If any of these characters are typed into the separator field, the character will be ignored and a warning will appear.
+
+### Fixed
+
+- Minor typos.
 
 ## Description
 
@@ -36,6 +50,6 @@ Show only the first heading: [[Title#Heading#Subheading#Subsubheading|Heading]]
 Show only the last heading: [[Title#Heading#Subheading#Subsubheading|Subsubheading]]
 ```
 
-By default, the headings in the display text will be separated by a single space, but this can be changed to whatever you prefer. Some examples may be a comma (, ), colon (: ), or arrow (-> ). Just note that whatever is typed in the separator text box in the settings will be exactly what is used in the display text, nothing is added to it or removed from it.
+By default, the headings in the display text will be separated by a single space, but this can be changed to whatever you prefer. Some examples may be a comma (, ), colon (: ), or arrow (-> ). Just note that whatever is typed in the separator text box in the settings will be exactly what is used in the display text, nothing is added to it or removed from it, with the exception of characters which will break links: `[]|#^`.
 
 Additionally, there is an option for enabling display text alternative suggestions. This is a suggestions window which will appear when the cursor is next to an existing anchor link. All three display text formats described above will be available as suggestions regardless of the option chosen for automatic display text generation. This is useful for users who wish to use multiple formats.

main.ts

@@ -1,4 +1,4 @@
-import { App, Command, Editor, EditorPosition, EditorSuggest, EditorSuggestTriggerInfo, Notice, Plugin, PluginSettingTab, Setting, TFile, debounce } from 'obsidian';
+import { App, Editor, EditorPosition, EditorSuggest, EditorSuggestTriggerInfo, Notice, Plugin, PluginSettingTab, Setting, debounce } from 'obsidian';
 
 interface AnchorDisplaySuggestion {
 	displayText: string;
@@ -35,7 +35,7 @@ export default class AnchorDisplayText extends Plugin {
 
 		// look for header link creation
 		this.registerEvent(
-			this.app.workspace.on('editor-change', debounce((editor: Editor) => {
+			this.app.workspace.on('editor-change', (editor: Editor) => {
 				// Only process if the last typed character is ']'
 				const cursor = editor.getCursor();
 				const currentLine = editor.getLine(cursor.line);
@@ -78,7 +78,7 @@ export default class AnchorDisplayText extends Plugin {
 						new Notice (`Updated anchor link display text.`);
 					}
 				}
-			}, 150)) // 150ms debounce
+			})
 		);
 	}
 
@@ -106,18 +106,18 @@ class AnchorDisplaySuggest extends EditorSuggest<AnchorDisplaySuggestion> {
 
 	onTrigger(cursor: EditorPosition, editor: Editor): EditorSuggestTriggerInfo | null {
 		// turns off suggestions if the setting is disabled but the app hasn't been reloaded
-		if (!this.plugin.settings.suggest) {
-            return null;
-        }
+		if (!this.plugin.settings.suggest) return null;
+
 		const currentLine = editor.getLine(cursor.line);
+		const lastChar = currentLine[cursor.ch - 1];
+		if (lastChar !== ']') return null;
+
 		// match anchor links, even if they already have a display text
 		const headerLinkPattern = /(\[\[([^\]]+#[^\n\r\]]+)\]\])$/;
 		// only when cursor is immediately after the link
 		const match = currentLine.slice(0, cursor.ch).match(headerLinkPattern);
 
-		if(!match) {
-			return null;
-		}
+		if(!match) return null;
 
 		return {
 			start: {
@@ -137,6 +137,11 @@ class AnchorDisplaySuggest extends EditorSuggest<AnchorDisplaySuggestion> {
 		const headings = context.query.split('|')[0].split('#');
 
 		let displayText = headings[1];
+
+		if (displayText.startsWith('^')) {
+			displayText = displayText.slice(1);
+		}
+
 		for (let i = 2; i < headings.length; i++) {
 			displayText += this.plugin.settings.sep + headings[i];
 		}
@@ -192,6 +197,12 @@ class AnchorDisplaySuggest extends EditorSuggest<AnchorDisplaySuggestion> {
 class AnchorDisplayTextSettingTab extends PluginSettingTab {
 	plugin: AnchorDisplayText;
 
+	private showSepNotice = debounce(
+		() => new Notice(`Separators cannot contain any of the following characters: []#^|`), 
+		1000,
+		true
+	);
+
 	constructor(app: App, plugin: AnchorDisplayText) {
 		super(app, plugin);
 		this.plugin = plugin;
@@ -205,7 +216,7 @@ class AnchorDisplayTextSettingTab extends PluginSettingTab {
 			}
 		}
 		if (validValue != value) {
-			new Notice(`Separators cannot contain any of the following characters: []#^|`);
+			this.showSepNotice();
 		}
 		return validValue;
 	}

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "anchor-display-text",
 	"name": "Anchor Link Display Text",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"minAppVersion": "0.15.0",
 	"description": "Automatically uses the linked heading as the display text for the anchor links.",
 	"author": "Robert C Arsenault",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "anchor-display-text-plugin",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "Plugin for Obsidian (https://obsidian.md) that sets the display text of anchor links to the name of the heading.",
 	"main": "main.js",
 	"scripts": {