Merge branch 'master' into release

Author: mProjectsCode

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+- [ ] The Plugin is up to date
+- [ ] Obsidian is up to date
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Occurs on**
+- [ ] Windows
+- [ ] macOS
+- [ ] Linux
+- [ ] Android
+- [ ] iOS
+
+**Plugin version**
+x.x.x
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -5,7 +5,7 @@ This plugin can create input fields inside your notes and bind them to metadata
 This plugin is not yet finished.
 
 Planed features are:
-- two-way sync (listening to file changes and updating the input fields)
+- ranges for sliders
 - more input types
 
 ### How to use
@@ -36,6 +36,9 @@ The folder structure should look like this:
 ```
 
 ### Problems, unexpected behavior or improvement suggestions?
+#### The sync seems laggy
+This is intentional. To reduce the load on your hard drive the plugin ony syncs about 5 times a second. 
+
 You are more than welcome to open an issue on [GitHub](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues).
 
 ### Contributions

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "obsidian-meta-bind-plugin",
 	"name": "Meta Bind Plugin",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"minAppVersion": "0.14.0",
 	"description": "This plugin can create input fields inside your notes and bind them to metadata fields.",
 	"author": "Moritz Jung",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-meta-bind-plugin",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"description": "This plugin can create input fields inside your notes and bind them to metadata fields.",
 	"main": "main.js",
 	"scripts": {

src/Logger.ts

@@ -0,0 +1,24 @@
+import MetaBindPlugin from './main';
+
+export class Logger {
+	static plugin: MetaBindPlugin;
+	static prefix: string = 'meta-bind |';
+
+	static log(data: any): void {
+		console.log(this.prefix, data);
+	}
+
+	static logDebug(data: any): void {
+		if (this.plugin.settings.devMode) {
+			Logger.log(data);
+		}
+	}
+
+	static logWarning(data: any): void {
+		console.warn(this.prefix, data);
+	}
+
+	static logError(data: any): void {
+		console.error(this.prefix, data);
+	}
+}

src/InputField.ts renamed to src/MarkdownInputField.ts

@@ -1,9 +1,12 @@
-import {MarkdownRenderChild, SliderComponent, TextComponent, TFile, ToggleComponent} from 'obsidian';
+import {MarkdownRenderChild, SliderComponent, TextComponent, TFile, ToggleComponent, ValueComponent} from 'obsidian';
 import MetaBindPlugin from './main';
+import {Logger} from './Logger';
 
-export class InputField extends MarkdownRenderChild {
+export class MarkdownInputField extends MarkdownRenderChild {
 	plugin: MetaBindPlugin;
 	metaData: any;
+	uid: number;
+	inputElement: ValueComponent<any>;
 	error: string;
 
 	declaration: string;
@@ -12,22 +15,23 @@ export class InputField extends MarkdownRenderChild {
 	boundMetadataField: string;
 	file: TFile;
 
-	limitInterval: NodeJS.Timer;
+	limitInterval: number;
 	intervalCounter: number;
 	valueQueue: any[];
 
-	constructor(containerEl: HTMLElement, fullDeclaration: string, plugin: MetaBindPlugin, filePath: string) {
+	constructor(containerEl: HTMLElement, fullDeclaration: string, plugin: MetaBindPlugin, filePath: string, uid: number) {
 		super(containerEl);
 
 		//console.log(this, 2)
 
 		this.error = '';
 		this.declaration = fullDeclaration;
+		this.uid = uid;
 		this.plugin = plugin;
 
 		this.valueQueue = [];
 		this.intervalCounter = 0;
-		this.limitInterval = setInterval(this.incrementInterval.bind(this), 10);
+		this.limitInterval = window.setInterval(this.incrementInterval.bind(this), 10);
 
 		const regExp = new RegExp(/\[.*?\]/);
 		let declaration = regExp.exec(fullDeclaration)[0];
@@ -93,16 +97,25 @@ export class InputField extends MarkdownRenderChild {
 		}
 	}
 
+	updateValue(value: any) {
+		if (value != null && this.inputElement.getValue() !== value && this.valueQueue.length === 0) {
+			Logger.logDebug(`updating input field ${this.uid} to '${value.toString()}'`);
+			this.inputElement.setValue(value);
+		}
+	}
+
 	getInitialValue() {
 		// console.log(this);
 		if (this.isBound) {
 			return this.metaData[this.boundMetadataField];
 		}
 	}
 
-	onload() {
+	async onload() {
 		//console.log('load', this);
 
+		this.metaData = await this.metaData;
+
 		const container = this.containerEl.createDiv();
 		container.addClass('meta-bind-plugin-input-wrapper');
 
@@ -113,34 +126,42 @@ export class InputField extends MarkdownRenderChild {
 			return;
 		}
 
+		this.plugin.registerMarkdownInputField(this);
+
 		if (this.inputFieldType === 'toggle') {
 			const newEl = new ToggleComponent(container);
 			newEl.setValue(this.getInitialValue());
 			newEl.onChange(async (value) => {
 				await this.updateMetaData(value);
 			});
+			this.inputElement = newEl;
 		} else if (this.inputFieldType === 'slider') {
 			const newEl = new SliderComponent(container);
 			newEl.setValue(this.getInitialValue());
 			newEl.onChange(async (value) => {
 				await this.updateMetaData(value);
 			});
+			newEl.setDynamicTooltip();
+			this.inputElement = newEl;
 		} else if (this.inputFieldType === 'text') {
 			const newEl = new TextComponent(container);
 			newEl.setValue(this.getInitialValue());
 			newEl.onChange(async (value) => {
 				await this.updateMetaData(value);
 			});
+			this.inputElement = newEl;
 		}
 
 		this.containerEl.empty();
 		this.containerEl.appendChild(container);
 	}
 
 	onunload() {
+		this.plugin.unregisterMarkdownInputField(this);
+
 		super.onunload();
 
 		//console.log('unload', this);
-		clearInterval(this.limitInterval);
+		window.clearInterval(this.limitInterval);
 	}
 }

src/main.ts

@@ -1,19 +1,22 @@
-import {Notice, Plugin, stringifyYaml, TFile} from 'obsidian';
+import {parseYaml, Plugin, stringifyYaml, TFile} from 'obsidian';
 import {DEFAULT_SETTINGS, MetaBindPluginSettings, MetaBindSettingTab} from './settings/Settings';
-import {InputField} from './InputField';
+import {MarkdownInputField} from './MarkdownInputField';
 import {getFileName, isPath, removeFileEnding} from './Utils';
+import {Logger} from './Logger';
 
 export default class MetaBindPlugin extends Plugin {
 	settings: MetaBindPluginSettings;
 
+	activeMarkdownInputFields: MarkdownInputField[];
+	markDownInputFieldIndex: number;
+
 	async onload() {
 		await this.loadSettings();
 
-		// This creates an icon in the left ribbon.
-		const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
-
-		});
+		Logger.plugin = this;
 
+		this.activeMarkdownInputFields = [];
+		this.markDownInputFieldIndex = 0;
 
 		this.registerMarkdownPostProcessor((element, context) => {
 			const codeBlocks = element.querySelectorAll('code');
@@ -23,24 +26,51 @@ export default class MetaBindPlugin extends Plugin {
 				const isInputField = text.startsWith('INPUT[') && text.endsWith(']');
 				// console.log(context.sourcePath);
 				if (isInputField) {
-					context.addChild(new InputField(codeBlock, text, this, context.sourcePath));
+					context.addChild(new MarkdownInputField(codeBlock, text, this, context.sourcePath, this.markDownInputFieldIndex));
+					this.markDownInputFieldIndex += 1;
 				}
 			}
 		});
 
-		this.registerEvent(this.app.vault.on('modify', () => {
-			// console.log('file modified')
+		this.registerEvent(this.app.vault.on('modify', async abstractFile => {
+			if (abstractFile instanceof TFile) {
+				await this.updateMarkdownInputFieldsOnFileChange(abstractFile as TFile);
+			}
 		}));
 
 		this.addSettingTab(new MetaBindSettingTab(this.app, this));
 	}
 
 	onunload() {
+		for (const activeMarkdownInputField of this.activeMarkdownInputFields) {
+			activeMarkdownInputField.unload();
+		}
+	}
+
+	registerMarkdownInputField(markdownInputField: MarkdownInputField) {
+		this.activeMarkdownInputFields.push(markdownInputField);
+	}
 
+	unregisterMarkdownInputField(markdownInputField: MarkdownInputField) {
+		this.activeMarkdownInputFields = this.activeMarkdownInputFields.filter(x => x.uid !== markdownInputField.uid);
+	}
+
+	async updateMarkdownInputFieldsOnFileChange(file: TFile) {
+		const metadata = await this.getMetaDataForFile(file);
+
+		for (const activeMarkdownInputField of this.activeMarkdownInputFields) {
+			if (!activeMarkdownInputField.file || !activeMarkdownInputField.isBound) {
+				continue;
+			}
+
+			if (activeMarkdownInputField.file.path === file.path) {
+				activeMarkdownInputField.updateValue(metadata[activeMarkdownInputField.boundMetadataField]);
+			}
+		}
 	}
 
 	async updateMetaData(key: string, value: any, file: TFile) {
-		// console.log('update', key, value);
+		Logger.logDebug(`updating '${key}: ${value}' in '${file.path}'`);
 
 		if (!file) {
 			console.log('no file');
@@ -51,12 +81,14 @@ export default class MetaBindPlugin extends Plugin {
 		const regExp = new RegExp('^(---)\\n[\\s\\S]*\\n---');
 		fileContent = fileContent.replace(regExp, '');
 
-		let metadata: any = this.getMetaDataForFile(file);
+		let metadata: any = await this.getMetaDataForFile(file);
+		// console.log(metadata);
 		if (!metadata) {
 			return;
 		}
 
 		metadata[key] = value;
+		// console.log(metadata);
 
 		fileContent = `---\n${stringifyYaml(metadata)}---` + fileContent;
 		await this.app.vault.modify(file, fileContent);
@@ -82,8 +114,12 @@ export default class MetaBindPlugin extends Plugin {
 		return files;
 	}
 
-	getMetaDataForFile(file: TFile): any {
+	async getMetaDataForFile(file: TFile): Promise<any> {
+		// console.log(`reading metadata for ${file.path}`);
+
 		let metadata: any;
+
+		/* metadata cache is unreliable and might not be updated yet
 		try {
 			metadata = this.app.metadataCache.getFileCache(file).frontmatter;
 		} catch (e) {
@@ -98,6 +134,26 @@ export default class MetaBindPlugin extends Plugin {
 		} else {
 			metadata = {};
 		}
+		*/
+
+		let fileContent: string = await this.app.vault.read(file);
+		const regExp = new RegExp('^(---)\\n[\\s\\S]*\\n---');
+		let frontMatter = regExp.exec(fileContent)[0];
+		if (frontMatter === null) {
+			return {};
+		}
+		// console.log(frontMatter);
+		frontMatter = frontMatter.substring(4);
+		frontMatter = frontMatter.substring(0, frontMatter.length - 3);
+		// console.log(frontMatter);
+
+		metadata = parseYaml(frontMatter);
+
+		if (!metadata) {
+			metadata = {};
+		}
+
+		//console.log(metadata);
 
 		return metadata;
 	}