start of better error messages

Author: mProjectsCode

exampleVault/Buttons/Button Example.md

@@ -275,6 +275,17 @@ actions:
 
 ```
 
+```meta-bind-button
+label: Test
+hidden: false
+id: ""
+style: default
+actions:
+  - type: aaaa
+  - type: command
+    command: obsidian-meta-bind-plugin:open-help
+
+```
 
 ```meta-bind-button
 label: Test
@@ -286,3 +297,4 @@ actions:
     command: obsidian-meta-bind-plugin:open-help
 
 ```
+

packages/core/src/api/API.ts

@@ -46,7 +46,7 @@ import {
 	V_TableFieldOptions,
 	V_ViewFieldOptions,
 } from 'packages/core/src/api/Validators';
-import { validate } from 'packages/core/src/utils/ZodUtils';
+import { validateAPIArgs } from 'packages/core/src/utils/ZodUtils';
 import { z } from 'zod';
 import { TableMountable } from 'packages/core/src/fields/metaBindTable/TableMountable';
 import {
@@ -131,7 +131,7 @@ export abstract class API<Plugin extends IPlugin> {
 		options: FieldOptionMap[Type],
 		honorExcludedSetting: boolean = true,
 	): FieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				type: V_FieldType,
 				filePath: V_FilePath,
@@ -193,7 +193,7 @@ export abstract class API<Plugin extends IPlugin> {
 		position?: NotePosition | undefined,
 		honorExcludedSetting: boolean = true,
 	): FieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				fieldString: z.string(),
 				filePath: V_FilePath,
@@ -251,7 +251,7 @@ export abstract class API<Plugin extends IPlugin> {
 		position?: NotePosition | undefined,
 		honorExcludedSetting: boolean = true,
 	): FieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				type: V_FieldType,
 				declaration: z.string(),
@@ -314,7 +314,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createInputFieldMountable(filePath: string, options: InputFieldOptions): InputFieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_InputFieldOptions,
@@ -348,7 +348,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createViewFieldMountable(filePath: string, options: ViewFieldOptions): ViewFieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_ViewFieldOptions,
@@ -382,7 +382,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createJsViewFieldMountable(filePath: string, options: JsViewFieldOptions): JsViewFieldMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_JsViewFieldOptions,
@@ -412,7 +412,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createTableMountable(filePath: string, options: TableOptions): TableMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_TableFieldOptions,
@@ -435,7 +435,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createButtonGroupMountable(filePath: string, options: ButtonGroupOptions): ButtonGroupMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_InlineButtonOptions,
@@ -472,7 +472,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createButtonMountable(filePath: string, options: ButtonOptions): ButtonMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_ButtonOptions,
@@ -502,7 +502,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param options
 	 */
 	public createEmbedMountable(filePath: string, options: EmbedOptions): EmbedMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 				options: V_EmbedOptions,
@@ -523,7 +523,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param filePath the file path that the field is located in or an empty string
 	 */
 	public createExcludedMountable(filePath: string): ExcludedMountable {
-		validate(
+		validateAPIArgs(
 			z.object({
 				filePath: V_FilePath,
 			}),
@@ -542,7 +542,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param fieldType
 	 */
 	public getInlineFieldDeclarationPrefix(fieldType: FieldType): string {
-		validate(
+		validateAPIArgs(
 			z.object({
 				fieldType: V_FieldType,
 			}),
@@ -573,7 +573,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param str the declaration string
 	 */
 	public isInlineFieldDeclaration(fieldType: FieldType, str: string): boolean {
-		validate(
+		validateAPIArgs(
 			z.object({
 				fieldType: V_FieldType,
 				str: z.string(),
@@ -596,7 +596,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param str the declaration string
 	 */
 	public isInlineFieldDeclarationAndGetType(str: string): InlineFieldType | undefined {
-		validate(
+		validateAPIArgs(
 			z.object({
 				str: z.string(),
 			}),
@@ -645,7 +645,7 @@ export abstract class API<Plugin extends IPlugin> {
 		property: string[],
 		listenToChildren: boolean = false,
 	): BindTargetDeclaration {
-		validate(
+		validateAPIArgs(
 			z.object({
 				storageType: z.string(),
 				storagePath: z.string(),
@@ -680,7 +680,7 @@ export abstract class API<Plugin extends IPlugin> {
 		filePath: string,
 		scope?: BindTargetScope,
 	): BindTargetDeclaration {
-		validate(
+		validateAPIArgs(
 			z.object({
 				declarationString: z.string(),
 				filePath: V_FilePath,
@@ -703,7 +703,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param value
 	 */
 	public setMetadata(bindTarget: BindTargetDeclaration, value: unknown): void {
-		validate(
+		validateAPIArgs(
 			z.object({
 				bindTarget: V_BindTargetDeclaration,
 			}),
@@ -722,7 +722,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param bindTarget
 	 */
 	public getMetadata(bindTarget: BindTargetDeclaration): unknown {
-		validate(
+		validateAPIArgs(
 			z.object({
 				bindTarget: V_BindTargetDeclaration,
 			}),
@@ -741,7 +741,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param updateFn a function that takes the current value and returns the new value
 	 */
 	public updateMetadata(bindTarget: BindTargetDeclaration, updateFn: (value: unknown) => unknown): void {
-		validate(
+		validateAPIArgs(
 			z.object({
 				bindTarget: V_BindTargetDeclaration,
 				updateFn: z.function().args(z.any()).returns(z.any()),
@@ -771,7 +771,7 @@ export abstract class API<Plugin extends IPlugin> {
 		lifecycleHook: LifecycleHook,
 		callback: (value: unknown) => void,
 	): void {
-		validate(
+		validateAPIArgs(
 			z.object({
 				bindTarget: V_BindTargetDeclaration,
 				lifecycleHook: this.plugin.internal.getLifecycleHookValidator(),
@@ -807,7 +807,7 @@ export abstract class API<Plugin extends IPlugin> {
 	 * @param lineEnd
 	 */
 	public createNotePosition(lineStart: number, lineEnd: number): NotePosition {
-		validate(
+		validateAPIArgs(
 			z.object({
 				lineStart: z.number(),
 				lineEnd: z.number(),

packages/core/src/api/SyntaxHighlightingAPI.ts

@@ -11,7 +11,7 @@ import {
 import { type Highlight } from 'packages/core/src/parsers/syntaxHighlighting/Highlight';
 import { SyntaxHighlighting } from 'packages/core/src/parsers/syntaxHighlighting/SyntaxHighlighting';
 
-import { FieldType } from 'packages/core/src/config/APIConfigs';
+import { FieldType, type InlineFieldType } from 'packages/core/src/config/APIConfigs';
 
 export class SyntaxHighlightingAPI {
 	public readonly plugin: IPlugin;
@@ -32,16 +32,16 @@ export class SyntaxHighlightingAPI {
 		return this.highlightWithParser(str, trimWhiteSpace, HLP_ButtonGroupDeclaration);
 	}
 
-	highlight(str: string, mdrcType: FieldType, trimWhiteSpace: boolean): SyntaxHighlighting {
-		if (mdrcType === FieldType.INPUT) {
+	highlight(str: string, inlineFieldType: InlineFieldType, trimWhiteSpace: boolean): SyntaxHighlighting {
+		if (inlineFieldType === FieldType.INPUT) {
 			return this.highlightInputFieldDeclaration(str, trimWhiteSpace);
-		} else if (mdrcType === FieldType.VIEW) {
+		} else if (inlineFieldType === FieldType.VIEW) {
 			return this.highlightViewFieldDeclaration(str, trimWhiteSpace);
-		} else if (mdrcType === FieldType.BUTTON_GROUP) {
+		} else if (inlineFieldType === FieldType.BUTTON_GROUP) {
 			return this.highlightInlineButtonDeclaration(str, trimWhiteSpace);
 		}
 
-		throw new Error(`Unknown MDRCType ${mdrcType}`);
+		throw new Error(`Unknown MDRCType ${inlineFieldType}`);
 	}
 
 	highlightBindTarget(str: string, trimWhiteSpace: boolean): SyntaxHighlighting {

packages/core/src/config/ButtonConfigValidators.ts

@@ -20,43 +20,65 @@ import {
 import { oneOf, schemaForType } from 'packages/core/src/utils/ZodUtils';
 import { z } from 'zod';
 
+function numberValidator(action: string, name: string, description: string) {
+	return z.number({
+		required_error: `The ${action} action requires a specified ${description} with the '${name}' field.`,
+		invalid_type_error: `The ${action} action requires the value of the '${name}' fields to be a number.`,
+	});
+}
+
+function stringValidator(action: string, name: string, description: string) {
+	return z.string({
+		required_error: `The ${action} action requires a specified ${description} with the '${name}' field.`,
+		invalid_type_error: `The ${action} action requires the value of the '${name}' fields to be a string.`,
+	});
+}
+
+function booleanValidator(action: string, name: string, description: string) {
+	return z.boolean({
+		required_error: `The ${action} action requires a specified ${description} with the '${name}' field.`,
+		invalid_type_error: `The ${action} action requires the value of the '${name}' fields to be a boolean.`,
+	});
+}
+
 export const V_CommandButtonAction = schemaForType<CommandButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.COMMAND),
-		command: z.string(),
+		command: stringValidator('command', 'command', 'command to run'),
 	}),
 );
 
 export const V_JSButtonAction = schemaForType<JSButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.JS),
-		file: z.string(),
+		file: stringValidator('js', 'file', 'file path to the file to run'),
 		args: z.record(z.unknown()).optional(),
 	}),
 );
 
 export const V_OpenButtonAction = schemaForType<OpenButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.OPEN),
-		link: z.string(),
-		newTab: z.boolean().optional(),
+		link: stringValidator('open', 'link', 'link to open'),
+		newTab: booleanValidator('open', 'newTab', '').optional(),
 	}),
 );
 
 export const V_InputButtonAction = schemaForType<InputButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.INPUT),
-		str: z.string(),
+		str: stringValidator('input', 'str', 'value to input'),
 	}),
 );
 
 export const V_SleepButtonAction = schemaForType<SleepButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.SLEEP),
-		ms: z.number(),
+		ms: numberValidator('sleep', 'ms', 'duration'),
 	}),
 );
 
+// TODO: more better error messages
 export const V_TemplaterCreateNoteButtonAction = schemaForType<TemplaterCreateNoteButtonAction>()(
 	z.object({
 		type: z.literal(ButtonActionType.TEMPLATER_CREATE_NOTE),
@@ -127,7 +149,7 @@ export const V_InlineJsButtonAction = schemaForType<InlineJsButtonAction>()(
 );
 
 export const V_ButtonAction = schemaForType<ButtonAction>()(
-	z.union([
+	z.discriminatedUnion('type', [
 		V_CommandButtonAction,
 		V_JSButtonAction,
 		V_OpenButtonAction,

packages/core/src/fields/button/ButtonActionRunner.ts

@@ -38,8 +38,8 @@ export class ButtonActionRunner {
 		if (resolvedFilePath === undefined) {
 			throw new MetaBindParsingError({
 				errorLevel: ErrorLevel.ERROR,
-				cause: 'file not found',
-				effect: `could not resolve path or link "${filePath}" relative to "${relativeFilePath}"`,
+				cause: 'Could not find a file that matches "${filePath}".',
+				effect: `Could not resolve path or link "${filePath}" relative to "${relativeFilePath}".`,
 			});
 		}
 

packages/core/src/parsers/ButtonParser.ts

@@ -8,6 +8,7 @@ import { V_ButtonConfig } from 'packages/core/src/config/ButtonConfigValidators'
 import { ErrorLevel, MetaBindButtonError } from 'packages/core/src/utils/errors/MetaBindErrors';
 import { DocsUtils } from 'packages/core/src/utils/DocsUtils';
 import { fromZodError } from 'zod-validation-error';
+import { validate } from 'packages/core/src/utils/ZodUtils';
 
 const P_ButtonGroupDeclaration = P.sequenceMap(
 	(_, b) => b,
@@ -81,19 +82,20 @@ export class ButtonParser {
 	}
 
 	public validateConfig(config: unknown): ButtonConfig {
-		const parsedConfig = V_ButtonConfig.safeParse(config);
+		const parsedConfig = validate(V_ButtonConfig, config);
 
 		if (!parsedConfig.success) {
 			const niceError = fromZodError(parsedConfig.error, {
 				unionSeparator: '\nOR ',
 				issueSeparator: ' AND ',
 				prefix: null,
+				includePath: false,
 			});
 
 			throw new MetaBindButtonError({
 				errorLevel: ErrorLevel.ERROR,
-				effect: 'can not parse button config',
-				cause: 'zod validation failed. Check your button syntax',
+				effect: 'The validation for the button config failed.',
+				cause: 'Your button syntax seems to be invalid. Check that your button config follows what is described in the docs.',
 				positionContext: niceError.message,
 				docs: [DocsUtils.linkToButtonConfig()],
 			});

packages/core/src/parsers/ParsingError.ts

@@ -19,7 +19,7 @@ export class ParsingError extends MetaBindError {
 	constructor(errorLevel: ErrorLevel, source: string, str: string, parseFailure: ParseFailure) {
 		super({
 			errorLevel: errorLevel,
-			effect: 'failed to parse',
+			effect: 'Failed to parse. Check that your syntax is correct.',
 			cause: `expected ${parseFailure.expected.sort().join(' or ')}`,
 		});
 
@@ -72,7 +72,12 @@ export class ParsingValidationError extends MetaBindError {
 		position?: ParsingRange,
 		docs?: string[],
 	) {
-		super({ errorLevel: errorLevel, effect: 'failed to validate parser result', cause: cause, docs: docs });
+		super({
+			errorLevel: errorLevel,
+			effect: 'Failed to validate the result of the parser.',
+			cause: cause,
+			docs: docs,
+		});
 
 		this.str = str;
 		this.position = position;