exclude folder

Author: mProjectsCode

CHANGELOG.md

@@ -11,12 +11,17 @@ New Features
 -   `placeholder` input field argument
     -   lets you define a placeholder value to be displayed in the input field, if no value is set
     -   works on the following input fields `text`, `textArea`, `number` and `list`
+-   specific folders can now be excluded in the setting, excluding means that the plugin will not show input or view fields in these folders
+-   the `option` argument now allows for a name and a value, e.g. `option(value, displayName)`
+-   numbers and booleans will now be recognized and treated as such
+    -   e.g. `option(5, 5 Stars)` will set the metadata to the number 5 instead of the string '5'
+    -   e.g. `offValue(0)` will set the metadata to the number 0 instead of the string '0'
 
 Changes
 
 -   new parser for input fields, view fields and bind targets
     -   input fields now display way better error messages
-    -   i tried not to introduce breaking changes, but some might have slipped through
+    -   I tried not to introduce breaking changes, but some might have slipped through
     -   this is also why the update took so long
 -   new API to create input field using code (e.g. using dataviewJS or [JS Engine](https://github.com/mProjectsCode/obsidian-js-engine-plugin))
     -   this is a breaking change
@@ -25,6 +30,7 @@ Bug Fixes
 
 -   fixed a bug with the metadata cache when the frontmatter was invalid
 -   fixed a bug with view fields that caused an error when referencing metadata from another file
+-   fixed`toggle` with `offValue` sometimes showing the wrong toggle state
 
 # 0.5.1
 

src/api/API.ts

@@ -10,6 +10,7 @@ import { Component, MarkdownPostProcessorContext } from 'obsidian';
 import { InputFieldAPI } from './InputFieldAPI';
 import { UnvalidatedInputFieldDeclaration } from '../parsers/newInputFieldParser/InputFieldDeclarationValidator';
 import { IAPI } from './IAPI';
+import { ExcludedMDRC } from '../renderChildren/ExcludedMDRC';
 
 export class API implements IAPI {
 	public plugin: MetaBindPlugin;
@@ -37,7 +38,11 @@ export class API implements IAPI {
 		filePath: string,
 		containerEl: HTMLElement,
 		component: Component | MarkdownPostProcessorContext
-	): InputFieldMDRC {
+	): InputFieldMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
 		const declaration = this.newInputFieldParser.validateDeclaration(unvalidatedDeclaration);
 
 		const inputField = new InputFieldMDRC(containerEl, renderType, declaration, this.plugin, filePath, self.crypto.randomUUID());
@@ -52,7 +57,11 @@ export class API implements IAPI {
 		filePath: string,
 		containerEl: HTMLElement,
 		component: Component | MarkdownPostProcessorContext
-	): InputFieldMDRC {
+	): InputFieldMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
 		const declaration: InputFieldDeclaration = this.newInputFieldParser.parseString(fullDeclaration);
 
 		const inputField = new InputFieldMDRC(containerEl, renderType, declaration, this.plugin, filePath, self.crypto.randomUUID());
@@ -65,12 +74,16 @@ export class API implements IAPI {
 		fullDeclaration: string,
 		renderType: RenderChildType,
 		filePath: string,
-		container: HTMLElement,
+		containerEl: HTMLElement,
 		component: Component | MarkdownPostProcessorContext
-	): ViewFieldMDRC {
+	): ViewFieldMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
 		const declaration: ViewFieldDeclaration = this.viewFieldParser.parseString(fullDeclaration);
 
-		const viewField = new ViewFieldMDRC(container, renderType, declaration, this.plugin, filePath, self.crypto.randomUUID());
+		const viewField = new ViewFieldMDRC(containerEl, renderType, declaration, this.plugin, filePath, self.crypto.randomUUID());
 		component.addChild(viewField);
 
 		return viewField;
@@ -82,12 +95,23 @@ export class API implements IAPI {
 		filePath: string,
 		containerEl: HTMLElement,
 		component: Component | MarkdownPostProcessorContext
-	): JsViewFieldMDRC {
+	): JsViewFieldMDRC | ExcludedMDRC {
+		if (this.plugin.isFilePathExcluded(filePath)) {
+			return this.createExcludedField(containerEl, filePath, component);
+		}
+
 		const declaration: JsViewFieldDeclaration = this.viewFieldParser.parseJsString(fullDeclaration);
 
 		const viewField = new JsViewFieldMDRC(containerEl, renderType, declaration, this.plugin, filePath, self.crypto.randomUUID());
 		component.addChild(viewField);
 
 		return viewField;
 	}
+
+	public createExcludedField(containerEl: HTMLElement, filePath: string, component: Component | MarkdownPostProcessorContext): ExcludedMDRC {
+		const excludedField = new ExcludedMDRC(containerEl, RenderChildType.INLINE, this.plugin, filePath, self.crypto.randomUUID());
+		component.addChild(excludedField);
+
+		return excludedField;
+	}
 }

src/main.ts

@@ -63,11 +63,11 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 				const isViewField = content.startsWith('VIEW[') && content.endsWith(']');
 				if (isInputField) {
 					const inputField = this.api.createInputFieldFromString(content, RenderChildType.INLINE, ctx.sourcePath, codeBlock, ctx);
-					ctx.addChild(inputField);
+					// ctx.addChild(inputField);
 				}
 				if (isViewField) {
 					const viewField = this.api.createViewFieldFromString(content, RenderChildType.INLINE, ctx.sourcePath, codeBlock, ctx);
-					ctx.addChild(viewField);
+					// ctx.addChild(viewField);
 				}
 			}
 		}, 100);
