even better error messages part 2

mProjectsCode · mProjectsCode · commit c2236820b4c3 · 2023-11-08T00:31:57.000+01:00
diff --git a/exampleVault/Input Fields/List.md b/exampleVault/Input Fields/List.md
@@ -24,4 +24,9 @@ INPUT[listSuggester(optionQuery(#example-note), option(something, other), showca
 
 ```meta-bind
 INPUT[listSuggester(optionQuery(#example-note), option(something, other), useLinks(false), showcase):list3]
+```
+
+
+```meta-bind
+INPUT[listsuggester(optionQuery(#example-note), option(something, other), useLinks(false), showcase):list3]
 ```
diff --git a/src/fieldArguments/AbstractFieldArgument.ts b/src/fieldArguments/AbstractFieldArgument.ts
@@ -1,6 +1,7 @@
 import { type ParsingResultNode } from '../parsers/nomParsers/GeneralParsers';
 import { ErrorLevel, MetaBindArgumentError } from '../utils/errors/MetaBindErrors';
 import { type FieldArgumentConfig, type FieldArgumentValueConfig } from '../parsers/GeneralConfigs';
+import { DocsHelper } from '../utils/DocsHelper';
 
 export abstract class AbstractFieldArgument<
 	FieldType extends string,
@@ -26,7 +27,7 @@ export abstract class AbstractFieldArgument<
 				cause: `Expected argument values to follow the form ${allowedValues
 					.map(x => (x.length === 0 ? 'none' : x.map(y => `'${y.name}'`).join(', ')))
 					.join(' or ')}. Received arguments of length ${value.length}.`,
-				// TODO: link to docs of the argument somehow
+				docs: [DocsHelper.linkToSearch(this.getConfig().type)],
 			});
 		}
 	}
diff --git a/src/fieldArguments/AbstractFieldArgumentContainer.ts b/src/fieldArguments/AbstractFieldArgumentContainer.ts
@@ -1,6 +1,7 @@
 import { ErrorLevel, MetaBindArgumentError } from '../utils/errors/MetaBindErrors';
 import { type FieldArgumentConfig, InputFieldArgumentType } from '../parsers/GeneralConfigs';
 import { type AbstractFieldArgument } from './AbstractFieldArgument';
+import { DocsHelper } from '../utils/DocsHelper';
 
 export abstract class AbstractFieldArgumentContainer<
 	FieldType extends string,
@@ -28,7 +29,7 @@ export abstract class AbstractFieldArgumentContainer<
 					errorLevel: ErrorLevel.ERROR,
 					effect: 'failed to validate argument container',
 					cause: `argument '${argumentConfig.type}' does not allow duplicates`,
-					// TODO: link to docs
+					docs: [DocsHelper.linkToSearch(argumentConfig.type)],
 				});
 			}
 		}
diff --git a/src/inputFields/fields/DatePicker/DatePickerComponent.svelte b/src/inputFields/fields/DatePicker/DatePickerComponent.svelte
@@ -23,9 +23,7 @@
 </script>
 
 <div class="date-picker-input" on:click={datePicker} on:keydown={datePickerKey} role="button" tabindex="0">
-	<div class="date-picker-text">
-		<span>{value ? value.format(dateFormat) : 'none'}</span>
-	</div>
+	<span class="date-picker-text">{value ? value.format(dateFormat) : 'none'}</span>
 	<Icon iconName="calendar" />
 </div>
 
@@ -41,6 +39,7 @@
 		display: inline-flex;
 		align-items: center;
 		gap: 5px;
