refactor errors to own file

mProjectsCode · mProjectsCode · commit 51e4296e7d5f · 2022-12-02T17:06:54.000+01:00
diff --git a/src/InputFieldMarkdownRenderChild.ts b/src/InputFieldMarkdownRenderChild.ts
@@ -3,11 +3,11 @@ import MetaBindPlugin from './main';
 import { AbstractInputField } from './inputFields/AbstractInputField';
 import { InputFieldFactory } from './inputFields/InputFieldFactory';
 import { InputFieldArgumentType, InputFieldDeclaration, InputFieldDeclarationParser } from './parsers/InputFieldDeclarationParser';
-import { MetaBindBindTargetError, MetaBindInternalError } from './utils/Utils';
 import { AbstractInputFieldArgument } from './inputFieldArguments/AbstractInputFieldArgument';
 import { ClassInputFieldArgument } from './inputFieldArguments/ClassInputFieldArgument';
 import { getFrontmatterOfTFile, updateOrInsertFieldInTFile } from '@opd-libs/opd-metadata-lib/lib/API';
 import { traverseObject, validatePath as validateObjectPath } from '@opd-libs/opd-metadata-lib/lib/Utils';
+import { MetaBindBindTargetError, MetaBindInternalError } from './utils/MetaBindErrors';
 
 export enum InputFieldMarkdownRenderChildType {
 	INLINE_CODE_BLOCK,
diff --git a/src/inputFieldArguments/InputFieldArgumentContainer.ts b/src/inputFieldArguments/InputFieldArgumentContainer.ts
@@ -1,6 +1,6 @@
 import { AbstractInputFieldArgument } from './AbstractInputFieldArgument';
 import { InputFieldArgumentType } from '../parsers/InputFieldDeclarationParser';
-import { MetaBindParsingError } from '../utils/Utils';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export class InputFieldArgumentContainer {
 	arguments: AbstractInputFieldArgument[] = [];
diff --git a/src/inputFieldArguments/InputFieldArgumentFactory.ts b/src/inputFieldArguments/InputFieldArgumentFactory.ts
@@ -1,4 +1,3 @@
-import { MetaBindParsingError } from '../utils/Utils';
 import { InputFieldArgumentType } from '../parsers/InputFieldDeclarationParser';
 import { ClassInputFieldArgument } from './ClassInputFieldArgument';
 import { AddLabelsInputFieldArgument } from './AddLabelsInputFieldArgument';
@@ -9,6 +8,7 @@ import { TitleInputFieldArgument } from './TitleInputFieldArgument';
 import { AlignRightInputFieldArgument } from './AlignRightInputFieldArgument';
 import { SuggestOptionInputFieldArgument } from './SuggestOptionInputFieldArgument';
 import { SuggestOptionQueryInputFieldArgument } from './SuggestOptionQueryInputFieldArgument';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export class InputFieldArgumentFactory {
 	static createInputFieldArgument(argumentIdentifier: string) {
diff --git a/src/inputFieldArguments/MaxValueInputFieldArgument.ts b/src/inputFieldArguments/MaxValueInputFieldArgument.ts
@@ -1,6 +1,6 @@
 import { AbstractInputFieldArgument } from './AbstractInputFieldArgument';
 import { InputFieldArgumentType, InputFieldType } from '../parsers/InputFieldDeclarationParser';
-import { MetaBindParsingError } from '../utils/Utils';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export class MaxValueInputFieldArgument extends AbstractInputFieldArgument {
 	identifier: InputFieldArgumentType = InputFieldArgumentType.MAX_VALUE;
diff --git a/src/inputFieldArguments/MinValueInputFieldArgument.ts b/src/inputFieldArguments/MinValueInputFieldArgument.ts
@@ -1,6 +1,6 @@
 import { AbstractInputFieldArgument } from './AbstractInputFieldArgument';
 import { InputFieldArgumentType, InputFieldType } from '../parsers/InputFieldDeclarationParser';
-import { MetaBindParsingError } from '../utils/Utils';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export class MinValueInputFieldArgument extends AbstractInputFieldArgument {
 	identifier: InputFieldArgumentType = InputFieldArgumentType.MIN_VALUE;
diff --git a/src/inputFields/DateInputField.ts b/src/inputFields/DateInputField.ts
@@ -2,7 +2,7 @@ import { AbstractInputField } from './AbstractInputField';
 import { DropdownComponent, moment, TextComponent } from 'obsidian';
 import { InputFieldMarkdownRenderChild } from '../InputFieldMarkdownRenderChild';
 import { DateParser } from '../parsers/DateParser';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class DateInputField extends AbstractInputField {
 	container: HTMLDivElement | undefined;
diff --git a/src/inputFields/DatePicker/DatePickerInputField.ts b/src/inputFields/DatePicker/DatePickerInputField.ts
@@ -1,11 +1,11 @@
 import { InputFieldMarkdownRenderChild } from '../../InputFieldMarkdownRenderChild';
 import { AbstractInputField } from '../AbstractInputField';
-import { MetaBindInternalError } from '../../utils/Utils';
 import DatePickerInput from './DatePickerInput.svelte';
 import { moment } from 'obsidian';
 import { DateParser } from '../../parsers/DateParser';
 import { DatePickerModal } from './DatePickerModal';
 import { Moment } from 'moment';
+import { MetaBindInternalError } from '../../utils/MetaBindErrors';
 
 export class DatePickerInputField extends AbstractInputField {
 	container: HTMLDivElement | undefined;
diff --git a/src/inputFields/InputFieldFactory.ts b/src/inputFields/InputFieldFactory.ts
@@ -7,12 +7,12 @@ import { SelectInputField } from './SelectInputField';
 import { MultiSelectInputField } from './MultiSelectInputField';
 import { DateInputField } from './DateInputField';
 import { TimeInputField } from './TimeInputField';
-import { MetaBindParsingError } from '../utils/Utils';
 import { AbstractInputField } from './AbstractInputField';
 import { InputFieldType } from '../parsers/InputFieldDeclarationParser';
 import { DatePickerInputField } from './DatePicker/DatePickerInputField';
 import { NumberInputField } from './NumberInputField';
 import { SuggestInputField } from './Suggest/SuggestInputField';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export class InputFieldFactory {
 	static allowCodeBlockMap: Record<string, { codeBlock: boolean; inlineCodeBlock: boolean }> = {
diff --git a/src/inputFields/NumberInputField.ts b/src/inputFields/NumberInputField.ts
@@ -1,6 +1,7 @@
 import { AbstractInputField } from './AbstractInputField';
 import { TextComponent } from 'obsidian';
-import { MetaBindInternalError, MetaBindValueError, numberToString } from '../utils/Utils';
+import { numberToString } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class NumberInputField extends AbstractInputField {
 	numberComponent: TextComponent | undefined;
diff --git a/src/inputFields/SelectInputField.ts b/src/inputFields/SelectInputField.ts
@@ -1,9 +1,10 @@
 import { AbstractInputField } from './AbstractInputField';
 import { SelectInputFieldElement } from './SelectInputFieldElement';
-import { MetaBindInternalError, mod } from '../utils/Utils';
+import { mod } from '../utils/Utils';
 import { InputFieldMarkdownRenderChild } from '../InputFieldMarkdownRenderChild';
 import { InputFieldArgumentType } from '../parsers/InputFieldDeclarationParser';
 import { AbstractInputFieldArgument } from '../inputFieldArguments/AbstractInputFieldArgument';
+import { MetaBindInternalError } from '../utils/MetaBindErrors';
 
 export class SelectInputField extends AbstractInputField {
 	static allowInlineCodeBlock: boolean = false;
diff --git a/src/inputFields/SliderInputField.ts b/src/inputFields/SliderInputField.ts
@@ -1,8 +1,8 @@
 import { AbstractInputField } from './AbstractInputField';
 import { SliderComponent } from 'obsidian';
 import { InputFieldMarkdownRenderChild } from '../InputFieldMarkdownRenderChild';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
 import { InputFieldArgumentType } from '../parsers/InputFieldDeclarationParser';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class SliderInputField extends AbstractInputField {
 	sliderComponent: SliderComponent | undefined;
diff --git a/src/inputFields/Suggest/SuggestInputField.ts b/src/inputFields/Suggest/SuggestInputField.ts
@@ -1,12 +1,12 @@
 import { InputFieldMarkdownRenderChild } from '../../InputFieldMarkdownRenderChild';
 import { AbstractInputField } from '../AbstractInputField';
-import { MetaBindArgumentError, MetaBindInternalError } from '../../utils/Utils';
 import Suggest from './Suggest.svelte';
 import { InputFieldArgumentType } from '../../parsers/InputFieldDeclarationParser';
 import { DataArray, getAPI, Literal } from 'obsidian-dataview';
 import { AbstractInputFieldArgument } from '../../inputFieldArguments/AbstractInputFieldArgument';
 import { SuggestInputModal } from './SuggestInputModal';
-import { TFile } from 'obsidian';
+import { Notice, TFile } from 'obsidian';
+import { MetaBindArgumentError, MetaBindInternalError } from '../../utils/MetaBindErrors';
 
 export interface SuggestOption {
 	value: string;
@@ -24,6 +24,12 @@ export class SuggestInputField extends AbstractInputField {
 
 		this.value = '';
 		this.options = [];
+
+		if (this.needsDataview()) {
+			if (!getAPI(this.inputFieldMarkdownRenderChild.plugin.app)) {
+				throw new MetaBindArgumentError(`dataview needs to be installed and enabled to use suggest option queries`);
+			}
+		}
 	}
 
 	getValue(): string {
@@ -51,6 +57,10 @@ export class SuggestInputField extends AbstractInputField {
 		return this.container;
 	}
 
+	needsDataview(): boolean {
+		return this.inputFieldMarkdownRenderChild.getArguments(InputFieldArgumentType.SUGGEST_OPTION_QUERY).length > 0;
+	}
+
 	async getOptions(): Promise<void> {
 		this.options = [];
 
@@ -65,7 +75,8 @@ export class SuggestInputField extends AbstractInputField {
 			const dv = getAPI(this.inputFieldMarkdownRenderChild.plugin.app);
 
 			if (!dv) {
-				throw new MetaBindArgumentError(`dataview needs to be installed and enabled to use suggest option queries`);
+				new Notice('meta-bind | dataview needs to be installed and enabled to use suggest option queries');
+				return;
 			}
 
 			for (const suggestOptionsQueryArgument of suggestOptionsQueryArguments) {
diff --git a/src/inputFields/TextAreaInputField.ts b/src/inputFields/TextAreaInputField.ts
@@ -1,6 +1,6 @@
 import { AbstractInputField } from './AbstractInputField';
 import { TextAreaComponent } from 'obsidian';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class TextAreaInputField extends AbstractInputField {
 	textAreaComponent: TextAreaComponent | undefined;
diff --git a/src/inputFields/TextInputField.ts b/src/inputFields/TextInputField.ts
@@ -1,6 +1,6 @@
 import { AbstractInputField } from './AbstractInputField';
 import { TextComponent } from 'obsidian';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class TextInputField extends AbstractInputField {
 	textComponent: TextComponent | undefined;
diff --git a/src/inputFields/TimeInputField.ts b/src/inputFields/TimeInputField.ts
@@ -2,7 +2,7 @@ import { AbstractInputField } from './AbstractInputField';
 import { DropdownComponent } from 'obsidian';
 import { InputFieldMarkdownRenderChild } from '../InputFieldMarkdownRenderChild';
 import { Time, TimeParser } from '../parsers/TimeParser';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class TimeInputField extends AbstractInputField {
 	container: HTMLDivElement | undefined;
diff --git a/src/inputFields/ToggleInputField.ts b/src/inputFields/ToggleInputField.ts
@@ -1,6 +1,6 @@
 import { AbstractInputField } from './AbstractInputField';
 import { ToggleComponent } from 'obsidian';
-import { MetaBindInternalError, MetaBindValueError } from '../utils/Utils';
+import { MetaBindInternalError, MetaBindValueError } from '../utils/MetaBindErrors';
 
 export class ToggleInputField extends AbstractInputField {
 	toggleComponent: ToggleComponent | undefined;
diff --git a/src/main.ts b/src/main.ts
@@ -1,10 +1,11 @@
 import { CachedMetadata, FrontMatterCache, Plugin, TFile } from 'obsidian';
 import { DEFAULT_SETTINGS, MetaBindPluginSettings, MetaBindSettingTab } from './settings/Settings';
 import { InputFieldMarkdownRenderChild, InputFieldMarkdownRenderChildType } from './InputFieldMarkdownRenderChild';
-import { getFileName, isPath, MetaBindInternalError, removeFileEnding } from './utils/Utils';
+import { getFileName, isPath, removeFileEnding } from './utils/Utils';
 import { DateParser } from './parsers/DateParser';
 import { InputFieldDeclarationParser } from './parsers/InputFieldDeclarationParser';
 import { traverseObject } from '@opd-libs/opd-metadata-lib/lib/Utils';
+import { MetaBindInternalError } from './utils/MetaBindErrors';
 
 export default class MetaBindPlugin extends Plugin {
 	// @ts-ignore defined in `onload`
diff --git a/src/parsers/InputFieldDeclarationParser.ts b/src/parsers/InputFieldDeclarationParser.ts
@@ -1,7 +1,8 @@
 import { EnclosingPair, ParserUtils } from '../utils/ParserUtils';
-import { isTruthy, MetaBindParsingError } from '../utils/Utils';
+import { isTruthy } from '../utils/Utils';
 import { InputFieldArgumentFactory } from '../inputFieldArguments/InputFieldArgumentFactory';
 import { InputFieldArgumentContainer } from '../inputFieldArguments/InputFieldArgumentContainer';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export enum InputFieldType {
 	TOGGLE = 'toggle',
diff --git a/src/parsers/MarkdownLinkParser.ts b/src/parsers/MarkdownLinkParser.ts
@@ -1,5 +1,5 @@
 import { EnclosingPair, ParserUtils } from '../utils/ParserUtils';
-import { MetaBindParsingError } from '../utils/Utils';
+import { MetaBindParsingError } from '../utils/MetaBindErrors';
 
 export interface MarkdownLink {
 	isEmbed: boolean;
diff --git a/src/utils/MetaBindErrors.ts b/src/utils/MetaBindErrors.ts
@@ -0,0 +1,29 @@
+export class MetaBindInternalError extends Error {
+	constructor(message: string) {
+		super(`[MB_INTERNAL_ERROR - please report this error here https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues] ${message}`);
+	}
+}
+
+export class MetaBindParsingError extends Error {
+	constructor(message: string) {
+		super(`[MB_PARSING_ERROR] ${message}`);
+	}
+}
+
+export class MetaBindBindTargetError extends Error {
+	constructor(message: string) {
+		super(`[MB_BIND_TARGET_ERROR] ${message}`);
+	}
+}
+
+export class MetaBindValueError extends Error {
+	constructor(message: string) {
+		super(`[MB_VALUE_ERROR] ${message}`);
+	}
+}
+
+export class MetaBindArgumentError extends Error {
+	constructor(message: string) {
+		super(`[MB_ARGUMENT_ERROR] ${message}`);
+	}
+}
diff --git a/src/utils/ParserUtils.ts b/src/utils/ParserUtils.ts
@@ -1,4 +1,5 @@
-import { equalOrIncludes, isFalsy, MetaBindInternalError } from './Utils';
+import { equalOrIncludes, isFalsy } from './Utils';
+import { MetaBindInternalError } from './MetaBindErrors';
 
 export class EnclosingPair {
 	readonly openingEqualsClosing: boolean;
diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
@@ -1,33 +1,3 @@
-export class MetaBindInternalError extends Error {
-	constructor(message: string) {
-		super(`[MB_INTERNAL_ERROR - please report this error here https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues] ${message}`);
-	}
-}
-
-export class MetaBindParsingError extends Error {
-	constructor(message: string) {
-		super(`[MB_PARSING_ERROR] ${message}`);
-	}
-}
-
-export class MetaBindBindTargetError extends Error {
-	constructor(message: string) {
-		super(`[MB_BIND_TARGET_ERROR] ${message}`);
-	}
-}
-
-export class MetaBindValueError extends Error {
-	constructor(message: string) {
-		super(`[MB_VALUE_ERROR] ${message}`);
-	}
-}
-
-export class MetaBindArgumentError extends Error {
-	constructor(message: string) {
-		super(`[MB_ARGUMENT_ERROR] ${message}`);
-	}
-}
-
 /**
  * Gets the file name from a path
  *
@@ -105,84 +75,6 @@ export function arrayEquals(arr1: any[], arr2: any[]): boolean {
 	return true;
 }
 
-/**
- * Template "engine" from my media db plugin
- *
- * @param template
- * @param dataModel
- */
-export function replaceTags(template: string, dataModel: any): string {
-	return template.replace(new RegExp('{{.*?}}', 'g'), (match: string) => replaceTag(match, dataModel));
-}
-
-/**
- * Takes in a template match and returns the replacement data
- *
- * @param match
- * @param dataModel
- */
-function replaceTag(match: string, dataModel: any): string {
-	let tag = match;
-	tag = tag.substring(2);
-	tag = tag.substring(0, tag.length - 2);
-	tag = tag.trim();
-
-	const parts = tag.split(':');
-	if (parts.length === 1) {
-		const path = parts[0].split('.');
-
-		const obj = traverseObject(path, dataModel);
-
-		if (obj === undefined) {
-			return '{{ INVALID TEMPLATE TAG - object undefined }}';
-		}
-
-		return obj;
-	} else if (parts.length === 2) {
-		const operator = parts[0];
-
-		const path = parts[1].split('.');
-
-		const obj = traverseObject(path, dataModel);
-
-		if (obj === undefined) {
-			return '{{ INVALID TEMPLATE TAG - object undefined }}';
-		}
-
-		if (operator === 'LIST') {
-			if (!Array.isArray(obj)) {
-				return '{{ INVALID TEMPLATE TAG - operator LIST is only applicable on an array }}';
-			}
-			return obj.map((e: any) => `- ${e}`).join('\n');
-		} else if (operator === 'ENUM') {
-			if (!Array.isArray(obj)) {
-				return '{{ INVALID TEMPLATE TAG - operator ENUM is only applicable on an array }}';
-			}
-			return obj.join(', ');
-		}
-
-		return `{{ INVALID TEMPLATE TAG - unknown operator ${operator} }}`;
-	}
-
-	return '{{ INVALID TEMPLATE TAG }}';
-}
-
-/**
- * Traverses the object along a property path
- *
- * @param path
- * @param obj
- */
-function traverseObject(path: Array<string>, obj: any): any {
-	for (const part of path) {
-		if (obj !== undefined) {
-			obj = obj[part];
-		}
-	}
-
-	return obj;
-}
-
 export function isTruthy(value: any): boolean {
 	return !!value;
 }