@@ -78,22 +78,16 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 			const isInputField = content.startsWith('INPUT[') && content.endsWith(']');
 			if (isInputField) {
 				const inputField = this.api.createInputFieldFromString(content, RenderChildType.BLOCK, ctx.sourcePath, codeBlock, ctx);
-				ctx.addChild(inputField);
+				// ctx.addChild(inputField);
 			}
 		});
 
 		this.registerMarkdownCodeBlockProcessor('meta-bind-js-view', (source, el, ctx) => {
 			const inputField = this.api.createJsViewFieldFromString(source, RenderChildType.BLOCK, ctx.sourcePath, el, ctx);
-			ctx.addChild(inputField);
+			// ctx.addChild(inputField);
 		});
 
-		// this.registerMarkdownCodeBlockProcessor('meta-bind-js', (source, el, ctx) => {
-		// 	ctx.addChild(new ScriptMarkdownRenderChild(el, source, ctx, this));
-		// });
-
 		this.registerEditorExtension(createMarkdownRenderChildWidgetEditorPlugin(this));
-		// const languageCompartment = new Compartment();
-		// this.registerEditorExtension(languageCompartment.of(javascript()));
 
 		this.addCommand({
 			id: 'mb-debugger-command',
@@ -103,32 +97,6 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 			},
 		});
 
-		// this.addCommand({
-		// 	id: 'mb-test-command',
-		// 	name: 'test command',
-		// 	editorCallback: (editor: Editor, view: MarkdownView | MarkdownFileInfo) => {
-		// 		if (view.file) {
-		// 			this.app.fileManager.processFrontMatter(view.file, frontmatter => {
-		// 				return frontmatter;
-		// 			});
-		// 		}
-		// 	},
-		// });
-
-		// if (this.settings.devMode) {
-		// 	this.addCommand({
-		// 		id: 'meta-bind-debug',
-		// 		name: 'Trip Debugger',
-		// 		callback: () => {
-		// 			debugger;
-		// 		},
-		// 	});
-		// }
-		//
-		// this.app.workspace.onLayoutReady(async () => {
-		// 	await this.registerCodeMirrorMode();
-		// });
-
 		this.addSettingTab(new MetaBindSettingTab(this.app, this));
 	}
 
@@ -159,6 +127,16 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 		return filePaths;
 	}
 
+	isFilePathExcluded(path: string): boolean {
+		for (const excludedFolder of this.settings.excludedFolders) {
+			if (path.startsWith(excludedFolder)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
 	async loadSettings(): Promise<void> {
 		console.log(`meta-bind | Main >> settings load`);
 

src/metadata/MetadataManager.ts

@@ -150,7 +150,6 @@ export class MetadataManager {
 			return;
 		}
 
-		console.warn(pathParts, fileCache.metadata, filePath);
 		const { parent, child } = traverseObjectToParentByPath(pathParts, fileCache.metadata);
 
 		if (parent.value === undefined) {

src/renderChildren/AbstractMDRC.ts

@@ -17,7 +17,7 @@ export class AbstractMDRC extends MarkdownRenderChild {
 		plugin: MetaBindPlugin,
 		filePath: string,
 		uuid: string,
-		frontmatter: any | null | undefined
+		frontmatter?: any | null | undefined
 	) {
 		super(containerEl);
 

src/renderChildren/ExcludedMDRC.ts

@@ -0,0 +1,11 @@
+import { AbstractMDRC } from './AbstractMDRC';
+
+export class ExcludedMDRC extends AbstractMDRC {
+	public onload(): void {
+		console.log('meta-bind | ExcludedMDRC >> load', this);
+
+		this.containerEl.empty();
+
+		this.containerEl.createEl('span', { text: 'this folder has been excluded in the meta bind plugin settings', cls: 'meta-bind-plugin-error' });
+	}
+}