skip frontmatter when opening file

[welpdx]

Don't you hate it when you've got too much frontmatter that you can see the content that really matters? Don't you hate spending that precious 2 seconds scrolling down each time you open a file?

Well, I've got a solution for you!

A simple Startup Template that changes your cursor location to the end of the yaml after every file opening!

v0.1

Script v0.1:

<%*
const MarkdownView = tp.obsidian.MarkdownView;
//on "file-open" event
this.app.workspace.on("file-open", async (e) => {
    const active_leaf = this.app.workspace.activeLeaf;
    if (!active_leaf) {
        new Notice("No active leaf", 5000);
    } else {
		const active_view = this.app.workspace.getActiveViewOfType(MarkdownView);
		if (active_view === null) {
		new Notice("error",5000);
		} else {
		const editor = active_view.editor;
		var file = app.metadataCache.getFileCache(e);
		//if there is front matter
		if (file["frontmatter"]) { 
			const active_file = active_view.file;
			const content = await app.vault.read(active_file);
			
			//if tp.file.cursor() commands are in the file, dont interfer. e.g., when creating a new file from template
			//not sure if it does interfer, but this is here just in case
			const cursor_regex = new RegExp("\<%\\s*tp.file.cursor\\((?\<order\>[0-9]{0,2})\\)\\s*%\>",'g');
			var match = cursor_regex.exec(content);
			
			// move cursor after yaml
			if (editor.getCursor().line == 0 && (match == null)) {
				var endofYaml = file.frontmatter.position.end.line + 1;
				editor.setCursor(endofYaml);
				console.log("Cursor set.")
			}
			
			} else {
				console.log("No frontmatter");
			}
		}
    }
})
_%>

Demo v0.1:

v0.2 adds scrolling

Script v0.2:

<%*
console.log("skipYaml script loaded!")
const MarkdownView = tp.obsidian.MarkdownView;
//on "file-open" event
this.app.workspace.on("file-open", async (e) => {
    const active_leaf = this.app.workspace.activeLeaf;
    if (!active_leaf) {
        new Notice("No active leaf", 5000);
    } else {
		const active_view = this.app.workspace.getActiveViewOfType(MarkdownView);
		if (active_view === null) {
		new Notice("error",5000);
		} else {
		const editor = active_view.editor;
		var file = app.metadataCache.getFileCache(e);
		//if there is front matter
		if (file["frontmatter"]) { 
			const active_file = active_view.file;
			const content = await app.vault.read(active_file);
			
			//if tp.file.cursor() commands are in the file, dont interfer. e.g., when creating a new file from template
			//not sure if it does interfer, but this is here just in case
			const cursor_regex = new RegExp("\<%\\s*tp.file.cursor\\((?\<order\>[0-9]{0,2})\\)\\s*%\>",'g');
			var match = cursor_regex.exec(content);
			
			// move cursor after yaml
			//if cursor is at the first line (ignores scrolling if file is opened already and cursor not at the default position of line 0) 
			//and if there is no match for tp.file.cursor()
			if (editor.getCursor().line == 0 && (match == null)) {
				var endofYaml = file.frontmatter.position.end.line + 1;
				editor.setCursor(endofYaml);
				console.log("Cursor set. ", endofYaml);
				
				// get height of first div in content for scrolling
				var lineHeight = editor.cm.docView.children[0].dom.clientHeight
				var y = endofYaml*(parseInt(lineHeight, 10));
				editor.scrollTo(0,y);
				console.log("Scrolled to: ", y)
			}
			
			} else {
				console.log("No frontmatter");
			}
		}
    }
})
_%>

Demo v0.2:

v0.3 added auto fold yaml. Fixed scroll if banner

Script v0.3:

