Add in-folder variant of quick switcher

Author: oin

README.md

@@ -2,12 +2,24 @@ This Obsidian plugin provides commands that improve navigation between the headi
 
 ## Commands
 
- - **Next/Previous Heading**: Go to the next/previous heading, based on the current cursor position.
- - **Open Switcher**: Open a quick switcher that presents the document's outline and allows you to quickly select a heading to jump to.
+ - **Next/Previous heading**: Go to the next/previous heading, based on the current cursor position.
+ - **Open switcher**: Open a quick switcher that presents the document's outline and allows you to quickly select a heading to jump to.
+ - **In folder: 
+ - **In folder: Open switcher**: Open a quick switcher that presents the outlines of all the documents in the current folder, and allows you to quickly select a heading to jump to.
 
 ## How to install
 
 Use one of the following methods:
 
  - Install it from Obsidian Community plugins.
  - Manually copy the released `main.js`, and `manifest.json` to `<your vault>/.obsidian/plugins/obsidian-gotoheading`.
+
+## What's new?
+
+### Version 0.2.0
+
+ - Add the _In folder_ variant of the _Open switcher_ command.
+
+### Version 0.1.1
+
+ - Initial release

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "oin-gotoheading",
 	"name": "Go To Heading",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"minAppVersion": "1.4.11",
 	"description": "Quickly navigate between headings",
 	"author": "join",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "oin-gotoheading",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "Quickly navigate between headings in Obisidian",
 	"main": "main.js",
 	"scripts": {

src/heading_modal.ts

@@ -1,16 +1,34 @@
 import { App, Editor, FuzzyMatch, FuzzySuggestModal, Notice, setIcon } from "obsidian";
 import { GotoHeadingSettings } from "./settings";
 
-interface HeadingSuggestion {
+export enum SuggestionType {
+	File,
+	Heading,
+};
+
+export interface FileSuggestion {
+	type: SuggestionType;
+	text: string;
+
+	path: string;
+}
+
+export interface HeadingSuggestion {
+	type: SuggestionType;
+	text: string;
+	
 	heading: string;
 	level: number;
 	line: number;
+	file?: FileSuggestion;
 }
 
-type HeadingModalCallback = (item: HeadingSuggestion) => void;
+export type Suggestion = HeadingSuggestion | FileSuggestion;
 
-export class HeadingModal extends FuzzySuggestModal<HeadingSuggestion> {
-	public items: HeadingSuggestion[] = [];
+type HeadingModalCallback = (item: Suggestion) => void;
+
+export class HeadingModal extends FuzzySuggestModal<Suggestion> {
+	public items: Suggestion[] = [];
 	public defaultItemIndex: number = -1;
 	public onChoose: HeadingModalCallback;
 	public settings: GotoHeadingSettings;
@@ -33,28 +51,59 @@ export class HeadingModal extends FuzzySuggestModal<HeadingSuggestion> {
 		}
 	}
 
-	getItems(): HeadingSuggestion[] {
+	getItems(): Suggestion[] {
 		return this.items;
 	}
 
-	getItemText(item: HeadingSuggestion): string {
-		return item.heading;
+	getItemText(item: Suggestion): string {
+		return item.text;
 	}
 
-	onChooseItem(item: HeadingSuggestion, evt: MouseEvent | KeyboardEvent): void {
+	onChooseItem(item: Suggestion, evt: MouseEvent | KeyboardEvent): void {
 		this.onChoose?.(item);
 	}
 
-	renderSuggestion(item: FuzzyMatch<HeadingSuggestion>, el: HTMLElement): void {
-		const isSearching = this.inputEl.value.length > 0;
-		const level = item.item.level;
-		const iconName = level >= 1 && level <= 6 ? `heading-${level}` : "heading";
-		
+	renderSuggestion(item: FuzzyMatch<Suggestion>, el: HTMLElement): void {
 		el.classList.add("join-gotoheading-headingmodal-suggestion");
 
 		if(this.settings.highlightCurrentHeading && this.defaultItemIndex >= 0 && this.items.indexOf(item.item) == this.defaultItemIndex) {
 			el.classList.add("join-gotoheading-headingmodal-suggestion-default");
 		}
+		
+		switch(item.item.type) {
+			case SuggestionType.File:
+				return this.renderFileSuggestion(item, el);
+			case SuggestionType.Heading:
+				return this.renderHeadingSuggestion(item, el);
+		}
+	}
+
+	protected renderFileSuggestion(item: FuzzyMatch<Suggestion>, el: HTMLElement) {
+		const s = item.item as FileSuggestion;
+
+		const isSearching = this.inputEl.value.length > 0;
+		
+		el.classList.add("join-gotoheading-headingmodal-suggestion");
+		el.classList.add("join-gotoheading-headingmodal-suggestion-file");
+		if(isSearching) {
+			el.classList.add("join-gotoheading-headingmodal-suggestion-searching");
+		}
+
+		// setIcon(el, "file-text");
+
+		const titleEl = el.createSpan({ cls: "title"});
+		super.renderSuggestion(item, titleEl);
+
+		let smallEl = el.createEl("small", { cls: "icon" });
+		setIcon(smallEl, "file-text");
+	}
+
+	protected renderHeadingSuggestion(item: FuzzyMatch<Suggestion>, el: HTMLElement) {
+		const s = item.item as HeadingSuggestion;
+		
+		const isSearching = this.inputEl.value.length > 0;
+		const level = s.level;
+		const iconName = level >= 1 && level <= 6 ? `heading-${level}` : "heading";
 
 		if(isSearching) {
 			// Set a heading icon
@@ -73,7 +122,7 @@ export class HeadingModal extends FuzzySuggestModal<HeadingSuggestion> {
 
 		// If a search is ongoing, display parent heading information
 		if(isSearching) {
-			let smallEl = el.createEl("small", { text: this.parentHeadingString(item.item), cls: "path" });
+			el.createEl("small", { text: this.parentHeadingString(s), cls: "path" });
 		} else {
 			let smallEl = el.createEl("small", { cls: "icon" });
 			setIcon(smallEl, iconName);
@@ -83,20 +132,27 @@ export class HeadingModal extends FuzzySuggestModal<HeadingSuggestion> {
 	protected parentHeadingString(item: HeadingSuggestion): string {
 		let string = "";
 
+		if(item.file) {
+			string = item.file.text;
+		}
+
 		while(item) {
 			const parentIndex = this.items.findLastIndex(
-				heading => heading.line < item.line
-				&& heading.level < item.level
+				heading =>
+					heading.type == SuggestionType.Heading
+					&& (heading as HeadingSuggestion).line < item.line
+					&& (heading as HeadingSuggestion).level < item.level
 				);
 			if(parentIndex < 0) break;
 			const parent = this.items[parentIndex];
+			if(parent.type != SuggestionType.Heading) break;
 
 			if(string.length > 0) {
-				string = `${parent.heading} > ${string}`;
+				string = `${(parent as HeadingSuggestion).heading} > ${string}`;
 			} else {
-				string = parent.heading;
+				string = (parent as HeadingSuggestion).heading;
 			}
-			item = parent;
+			item = parent as HeadingSuggestion;
 		}
 
 		return string;

src/main.ts

@@ -1,8 +1,17 @@
-import { Editor, Notice, MarkdownView, Plugin, EditorRange, livePreviewState } from "obsidian";
-import { goAndScrollToLine, headingsForActiveFile } from "./utility";
-import { HeadingModal } from "./heading_modal";
+import { Editor, Notice, MarkdownView, Plugin, TAbstractFile } from "obsidian";
+import { HeadingModal, HeadingSuggestion, FileSuggestion, Suggestion, SuggestionType } from "./heading_modal";
 import { GotoHeadingSettingTab } from "./settings_tab";
-import { DEFAULT_SETTINGS, GotoHeadingSettings } from "./settings";
+import { DEFAULT_SETTINGS, GotoHeadingSettings, FolderSortMethod, FolderSortMethodIdentifiers } from "./settings";
+import { fileNameWithoutPathOrExtension, goAndScrollToLine, headingsForActiveFile, headingsForActiveFolder, HeadingFolderChildrenFn } from "./utility";
+
+const FolderSortMethodFn: { [method in FolderSortMethod]: HeadingFolderChildrenFn } = {
+	[FolderSortMethod.ByNameAscending]: (children) => children.sort((a, b) => a.name.localeCompare(b.name)),
+	[FolderSortMethod.ByNameDescending]: (children) => children.sort((a, b) => b.name.localeCompare(a.name)),
+	[FolderSortMethod.ByModificationDateDescending]: (children) => children.sort((a, b) => b.stat.mtime - a.stat.mtime),
+	[FolderSortMethod.ByModificationDateAscending]: (children) => children.sort((a, b) => a.stat.mtime - b.stat.mtime),
+	[FolderSortMethod.ByCreationDateDescending]: (children) => children.sort((a, b) => b.stat.ctime - a.stat.ctime),
+	[FolderSortMethod.ByCreationDateAscending]: (children) => children.sort((a, b) => a.stat.ctime - b.stat.ctime),
+};
 
 export default class GotoHeadingPlugin extends Plugin {
 	settings: GotoHeadingSettings;
@@ -33,6 +42,14 @@ export default class GotoHeadingPlugin extends Plugin {
 				this.openHeadingSwitcher(editor, view);
 			},
 		});
+
+		this.addCommand({
+			id: "gotoheading-switcher-folder",
+			name: "In folder: Open switcher",
+			editorCallback: (editor: Editor, view: MarkdownView) => {
+				this.openHeadingSwitcherInFolder(editor, view);
+			},
+		});
 	}
 
 	async loadSettings() {
@@ -81,13 +98,15 @@ export default class GotoHeadingPlugin extends Plugin {
 		modal.setPlaceholder("Go to heading...");
 
 		modal.items = headings.map(heading => ({
+			type: SuggestionType.Heading,
+			text: heading.heading,
 			heading: heading.heading,
 			level: heading.level,
 			line: heading.position.start.line
 		}));
 
 		modal.onChoose = (item) => {
-			goAndScrollToLine(editor, item.line);
+			goAndScrollToLine(editor, (item as HeadingSuggestion).line);
 			modal.close();
 		};
 
@@ -98,4 +117,76 @@ export default class GotoHeadingPlugin extends Plugin {
 
 		modal.open();
 	}
+
+	protected openHeadingSwitcherInFolder(editor: Editor, view: MarkdownView) {
+		let sortMethodFn: HeadingFolderChildrenFn = (x => x);
+		const sortMethodId = this.settings.fileSortOrder;
+		if(FolderSortMethodIdentifiers.contains(sortMethodId)) {
+			sortMethodFn = FolderSortMethodFn[FolderSortMethod[sortMethodId]];
+		}
+		const headings = headingsForActiveFolder(this.app, sortMethodFn);
+		if(!headings.length) return;
+
+		let modal = new HeadingModal(this.app);
+		modal.setInstructions([
+			{ command: "↑↓", purpose: "to navigate" },
+			{ command: "↵", purpose: "to jump to file/heading" },
+			{ command: "esc", purpose: "to dismiss" },
+		]);
+		modal.setPlaceholder("Go to file/heading...");
+
+		let items: Suggestion[] = [];
+		for(const heading of headings) {
+			const f: FileSuggestion = {
+				type: SuggestionType.File,
+				text: fileNameWithoutPathOrExtension(heading.file.path),
+				path: heading.file.path
+			};
+
+			items.push(f, ...heading.headings.map(heading => ({
+				type: SuggestionType.Heading,
+				text: heading.heading,
+				heading: heading.heading,
+				level: heading.level,
+				line: heading.position.start.line,
+				file: f
+			})));
+		}
+		modal.items = items;
+
+		modal.onChoose = async (item) => {
+			switch(item.type) {
+				case SuggestionType.File: {
+					const s = item as FileSuggestion;
+					await this.app.workspace.openLinkText(s.path, '', false);
+					break;
+				}
+				case SuggestionType.Heading: {
+					const s = item as HeadingSuggestion;
+					if(s.file) {
+						await this.app.workspace.openLinkText(s.file.path, '', false);
+					}
+					goAndScrollToLine(editor, s.line);
+					break;
+				}
+			}
+			modal.close();
+		};
+
+		// Get the index of the nearest heading to the cursor
+		const line = editor.getCursor().line;
+		const activeFilePath = this.app.workspace.getActiveFile()?.path;
+		let idx = items.findLastIndex(item => 
+			item.type == SuggestionType.Heading 
+			&& (item as HeadingSuggestion).file?.path === activeFilePath
+			&& (item as HeadingSuggestion).line <= line
+			);
+		if(idx < 0) {
+			idx = items.findIndex(item => item.type == SuggestionType.File && (item as FileSuggestion).path === activeFilePath);
+		}
+		modal.defaultItemIndex = idx;
+		modal.settings = this.settings;
+
+		modal.open();
+	}
 }

src/settings.ts

@@ -1,7 +1,20 @@
+export enum FolderSortMethod {
+	ByNameAscending,
+	ByNameDescending,
+	ByModificationDateDescending,
+	ByModificationDateAscending,
+	ByCreationDateDescending,
+	ByCreationDateAscending,
+};
+export type FolderSortMethodId = keyof typeof FolderSortMethod;
+export const FolderSortMethodIdentifiers = Object.keys(FolderSortMethod).filter(x => isNaN(Number(x)));
+
 export interface GotoHeadingSettings {
 	highlightCurrentHeading: boolean;
+	fileSortOrder: FolderSortMethodId;
 }
 
 export const DEFAULT_SETTINGS: GotoHeadingSettings = {
-	highlightCurrentHeading: true
-};
+	highlightCurrentHeading: true,
+	fileSortOrder: FolderSortMethod[FolderSortMethod.ByNameAscending] as FolderSortMethodId,
+};

src/settings_tab.ts

@@ -1,5 +1,15 @@
-import { App, PluginSettingTab, Setting } from "obsidian";
+import { App, PluginSettingTab, Setting, Notice } from "obsidian";
 import GotoHeadingPlugin from "./main";
+import { FolderSortMethod, FolderSortMethodId, FolderSortMethodIdentifiers } from "./settings";
+
+const FolderSortMethodName: {[method in FolderSortMethod]: string} = {
+	[FolderSortMethod.ByNameAscending]: "File name (A to Z)",
+	[FolderSortMethod.ByNameDescending]: "File name (Z to A)",
+	[FolderSortMethod.ByModificationDateDescending]: "Modified time (new to old)",
+	[FolderSortMethod.ByModificationDateAscending]: "Modified time (old to new)",
+	[FolderSortMethod.ByCreationDateDescending]: "Creation date (new to old)",
+	[FolderSortMethod.ByCreationDateAscending]: "Creation date (old to new)",
+};
 
 export class GotoHeadingSettingTab extends PluginSettingTab {
 	plugin: GotoHeadingPlugin;
@@ -25,5 +35,22 @@ export class GotoHeadingSettingTab extends PluginSettingTab {
 						await this.plugin.saveSettings();
 					});
 			});
+
+		new Setting(containerEl)
+			.setName("File sort order")
+			.setDesc("How to sort files in the 'In folder' switcher")
+			.addDropdown((dropdown) => {
+				const ids = Object.keys(FolderSortMethodName).forEach((key, index) => {
+					dropdown.addOption(FolderSortMethod[index], FolderSortMethodName[index as FolderSortMethod]);
+				});
+				dropdown
+					.setValue(this.plugin.settings.fileSortOrder)
+					.onChange(async (value) => {
+						if(!FolderSortMethodIdentifiers.contains(value)) return;
+						
+						this.plugin.settings.fileSortOrder = value as FolderSortMethodId;
+						await this.plugin.saveSettings();
+					});
+			});
 	}
 }