Merge pull request #333 from kyan001/patch-1

Bug Fix #330 & #332

.github/workflows/release.yaml

@@ -8,7 +8,7 @@ on:
 
 permissions:
   id-token: write
-  contents: read
+  contents: write
   attestations: write
 
 jobs:

manifest.json

@@ -1,12 +1,12 @@
 {
-	"id": "folder-notes",
-	"name": "Folder notes",
-	"version": "1.8.21",
-	"minAppVersion": "1.4.10",
-	"description": "Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.",
-	"author": "Lost Paul",
-	"authorUrl": "https://github.com/LostPaul",
-	"fundingUrl": "https://ko-fi.com/paul305844",
-	"helpUrl": "https://lostpaul.github.io/obsidian-folder-notes/",
-	"isDesktopOnly": false
-}
+  "id": "folder-notes",
+  "name": "Folder notes",
+  "version": "1.8.26",
+  "minAppVersion": "1.4.10",
+  "description": "Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.",
+  "author": "Lost Paul",
+  "authorUrl": "https://github.com/LostPaul",
+  "fundingUrl": "https://ko-fi.com/paul305844",
+  "helpUrl": "https://lostpaul.github.io/obsidian-folder-notes/",
+  "isDesktopOnly": false
+}

package.json

@@ -18,11 +18,11 @@
 	"devDependencies": {
 		"@eslint/js": "^8.57.1",
 		"@types/node": "^16.11.6",
-		"@typescript-eslint/eslint-plugin": "^8.38.0",
-		"@typescript-eslint/parser": "^8.38.0",
+		"@typescript-eslint/eslint-plugin": "^8.60.0",
+		"@typescript-eslint/parser": "^8.60.0",
 		"builtin-modules": "3.3.0",
 		"esbuild": "0.14.47",
-		"eslint": "^9.32.0",
+		"eslint": "^10.4.1",
 		"eslint-plugin-obsidianmd": "^0.3.0",
 		"front-matter-plugin-api-provider": "^0.1.4-alpha",
 		"globals": "^16.3.0",
@@ -30,7 +30,7 @@
 		"obsidian": "latest",
 		"obsidian-typings": "^2.2.0",
 		"tslib": "2.4.0",
-		"typescript": "^4.8.4",
+		"typescript": "^6.0.3",
 		"typescript-eslint": "^8.38.0"
 	},
 	"dependencies": {

src/ExcludeFolders/ExcludeFolder.ts

@@ -12,7 +12,7 @@ export class ExcludedFolder {
 	position: number;
 	excludeFromFolderOverview: boolean;
 	hideInSettings: boolean;
-	detached: boolean;
+	detached: boolean = false;
 	detachedFilePath?: string;
 	showFolderNote: boolean;
 	constructor(path: string, position: number, id: string | undefined, plugin: FolderNotesPlugin) {

src/ExcludeFolders/ExcludePattern.ts

@@ -12,7 +12,7 @@ export class ExcludePattern {
 	enableCollapsing: boolean;
 	excludeFromFolderOverview: boolean;
 	hideInSettings: boolean;
-	detached: boolean;
+	detached: boolean = false;
 	detachedFilePath?: string;
 	showFolderNote: boolean;
 	constructor(

src/ExcludeFolders/WhitelistFolder.ts

@@ -5,14 +5,14 @@ export class WhitelistedFolder {
 	path: string;
 	string: string;
 	subFolders: boolean;
-	enableSync: boolean;
-	enableAutoCreate: boolean;
-	enableFolderNote: boolean;
-	disableCollapsing: boolean;
-	showInFolderOverview: boolean;
-	hideInFileExplorer: boolean;
+	enableSync: boolean = false;
+	enableAutoCreate: boolean = false;
+	enableFolderNote: boolean = false;
+	disableCollapsing: boolean = false;
+	showInFolderOverview: boolean = false;
+	hideInFileExplorer: boolean = false;
 	position: number;
-	hideInSettings: boolean;
+	hideInSettings: boolean = false;
 	constructor(path: string, position: number, id: string | undefined, plugin: FolderNotesPlugin) {
 		this.type = 'folder';
 		this.id = id || crypto.randomUUID();

src/ExcludeFolders/WhitelistPattern.ts

@@ -6,13 +6,13 @@ export class WhitelistedPattern {
 	path: string;
 	position: number;
 	subFolders: boolean;
-	enableSync: boolean;
-	enableAutoCreate: boolean;
-	enableFolderNote: boolean;
-	disableCollapsing: boolean;
-	showInFolderOverview: boolean;
-	hideInFileExplorer: boolean;
-	hideInSettings: boolean;
+	enableSync: boolean = false;
+	enableAutoCreate: boolean = false;
+	enableFolderNote: boolean = false;
+	disableCollapsing: boolean = false;
+	showInFolderOverview: boolean = false;
+	hideInFileExplorer: boolean = false;
+	hideInSettings: boolean = false;
 	constructor(
 		pattern: string,
 		position: number,

src/ExcludeFolders/functions/folderFunctions.ts

@@ -235,7 +235,6 @@ export function addExcludeFolderListItem(
 			plugin,
 			false,
 		);
-		// @ts-expect-error Obsidian's public types don't include this property
 		cb.containerEl.addClass('fn-exclude-folder-path');
 		cb.setPlaceholder('Folder path');
 		cb.setValue(excludedFolder.path || '');

src/ExcludeFolders/functions/patternFunctions.ts

@@ -95,7 +95,6 @@ export function addExcludePatternListItem(
 	const setting = new Setting(containerEl);
 	setting.setClass('fn-exclude-folder-list');
 	setting.addSearch((cb) => {
-		// @ts-expect-error Obsidian's public types don't include containerEl on this control
 		cb.containerEl.addClass('fn-exclude-folder-path');
 		cb.setPlaceholder('Pattern');
 		cb.setValue(pattern.string);

src/ExcludeFolders/functions/whitelistFolderFunctions.ts

@@ -132,7 +132,6 @@ export function addWhitelistFolderListItem(
 			plugin,
 			true,
 		);
-		// @ts-expect-error Obsidian's public types don't include this property
 		cb.containerEl.addClass('fn-exclude-folder-path');
 		cb.setPlaceholder('Folder path');
 		cb.setValue(whitelistedFolder.path);

src/ExcludeFolders/functions/whitelistPatternFunctions.ts

@@ -97,7 +97,6 @@ export function addWhitelistedPatternListItem(
 	const setting = new Setting(containerEl);
 	setting.setClass('fn-exclude-folder-list');
 	setting.addSearch((cb) => {
-		// @ts-expect-error Obsidian's public types don't expose containerEl on this control
 		cb.containerEl.addClass('fn-exclude-folder-path');
 		cb.setPlaceholder('Pattern');
 		cb.setValue(pattern.string);

src/events/FrontMatterTitle.ts

@@ -25,12 +25,12 @@ interface WrappedUpdateData {
 
 export class FrontMatterTitlePluginHandler {
 	plugin: FolderNotesPlugin;
-	app: App;
+	app!: App;
 	api: ApiInterface | null = null;
 	deffer: DeferInterface | null = null;
 	modifiedFolders: Map<string, TFolder> = new Map();
-	eventRef: ListenerRef<'manager:update'>;
-	dispatcher: EventDispatcherInterface<Events>;
+	eventRef: ListenerRef<'manager:update'> | null = null;
+	dispatcher: EventDispatcherInterface<Events> | null = null;
 	constructor(plugin: FolderNotesPlugin) {
 		this.plugin = plugin;
 		this.app = plugin.app;
@@ -66,13 +66,13 @@ export class FrontMatterTitlePluginHandler {
 				// this.plugin.app.vault.getFiles().forEach((file) => {
 				// 	this.handleRename({ id: '', result: false, path: file.path }, false);
 				// });
-				this.plugin.updateAllBreadcrumbs();
+				plugin.updateAllBreadcrumbs();
 			}
 		})();
 	}
 
 	deleteEvent(): void {
-		if (this.eventRef) {
+		if (this.eventRef && this.dispatcher) {
 			this.dispatcher.removeListener(this.eventRef);
 		}
 	}

src/events/MutationObserver.ts

@@ -158,6 +158,7 @@ async function setupFolderTitle(
 	});
 }
 
+// eslint-disable-next-line complexity
 async function updateFolderNamesInPath(
 	plugin: FolderNotesPlugin,
 	titleContainer: HTMLElement,
@@ -169,14 +170,14 @@ async function updateFolderNamesInPath(
 	if (titleParent?.childNodes.length === 0) {
 		titleContainer.classList.remove('hide-folder-note-title-in-path');
 	}
-	// eslint-disable-next-line complexity
-	titleParent?.childNodes.forEach(async (breadcrumb: HTMLElement) => {
-		if (!(breadcrumb.instanceOf(HTMLElement))) return;
+
+	for (const breadcrumb of Array.from(titleParent?.childNodes ?? [])) {
+		if (!(breadcrumb instanceof HTMLElement)) continue;
 		if (breadcrumb.classList.contains('view-header-breadcrumb-separator')) {
 			if (breadcrumb.nextSibling === null) {
 				breadcrumb.classList.add('is-last-separator');
 			}
-			return;
+			continue;
 		}
 
 		path += breadcrumb.getAttribute('old-name') ?? (breadcrumb).innerText.trim();
@@ -201,8 +202,12 @@ async function updateFolderNamesInPath(
 				viewHeaderTitle.classList.remove('path-is-folder-note');
 			}
 		}
-		if (!folderNote) return;
-		if (folderNote) breadcrumb.classList.add('has-folder-note');
+		if (!folderNote) {
+			breadcrumb.classList.remove('has-folder-note');
+			breadcrumb.removeAttribute('data-path');
+			continue;
+		}
+		breadcrumb.classList.add('has-folder-note');
 		breadcrumb?.setAttribute('data-path', path.slice(0, -TRAILING_SLASH_LENGTH));
 		if (!breadcrumb.onclick) {
 			breadcrumb.addEventListener('click', (e) => {
@@ -216,7 +221,7 @@ async function updateFolderNamesInPath(
 				true,
 			);
 		}
-	});
+	}
 }
 
 // Schedules a callback to run when the browser is idle, or after a timeout as a fallback.
@@ -230,6 +235,6 @@ function scheduleIdle(callback: () => void, options?: { timeout: number }): void
 		};
 		windowWithIdle.requestIdleCallback(callback, options);
 	} else {
-		window.setTimeout(callback, options?.timeout || DEFAULT_IDLE_TIMEOUT);
+		globalThis.setTimeout(callback, options?.timeout || DEFAULT_IDLE_TIMEOUT);
 	}
 }

src/functions/utils.ts

@@ -1,10 +1,15 @@
-import { TFolder, TFile, View, TAbstractFile } from 'obsidian';
+import { TFolder, TFile, View, type TAbstractFile } from 'obsidian';
 import type { FileExplorerWorkspaceLeaf, FileExplorerView } from 'src/globals';
 import { getFolderNote } from './folderNoteFunctions';
 import type FolderNotesPlugin from 'src/main';
-import type { FileExplorerLeaf, FileTreeItem, TreeNode } from 'obsidian-typings';
+import type { FileTreeItem } from 'obsidian-typings';
 import type FolderOverviewPlugin from 'src/obsidian-folder-overview/src/main';
 
+function isFileExplorerWorkspaceLeaf(leaf: unknown): leaf is FileExplorerWorkspaceLeaf {
+	const tabHeaderEl = (leaf as { tabHeaderEl?: HTMLElement | null } | null)?.tabHeaderEl;
+	return tabHeaderEl?.dataset?.type === 'file-explorer';
+}
+
 export function getFileNameFromPathString(path: string): string {
 	return path.substring(path.lastIndexOf('/') >= 0 ? path.lastIndexOf('/') + 1 : 0);
 }
@@ -43,29 +48,28 @@ export function getParentFolderPath(path: string): string {
 export function getFileExplorer(
 	plugin: FolderNotesPlugin | FolderOverviewPlugin,
 ): FileExplorerWorkspaceLeaf | undefined {
-	// eslint-disable-next-line max-len
-	let leaf = plugin.app.workspace.getLeavesOfType('file-explorer')[0] as unknown as FileExplorerWorkspaceLeaf;
+	let leaf = plugin.app.workspace.getLeavesOfType('file-explorer')[0];
 
 	if (!leaf) { return undefined; }
 
 	/* make.md plugin integration */
 	if ((leaf.containerEl?.lastChild as HTMLElement)?.dataset?.type === 'mk-path-view') {
 		plugin.app.workspace.iterateAllLeaves((x) => {
-			if ((x as FileExplorerWorkspaceLeaf).tabHeaderEl?.dataset?.type === 'file-explorer') {
-				leaf = x as FileExplorerWorkspaceLeaf;
+			if (isFileExplorerWorkspaceLeaf(x)) {
+				leaf = x;
 			}
 		});
 	}
 
-	return leaf;
+	return isFileExplorerWorkspaceLeaf(leaf) ? leaf : undefined;
 }
 
 export function getFileExplorerView(plugin: FolderNotesPlugin): FileExplorerView | undefined {
 	return getFileExplorer(plugin)?.view;
 }
 
-export function getFocusedItem(plugin: FolderNotesPlugin): TreeNode<FileTreeItem> | null {
-	const fileExplorer = getFileExplorer(plugin) as unknown as FileExplorerLeaf | undefined;
+export function getFocusedItem(plugin: FolderNotesPlugin): FileTreeItem | null {
+	const fileExplorer = getFileExplorer(plugin);
 	if (!fileExplorer) { return null; }
 	const { focusedItem } = fileExplorer.view.tree;
 	return focusedItem;

src/main.ts

@@ -221,9 +221,13 @@ export default class FolderNotesPlugin extends Plugin {
 		registerFileExplorerObserver(this);
 
 		const fileExplorer = getFileExplorer(this);
-		if (fileExplorer) {
-			// @ts-expect-error use internal API
-			fileExplorer.view.tree.infinityScroll.rootMargin = 1.5;
+		// @ts-expect-error use internal API
+		const infinityScroll = fileExplorer?.view?.tree?.infinityScroll;
+
+		if (infinityScroll) {
+			// increase infinity scroll buffer to show hidden folder notes
+			// Issue: https://github.com/LostPaul/obsidian-folder-notes/issues/274
+			infinityScroll.rootMargin = 1.5;
 		}
 
 		this.registerView(FOLDER_OVERVIEW_VIEW, (leaf: WorkspaceLeaf) => {
@@ -302,13 +306,13 @@ export default class FolderNotesPlugin extends Plugin {
 			clipboardProto.handleDragOver as unknown as ClipboardManagerLike['handleDragOver'];
 		const originalHandleDrop =
 			clipboardProto.handleDrop as unknown as ClipboardManagerLike['handleDrop'];
-
-		clipboardProto.handleDragOver = (evt: DragEvent, ...args: unknown[]): void => {
-			const { dragManager } = clipboardManager.app;
+		const folderNotePlugin = this;
+		clipboardProto.handleDragOver = function (evt: DragEvent, ...args: unknown[]): void {
+			const { dragManager } = (this as ClipboardManagerLike).app;
 			const draggable = dragManager?.draggable;
 
 			if (draggable?.file instanceof TFolder) {
-				const folderNote = getFolderNote(this, draggable.file.path);
+				const folderNote = getFolderNote(folderNotePlugin, draggable.file.path);
 				if (folderNote) {
 					dragManager.setAction(
 						window.i18next.t('interface.drag-and-drop.insert-link-here'),
@@ -317,22 +321,22 @@ export default class FolderNotesPlugin extends Plugin {
 				}
 			}
 
-			originalHandleDragOver(evt, ...args);
+			return originalHandleDragOver.call(this, evt, ...args);
 		};
 
-		clipboardProto.handleDrop = (evt: DragEvent, ...args: unknown[]): void => {
-			const { dragManager } = clipboardManager.app;
+		clipboardProto.handleDrop = function (evt: DragEvent, ...args: unknown[]): void {
+			const { dragManager } = (this as ClipboardManagerLike).app;
 			const draggable = dragManager?.draggable;
 
 			if (draggable?.file instanceof TFolder) {
-				const folderNote = getFolderNote(this, draggable.file.path);
+				const folderNote = getFolderNote(folderNotePlugin, draggable.file.path);
 				if (folderNote) {
 					draggable.file = folderNote;
 					draggable.type = 'file';
 				}
 			}
 
-			originalHandleDrop(evt, ...args);
+			return originalHandleDrop.call(this, evt, ...args);
 		};
 
 		if (this.settings.fvGlobalSettings.autoUpdateLinks) {

src/obsidian-folder-overview

@@ -1 +1 @@
-Subproject commit 2bc9795b1feede51554dafacfe56123af5e2f2a6
+Subproject commit f047859cc9a7f1c04ad35ecdc440a31a300bc6c2

src/settings/ExcludedFoldersSettings.ts

@@ -17,7 +17,7 @@ export async function renderExcludeFolders(settingsTab: SettingsTab): Promise<vo
 		.setHeading()
 		.setClass('fn-excluded-folder-heading')
 		.setName('Manage excluded folders');
-	const desc3 = activeDocument.createDocumentFragment();
+	const desc3 = document.createDocumentFragment();
 	desc3.append(
 		'Add {regex} at the beginning of the folder name to use a regex pattern.',
 		desc3.createEl('br'),

src/settings/GeneralSettings.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/unbound-method */
+
 /* eslint-disable max-len */
 import { Setting, Platform } from 'obsidian';
 import type { SettingsTab } from './SettingsTab';
@@ -11,7 +11,7 @@ import { refreshAllFolderStyles } from '../functions/styleFunctions';
 import BackupWarningModal from './modals/BackupWarning';
 import RenameFolderNotesModal from './modals/RenameFns';
 
-let debounceTimer: ReturnType<typeof setTimeout>;
+let debounceTimer: number | undefined;
 
 // eslint-disable-next-line complexity
 export async function renderGeneral(settingsTab: SettingsTab): Promise<void> {
@@ -54,7 +54,7 @@ export async function renderGeneral(settingsTab: SettingsTab): Promise<void> {
 						'Rename all existing folder notes',
 						'When you click on "Confirm" all existing folder notes will be renamed to the new folder note name.',
 						settingsTab.renameFolderNotes,
-						[])
+						[settingsTab.plugin.settings.oldFolderNoteName ?? '{{folder_name}}'])
 						.open();
 				}),
 		);
@@ -128,7 +128,7 @@ export async function renderGeneral(settingsTab: SettingsTab): Promise<void> {
 
 	const setting0 = new Setting(containerEl);
 	setting0.setName('Supported file types');
-	const desc0 = activeDocument.createDocumentFragment();
+	const desc0 = document.createDocumentFragment();
 	desc0.append(
 		'Specify which file types are allowed as folder notes. Applies to both new and existing folders. Adding many types may affect performance.',
 	);
@@ -482,7 +482,7 @@ export async function renderGeneral(settingsTab: SettingsTab): Promise<void> {
 
 	settingsTab.settingsPage.createEl('h3', { text: 'Integration & compatibility' });
 
-	const desc1 = activeDocument.createDocumentFragment();
+	const desc1 = document.createDocumentFragment();
 
 	const link = activeDocument.createElement('a');
 	link.href = 'https://github.com/snezhig/obsidian-front-matter-title';

src/settings/SettingsTab.ts

@@ -298,7 +298,7 @@ export class SettingsTab extends PluginSettingTab {
 				tabEl.addClass('fn-settings-tab-active');
 			}
 			tabEl.addEventListener('click', () => {
-				for (const child of tabBar.children) {
+				for (const child of Array.from(tabBar.children)) {
 					(child as HTMLElement).classList.remove('fn-settings-tab-active');
 					if (!plugin) { return; }
 					plugin.settings.settingsTab = tabId.toLocaleLowerCase();

src/settings/modals/BackupWarning.ts

@@ -5,15 +5,15 @@ export default class BackupWarningModal extends Modal {
 	plugin: FolderNotesPlugin;
 	title: string;
 	desc: string;
-	callback: (...args: unknown[]) => void;
-	args: unknown[];
+	callback: (oldMethod: string) => void;
+	args: [string];
 
 	constructor(
 		plugin: FolderNotesPlugin,
 		title: string,
 		description: string,
-		callback: (...args: unknown[]) => void,
-		args: unknown[] = [],
+		callback: (oldMethod: string) => void,
+		args: [string],
 	) {
 		super(plugin.app);
 		this.plugin = plugin;

src/settings/modals/RenameFns.ts

@@ -7,8 +7,8 @@ export default class RenameFolderNotesModal extends BackupWarningModal {
 		plugin: FolderNotesPlugin,
 		title: string,
 		description: string,
-		callback: (...args: unknown[]) => void,
-		args: unknown[] = [],
+		callback: (oldMethod: string) => void,
+		args: [string],
 	) {
 		super(plugin, title, description, callback, args);
 	}

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "ignoreDeprecations": "6.0",
     "baseUrl": ".",
     "inlineSourceMap": true,
     "inlineSources": true,