<%*
console.log("skipYaml: skipYaml script loaded!");
const MarkdownView = tp.obsidian.MarkdownView;
//on "file-open" event
this.app.workspace.on("file-open", async (e) => {
    const active_leaf = this.app.workspace.activeLeaf;
    if (!active_leaf) {
        new Notice("skipYaml: No active leaf", 5000);
    } else {
		const active_view = this.app.workspace.getActiveViewOfType(MarkdownView);
		if (active_view === null) {
		new Notice("skipYaml: No active_view",5000);
		} else {
		const editor = active_view.editor;
		var file = app.metadataCache.getFileCache(e);
		//if there is front matter
		if (file["frontmatter"]) { 
			const active_file = active_view.file;
			const content = await app.vault.read(active_file);
			
			//if tp.file.cursor() commands are in the file, dont interfer
			const cursor_regex = new RegExp("\<%\\s*tp.file.cursor\\((?\<order\>[0-9]{0,2})\\)\\s*%\>",'g');
			var match = cursor_regex.exec(content);
			
			// move cursor after yaml
			if (editor.getCursor().line == 0 && (match == null)) {
				// fold yaml first
				//this.app.commands.executeCommandById('editor:toggle-fold');
				
				// set yaml to the end of the document
				var endofYaml = file.frontmatter.position.end.line + 1;
				editor.setCursor(endofYaml);
				console.log("skipYaml: Cursor set. ", endofYaml);
				
				// fstDiv is banner height if banner is loaded. 
				var fstDiv = editor.cm.docView.children[0].dom.clientHeight;
				var lineHeight = editor.cm.defaultLineHeight;
				var y = endofYaml*(parseInt(lineHeight, 10)-1)+fstDiv;
				editor.scrollTo(0,y);
				console.log("skipYaml: Scrolled to: ", y);
				
			} else {
				console.log("skipYaml: Didint Scroll.");
			}
			
			} else {
				console.log("skipYaml: No frontmatter");
			}
		}
    }
})
_%>

Demo v0.3:

Simply add this to your Startup Templater and see the magic!

~welp

---

Edit:

• Spelling
• v0.2
• v0.2 if statement fixed. I changed it back for testing and forgot to revert it back
• v0.3

[replete]

This looks great. I wonder if there's a way to autocollapse frontmatter?

[replete]

0.3 not working for me 'skipYaml: No active view' on all file opens. Will investigate later

[welpdx]

Hm, that is weird. Yea, let me know what's up with that

[replete]

Looks like the strange behaviour was because of this.app.commands.executeCommandById('editor:toggle-fold'); it was toggling between opens (as you'd expect)

EDIT: I've almost fixed this, see next comment.

[replete]

<%*
console.log("skipYaml: skipYaml script loaded!");
const MarkdownView = tp.obsidian.MarkdownView;
this.app.workspace.on("file-open", async (e) => {
	const active_leaf = this.app.workspace.activeLeaf;
	if (!active_leaf) {
		console.log("skipYaml: No active leaf");
	} else {
		const active_view = this.app.workspace.getActiveViewOfType(MarkdownView);
		if (active_view === null) {
			console.log("skipYaml: No active view");
		} else {
			const editor = active_view.editor;
			let file = app.metadataCache.getFileCache(e);
			if (file["frontmatter"]) { 
				const active_file = active_view.file;
				const content = await app.vault.read(active_file);
				
				//if tp.file.cursor() commands are in the file, dont interfere
				const cursor_regex = new RegExp("\<%\\s*tp.file.cursor\\((?\<order\>[0-9]{0,2})\\)\\s*%\>",'g');
				let docHasCursorFunctions = cursor_regex.exec(content);
				if (editor.getCursor().line == 0 && (docHasCursorFunctions == null)) {
		
					editor.setCursor(file.frontmatter.position.start.line);
					this.app.commands.executeCommandById('editor:fold-more');
					let endofYaml = file.frontmatter.position.end.line + 1;
					editor.setCursor(endofYaml);
					console.log("skipYaml: Cursor set. ", endofYaml);
					
					// fstDiv is banner height if banner is loaded. 
					let fstDiv = editor.cm.docView.children[0].dom.clientHeight;
					let lineHeight = editor.cm.defaultLineHeight;
					let y = endofYaml*(parseInt(lineHeight, 10)-1)+fstDiv;
					editor.scrollTo(0,y);
					console.log("skipYaml: Scrolled to: ", y);
				} else {
					console.log("skipYaml: Didn't Scroll.");
				}
			} else {
				console.log("skipYaml: No frontmatter");
			}
		}
	}
})
_%>

This has fixed it for me, also changed var, new Notice(), indentation - works a treat now, thanks for sharing this, should be an option in Obsidian itself IMO

[replete]

If it were to be a plugin, I'd consider these kinds of features:

• fold frontmatter on note open for all option
• set cursor after frontmatter on note open for all option
• look for skipyaml: true attribute in note frontmatter to override individual notes
• look for skipyaml_cursor: true attribute in note frontmatter to override individual notes
• If tp.file.cursor is used, look/wait for its location, then do yamlfold and then set cursor to its value

Thanks again for the work on this, very handy.