+		font-size: var(--font-ui-small);
 	}
 
 	.date-picker-text {
diff --git a/src/parsers/BindTargetParser.ts b/src/parsers/BindTargetParser.ts
@@ -1,7 +1,7 @@
 import { ErrorLevel } from '../utils/errors/MetaBindErrors';
 import { type IPlugin } from '../IPlugin';
 import { BIND_TARGET } from './nomParsers/BindTargetParsers';
-import { ParsingValidationError } from './ParsingError';
+import { ParsingValidationError, runParser } from './ParsingError';
 import { type BindTargetDeclaration, type FullBindTarget, type UnvalidatedBindTargetDeclaration } from './inputFieldParser/InputFieldDeclaration';
 import { type BindTargetScope } from '../metadata/BindTargetScope';
 
@@ -17,7 +17,7 @@ export class BindTargetParser {
 	}
 
 	parseBindTarget(bindTargetString: string): UnvalidatedBindTargetDeclaration {
-		return BIND_TARGET.parse(bindTargetString);
+		return runParser(BIND_TARGET, bindTargetString);
 	}
 
 	validateBindTarget(
diff --git a/src/parsers/MarkdownLinkParser.ts b/src/parsers/MarkdownLinkParser.ts
@@ -8,6 +8,7 @@ export interface MarkdownLink {
 	alias: string;
 }
 
+// TODO: rebuild this with parsinom
 export function parseMdLink(link: string): MarkdownLink {
 	if (!link) {
 		throw new MetaBindParsingError({ errorLevel: ErrorLevel.ERROR, effect: 'failed to parse md link', cause: 'invalid link, link is empty' });
diff --git a/src/parsers/ParsingError.ts b/src/parsers/ParsingError.ts
@@ -1,13 +1,27 @@
-import { type ErrorLevel, ErrorType, MetaBindError } from '../utils/errors/MetaBindErrors';
+import { ErrorLevel, ErrorType, MetaBindError } from '../utils/errors/MetaBindErrors';
 import { type ParseFailure, type ParsingRange } from '@lemons_dev/parsinom/lib/HelperTypes';
+import { type Parser } from '@lemons_dev/parsinom/lib/Parser';
+
+export function runParser<T>(parser: Parser<T>, str: string): T {
+	const result = parser.tryParse(str);
+	if (result.success) {
+		return result.value;
+	} else {
+		throw new ParsingError(ErrorLevel.ERROR, 'parsiNOM parser', str, result);
+	}
+}
 
 export class ParsingError extends MetaBindError {
 	str: string;
 	parseFailure: ParseFailure;
 	source: string;
 
 	constructor(errorLevel: ErrorLevel, source: string, str: string, parseFailure: ParseFailure) {
-		super({ errorLevel: errorLevel, effect: 'failed to parse', cause: 'expected' + parseFailure.expected.join(' or '), context: {} });
+		super({
+			errorLevel: errorLevel,
+			effect: 'failed to parse',
+			cause: `expected ${parseFailure.expected.sort().join(' or ')}`,
+		});
 
 		this.str = str;
 		this.parseFailure = parseFailure;
@@ -17,7 +31,7 @@ export class ParsingError extends MetaBindError {
 	}
 
 	public getErrorType(): ErrorType {
-		return ErrorType.PARSING;
+		return ErrorType.PARSINOM;
 	}
 
 	protected updateMessage2(): void {
@@ -31,8 +45,17 @@ export class ParsingError extends MetaBindError {
 		const failedLine = lines[this.parseFailure.furthest.line - 1]; // line is a one based index
 
 		const linePrefix = `${this.parseFailure.furthest.line} |   `;
-		this.message += `\n${linePrefix}${failedLine}`;
-		this.message += `\n${' '.repeat(this.parseFailure.furthest.column - 1 + linePrefix.length)}^ (${this.cause})\n`;
+		this.positionContext = `${linePrefix}${failedLine}`;
+		this.positionContext += `\n${this.getUnderline(linePrefix.length)}\n`;
+
+		this.message += '\n' + this.positionContext;
+	}
+
+	private getUnderline(offset: number): string {
+		const spacing = ' '.repeat(this.parseFailure.furthest.column + offset - 1);
+		const underline = `^ (${this.cause})`;
+
+		return spacing + underline;
 	}
 }
 
@@ -41,8 +64,8 @@ export class ParsingValidationError extends MetaBindError {
 	position?: ParsingRange;
 	source: string;
 
-	constructor(errorLevel: ErrorLevel, source: string, cause: string, str?: string, position?: ParsingRange) {
-		super({ errorLevel: errorLevel, effect: 'failed to validate parser result', cause: cause });
+	constructor(errorLevel: ErrorLevel, source: string, cause: string, str?: string, position?: ParsingRange, docs?: string[]) {
+		super({ errorLevel: errorLevel, effect: 'failed to validate parser result', cause: cause, docs: docs });
 
 		this.str = str;
 		this.position = position;
diff --git a/src/parsers/inputFieldParser/InputFieldParser.ts b/src/parsers/inputFieldParser/InputFieldParser.ts
@@ -6,7 +6,7 @@ import { deepFreeze } from '../../utils/Utils';
 import { InputFieldDeclarationValidator } from './InputFieldDeclarationValidator';
 import { type ITemplateSupplier, type TemplateSupplierTemplate } from './ITemplateSupplier';
 import { INPUT_FIELD_FULL_DECLARATION, TEMPLATE_INPUT_FIELD_FULL_DECLARATION } from '../nomParsers/InputFieldParsers';
-import { ParsingValidationError } from '../ParsingError';
+import { ParsingValidationError, runParser } from '../ParsingError';
 import { ErrorLevel } from '../../utils/errors/MetaBindErrors';
 import { type InputFieldDeclaration, type UnvalidatedInputFieldDeclaration } from './InputFieldDeclaration';
 import { type BindTargetScope } from '../../metadata/BindTargetScope';
@@ -27,7 +27,7 @@ export class InputFieldDeclarationParser implements ITemplateSupplier<Unvalidate
 		const errorCollection = new ErrorCollection('InputFieldParser');
 
 		try {
-			let parserResult = INPUT_FIELD_FULL_DECLARATION.parse(fullDeclaration) as UnvalidatedInputFieldDeclaration;
+			let parserResult = runParser(INPUT_FIELD_FULL_DECLARATION, fullDeclaration) as UnvalidatedInputFieldDeclaration;
 			parserResult.fullDeclaration = fullDeclaration;
 			parserResult.errorCollection = errorCollection;
 
@@ -54,7 +54,7 @@ export class InputFieldDeclarationParser implements ITemplateSupplier<Unvalidate
 		const errorCollection = new ErrorCollection('InputFieldParser');
 
 		try {
-			const parserResult = INPUT_FIELD_FULL_DECLARATION.parse(fullDeclaration) as UnvalidatedInputFieldDeclaration;
+			const parserResult = runParser(INPUT_FIELD_FULL_DECLARATION, fullDeclaration) as UnvalidatedInputFieldDeclaration;
 			parserResult.fullDeclaration = fullDeclaration;
 			parserResult.errorCollection = errorCollection;
 
@@ -82,7 +82,7 @@ export class InputFieldDeclarationParser implements ITemplateSupplier<Unvalidate
 		const errorCollection = new ErrorCollection('InputFieldParser');
 
 		try {
-			const parserResult = TEMPLATE_INPUT_FIELD_FULL_DECLARATION.parse(template) as UnvalidatedInputFieldDeclaration;
+			const parserResult = runParser(TEMPLATE_INPUT_FIELD_FULL_DECLARATION, template) as UnvalidatedInputFieldDeclaration;
 			parserResult.fullDeclaration = template;
 			parserResult.errorCollection = errorCollection;
 
@@ -139,6 +139,7 @@ export class InputFieldDeclarationParser implements ITemplateSupplier<Unvalidate
 					`Invalid template name. Could not find template with name '${declaration.templateName.value}'`,
 					declaration.fullDeclaration,
 					declaration.templateName.position,
+					['https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/guides/templates/'],
 				),
 			);
 
diff --git a/src/parsers/viewFieldParser/ViewFieldDeclarationParser.ts b/src/parsers/viewFieldParser/ViewFieldDeclarationParser.ts
@@ -6,6 +6,7 @@ import { type JsViewFieldDeclaration, type UnvalidatedViewFieldDeclaration, type
 import { ViewFieldDeclarationValidator } from './ViewFieldDeclarationValidator';
 import { ViewFieldArgumentContainer } from '../../fieldArguments/viewFieldArguments/ViewFieldArgumentContainer';
 import { ViewFieldType } from '../GeneralConfigs';
+import { runParser } from '../ParsingError';
 
 export class ViewFieldDeclarationParser {
 	plugin: IPlugin;
@@ -18,7 +19,7 @@ export class ViewFieldDeclarationParser {
 		const errorCollection = new ErrorCollection('ViewFieldDeclaration');
 
 		try {
-			const parserResult = VIEW_FIELD_FULL_DECLARATION.parse(fullDeclaration) as UnvalidatedViewFieldDeclaration;
+			const parserResult = runParser(VIEW_FIELD_FULL_DECLARATION, fullDeclaration) as UnvalidatedViewFieldDeclaration;
 			parserResult.fullDeclaration = fullDeclaration;
 			parserResult.errorCollection = errorCollection;
 
@@ -41,7 +42,7 @@ export class ViewFieldDeclarationParser {
 		const errorCollection = new ErrorCollection('ViewFieldDeclaration');
 
 		try {
-			const parserResult = VIEW_FIELD_FULL_DECLARATION.parse(fullDeclaration) as UnvalidatedViewFieldDeclaration;
+			const parserResult = runParser(VIEW_FIELD_FULL_DECLARATION, fullDeclaration) as UnvalidatedViewFieldDeclaration;
 			parserResult.fullDeclaration = fullDeclaration;
 			parserResult.errorCollection = errorCollection;
 
@@ -73,7 +74,7 @@ export class ViewFieldDeclarationParser {
 		declaration.fullDeclaration = fullDeclaration;
 
 		try {
-			const unvalidatedDeclaration = JS_VIEW_FIELD_DECLARATION.parse(fullDeclaration);
+			const unvalidatedDeclaration = runParser(JS_VIEW_FIELD_DECLARATION, fullDeclaration);
 			declaration.bindTargetMappings = unvalidatedDeclaration.bindTargetMappings.map(x => {
 				return {
 					bindTarget: this.plugin.api.bindTargetParser.validateBindTarget(fullDeclaration, x.bindTarget),
diff --git a/src/renderChildren/InputFieldMDRC.ts b/src/renderChildren/InputFieldMDRC.ts
@@ -212,6 +212,13 @@ export class InputFieldMDRC extends AbstractMDRC {
 			container.addClasses(classArguments.map(x => x.value).flat());
 		}
 
+		// --- Apply Block or Inline Class ---
+		if (this.renderChildType === RenderChildType.BLOCK) {
+			this.containerEl.addClass('mb-input-block');
+		} else {
+			this.containerEl.addClass('mb-input-inline');
+		}
+
 		// --- Append Container Element to Wrapper ---
 		wrapperContainer.appendChild(container);
 
diff --git a/src/utils/DocsHelper.ts b/src/utils/DocsHelper.ts
@@ -16,4 +16,8 @@ export class DocsHelper {
 	static linkToViewFieldArgument(type: ViewFieldArgumentType): string {
 		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/reference/viewfieldarguments/${type.toLowerCase()}/`;
 	}
+
+	static linkToSearch(search: string): string {
+		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/?s=${encodeURIComponent(search)}`;
+	}
 }
diff --git a/src/utils/ParserUtils.ts b/src/utils/ParserUtils.ts
@@ -1,6 +1,9 @@
 import { equalOrIncludes, isFalsy } from './Utils';
 import { ErrorLevel, MetaBindInternalError } from './errors/MetaBindErrors';
 
+/**
+ * @deprecated
+ */
 export class EnclosingPair {
 	readonly openingEqualsClosing: boolean;
 	private readonly _openingString: string;
@@ -56,8 +59,13 @@ export class EnclosingPair {
 	}
 }
 
+/**
+ * @deprecated
+ */
 export class ParserUtils {
-	// TODO: rename stuff
+	/**
+	 * @deprecated
+	 */
 	static split(str: string, separator: string, ignore?: EnclosingPair): string[] {
 		if (!str) {
 			throw new MetaBindInternalError({ errorLevel: ErrorLevel.ERROR, effect: 'failed to split string', cause: 'string must not be empty' });
@@ -175,6 +183,9 @@ export class ParserUtils {
 		return subStrings;
 	}
 
+	/**
+	 * @deprecated
+	 */
 	static removeInBetween(str: string, enclosingPair: EnclosingPair): string {
 		if (!str) {
 			throw new MetaBindInternalError({ errorLevel: ErrorLevel.ERROR, effect: 'failed remove in between in string', cause: 'string must not be empty' });
@@ -251,6 +262,9 @@ export class ParserUtils {
 		return subStr;
 	}
 
+	/**
+	 * @deprecated
+	 */
 	static getInBetween(str: string, enclosingPair: EnclosingPair): string | string[] {
 		if (!str) {
 			throw new MetaBindInternalError({ errorLevel: ErrorLevel.ERROR, effect: 'failed to get in between in string', cause: 'string must not be empty' });
@@ -366,6 +380,9 @@ export class ParserUtils {
 		}
 	}
 
+	/**
+	 * @deprecated
+	 */
 	static isStringAt(str: string, subStr: string, index: number): boolean {
 		if (index < 0) {
 			throw new MetaBindInternalError({
@@ -405,10 +422,16 @@ export class ParserUtils {
 		return true;
 	}
 
+	/**
+	 * @deprecated
+	 */
 	static contains(str: string, subStr: string): boolean {
 		return ParserUtils.numberOfOccurrences(str, subStr) > 0;
 	}
 
+	/**
+	 * @deprecated
+	 */
 	static numberOfOccurrences(str: string, subStr: string): number {
 		if (!str) {
 			throw new MetaBindInternalError({ errorLevel: ErrorLevel.ERROR, effect: 'failed count number of occurrences', cause: 'string must not be empty' });
diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
@@ -309,6 +309,5 @@ export function deepCopy<T extends object>(object: T): T {
 }
 
 export function getUUID(): string {
-	// TODO: figure out a way that works everywhere and in jest
 	return window.crypto.randomUUID();
 }
diff --git a/src/utils/errors/MetaBindErrors.ts b/src/utils/errors/MetaBindErrors.ts
@@ -14,6 +14,7 @@ export enum ErrorType {
 	EXPRESSION = 'MB_EXPRESSION',
 	PUBLISH = 'MB_PUBLISH',
 	VALIDATION = 'MB_VALIDATION',
+	PARSINOM = 'MB_PARSINOM',
 
 	OTHER = 'OTHER',
 }
diff --git a/styles.css b/styles.css
@@ -7,9 +7,11 @@ body {
 }
 
 /* Input Wrappers */
-.mb-input {
-	background-color: transparent !important;
-	border: none !important;
+:root .mb-input {
+	all: revert;
+	/*padding-block: 0;*/
+	/*display: inline-flex;*/
+	/*vertical-align: middle;*/
 }
 
 .mb-input-wrapper {
@@ -56,6 +58,7 @@ div.mb-view-wrapper {
 
 .mb-slider-input-label {
 	color: var(--text-muted);
+	font-size: var(--font-ui-small);
 }
 
 /* Text Input */
@@ -118,6 +121,17 @@ div.mb-view-wrapper {
 	border-radius: 0 var(--mb-border-radius) var(--mb-border-radius) 0;
 }
 
+/* SailKite small input fields so that line height is consistent */
+/* https://discord.com/channels/1171444840257572935/1171444840257572939/1171562547212726403 */
+/*.mb-input-element-group {*/
+/*	& > .mb-date-input-year-input[type='number'] {*/
+/*		padding-block: 0;*/
+/*	}*/
+/*	& > .mb-input-element-group-element {*/
+/*		height: 100%;*/
+/*	}*/
+/*}*/
+
 /* List Input */
 .mb-list-input {
 	display: flex;

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import { ErrorLevel } from '../utils/errors/MetaBindErrors';`
`2`	`2`	`import { type IPlugin } from '../IPlugin';`
`3`	`3`	`import { BIND_TARGET } from './nomParsers/BindTargetParsers';`
`4`		`-import { ParsingValidationError } from './ParsingError';`
	`4`	`+import { ParsingValidationError, runParser } from './ParsingError';`
`5`	`5`	`import { type BindTargetDeclaration, type FullBindTarget, type UnvalidatedBindTargetDeclaration } from './inputFieldParser/InputFieldDeclaration';`
`6`	`6`	`import { type BindTargetScope } from '../metadata/BindTargetScope';`
`7`	`7`
`@@ -17,7 +17,7 @@ export class BindTargetParser {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`parseBindTarget(bindTargetString: string): UnvalidatedBindTargetDeclaration {`
`20`		`- return BIND_TARGET.parse(bindTargetString);`
	`20`	`+ return runParser(BIND_TARGET, bindTargetString);`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`validateBindTarget(`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ export interface MarkdownLink {`
`8`	`8`	`alias: string;`
`9`	`9`	`}`
`10`	`10`
	`11`	`+// TODO: rebuild this with parsinom`
`11`	`12`	`export function parseMdLink(link: string): MarkdownLink {`
`12`	`13`	`if (!link) {`
`13`	`14`	`throw new MetaBindParsingError({ errorLevel: ErrorLevel.ERROR, effect: 'failed to parse md link', cause: 'invalid link, link is empty' });`