obsidian-remember-file-state: src/main.ts comparison

comparison src/main.ts @ 21:815b93d13e0f

Improve typescript compliance

author	Ludovic Chabant <ludovic@chabant.com>
date	Fri, 18 Mar 2022 19:25:18 -0700
parents	a50ef39473b6
children	f7e0926c2500

comparison

equal deleted inserted replaced

-:18ff216ce0c4
+:815b93d13e0f
 import {
-	Editor,
+	App,
+	Editor,
 	MarkdownView,
 	OpenViewState,
 	Plugin,
-	View
+	TAbstractFile,
+	TFile,
+	View,
+	WorkspaceLeaf
 } from 'obsidian';
+import {
+	EditorView
+} from '@codemirror/view';
 import {
 	EditorState,
 	EditorSelection
 } from '@codemirror/state';
 	DEFAULT_SETTINGS,
 	RememberFileStatePluginSettings,
 	RememberFileStatePluginSettingTab
 } from './settings';
+declare var app: App;
+// Interface for CM6 editor view
+interface EditorWithCM6 extends Editor {
+	cm: EditorView
+};
+// View with unique ID
+interface ViewWithID extends View {
+	__uniqueId: number
+};
+// Scroll info interface
+interface ScrollInfo {
+	top: number, left: number
+};
+interface StateData {
+	selection: EditorSelection,
+	scrollInfo: ScrollInfo
+};
 // Interface for a file state.
 interface RememberedFileState {
 	path: string;
 	lastSavedTime: number;
-	stateData: Object;
+	stateData: StateData;
 }
 // Interface for all currently remembered file states.
 interface RememberFileStatePluginData {
 	rememberedFiles: Record<string, RememberedFileState>;
 	private _suppressNextFileOpen: boolean = false;
 	// Next unique ID to identify views without keeping references to them.
 	private _nextUniqueViewId: number = 0;
 	// Functions to unregister any monkey-patched view hooks on plugin unload.
-	private _viewUninstallers = {};
+	private _viewUninstallers: Record<string, Function> = {};
 	// Functions to unregister any global callbacks on plugin unload.
-	private _globalUninstallers = [];
+	private _globalUninstallers: Function[] = [];
 	async onload() {
 		console.log("Loading RememberFileState plugin");
 		await this.loadSettings();
 		this.registerEvent(this.app.workspace.on('file-open', this.onFileOpen));
 		this.registerEvent(this.app.vault.on('rename', this.onFileRename));
 		this.registerEvent(this.app.vault.on('delete', this.onFileDelete));
 		this.app.workspace.getLeavesOfType("markdown").forEach(
-			(leaf) => { this.registerOnUnloadFile(leaf.view); });
+			(leaf: WorkspaceLeaf) => { this.registerOnUnloadFile(leaf.view as MarkdownView); });
 		const _this = this;
 		var uninstall = around(this.app.workspace, {
 			openLinkText: function(next) {
 				return async function(
 	onunload() {
 		// Run view uninstallers on all current views.
 		var numViews: number = 0;
 		this.app.workspace.getLeavesOfType("markdown").forEach(
-			(leaf) => {
+			(leaf: WorkspaceLeaf) => {
-				const filePath = leaf.view.file.path;
+				const filePath = (leaf.view as MarkdownView).file.path;
-				const viewId = this.getUniqueViewId(leaf.view);
+				const viewId = this.getUniqueViewId(leaf.view as ViewWithID);
 				if (viewId != undefined) {
 					var uninstaller = this._viewUninstallers[viewId];
 					if (uninstaller) {
 						console.debug(`Uninstalling hooks for view ${viewId}`, filePath);
 						uninstaller(leaf.view);
 					} else {
 						console.debug("Found markdown view without an uninstaller!", filePath);
 					}
 					// Clear the ID so we don't get confused if the plugin
 					// is re-enabled later.
-					this.clearUniqueViewId(leaf.view);
+					this.clearUniqueViewId(leaf.view as ViewWithID);
 				} else {
 					console.debug("Found markdown view without an ID!", filePath);
 				}
 			});
 		console.debug(`Unregistered ${numViews} view callbacks`);
 	async saveSettings() {
 		await this.saveData(this.settings);
 	}
-	private readonly registerOnUnloadFile = function(view) {
+	private readonly registerOnUnloadFile = function(view: MarkdownView) {
 		var filePath = view.file.path;
-		var viewId = this.getUniqueViewId(view, true);
+		var viewId = this.getUniqueViewId(view as unknown as ViewWithID, true);
 		if (viewId in this._viewUninstallers) {
 			console.debug(`View ${viewId} is already registered`, filePath);
 			return;
 		}
 		view.register(() => {
 			// Don't hold a reference to this plugin here because this callback
 			// will outlive it if it gets deactivated. So let's find it, and
 			// do nothing if we don't find it.
-			var plugin = app.plugins.getPlugin("obsidian-remember-file-state");
+			// @ts-ignore
+			var plugin: RememberFileStatePlugin = app.plugins.getPlugin("obsidian-remember-file-state");
 			if (plugin) {
 				console.debug(`Unregistering view ${viewId} callback`, filePath);
 				delete plugin._viewUninstallers[viewId];
 				uninstall();
 			} else {
 		openedFile: TFile
 	): Promise<void> => {
 		// If `openedFile` is null, it's because the last pane was closed
 		// and there is now an empty pane.
 		if (openedFile) {
-			var activeView = this.app.workspace.getActiveViewOfType(MarkdownView);
+			var activeView: MarkdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
 			if (activeView) {
 				this.registerOnUnloadFile(activeView);
 				if (!this._suppressNextFileOpen) {
 					this.restoreFileState(openedFile, activeView);
 			this._suppressNextFileOpen = false;
 		}
 	}
-	private readonly rememberFileState = async (file: TFile, view: View): Promise<void> => {
+	private readonly rememberFileState = async (file: TFile, view: MarkdownView): Promise<void> => {
 		const scrollInfo = view.editor.getScrollInfo();
-		const stateSelection = view.editor.cm.state.selection;
+		const cm6editor = view.editor as EditorWithCM6;
+		const stateSelection: EditorSelection = cm6editor.cm.state.selection;
 		if (stateSelection == undefined) {
 			// Legacy editor is in use, let's ignore
 			return;
 		}
 		const stateSelectionJSON = stateSelection.toJSON();
 			this.forgetExcessFiles();
 		}
 		console.debug("Remember file state for:", file.path);
 	}
-	private readonly restoreFileState = function(file: TFile, view: View) {
+	private readonly restoreFileState = function(file: TFile, view: MarkdownView) {
 		const existingFile = this.data.rememberedFiles[file.path];
 		if (existingFile) {
 			console.debug("Restoring file state for:", file.path);
 			const stateData = existingFile.stateData;
 			view.editor.scrollTo(stateData.scrollInfo.left, stateData.scrollInfo.top);
-			var transaction = view.editor.cm.state.update({
+			const cm6editor = view.editor as EditorWithCM6;
+			var transaction = cm6editor.cm.state.update({
 				selection: EditorSelection.fromJSON(stateData.selection)})
-			view.editor.cm.dispatch(transaction);
+			cm6editor.cm.dispatch(transaction);
 		}
 	}
 	private readonly forgetExcessFiles = function() {
 		const keepMax = this.settings.rememberMaxFiles;
 		if (keepMax <= 0) {
 			return;
 		}
 		// Sort newer files first, older files last.
-		var filesData = Object.values(this.data.rememberedFiles);
+		var filesData: RememberedFileState[] = Object.values(this.data.rememberedFiles);
 		filesData.sort((a, b) => {
 			if (a.lastSavedTime > b.lastSavedTime) return -1; // a before b
 			if (a.lastSavedTime < b.lastSavedTime) return 1;  // b before a
 			return 0;
 		});
 			var fileData = filesData[i];
 			delete this.data.rememberedFiles[fileData.path];
 		}
 	}
-	private readonly getUniqueViewId = function(view: View, autocreateId: boolean = false) {
+	private readonly getUniqueViewId = function(view: ViewWithID, autocreateId: boolean = false) {
 		if (view.__uniqueId == undefined) {
 			if (!autocreateId) {
 				return -1;
 			}
 			view.__uniqueId = (this._nextUniqueViewId++);
 			return view.__uniqueId;
 		}
 		return view.__uniqueId;
 	}
-	private readonly clearUniqueViewId = function(view: View) {
+	private readonly clearUniqueViewId = function(view: ViewWithID) {
 		delete view["__uniqueId"];
 	}
 	private readonly onFileRename = async (
 		file: TAbstractFile,
 		oldPath: string,
 	): Promise<void> => {
-		const existingFile = this.data.rememberedFiles[oldPath];
+		const existingFile: RememberedFileState = this.data.rememberedFiles[oldPath];
 		if (existingFile) {
 			existingFile.path = file.path;
 			delete this.data.rememberedFiles[oldPath];
 			this.data.rememberedFiles[file.path] = existingFile;
 		}

Mercurial > obsidian-remember-file-state

comparison src/main.ts @ 21:815b93d13e0f