II of the MarkersProvider class

Author: legomushroom

src/vs/workbench/contrib/chat/browser/promptSyntax/contributions/createPromptCommand/utils/createPromptFile.ts

@@ -9,8 +9,8 @@ import { assert } from '../../../../../../../../base/common/assert.js';
 import { VSBuffer } from '../../../../../../../../base/common/buffer.js';
 import { dirname } from '../../../../../../../../base/common/resources.js';
 import { IFileService } from '../../../../../../../../platform/files/common/files.js';
-import { isPromptFile, PROMPT_FILE_EXTENSION } from '../../../../../../../../platform/prompts/common/constants.js';
 import { ICommandService } from '../../../../../../../../platform/commands/common/commands.js';
+import { isPromptFile, PROMPT_FILE_EXTENSION } from '../../../../../../../../platform/prompts/common/constants.js';
 
 /**
  * Options for the {@link createPromptFile} utility.

src/vs/workbench/contrib/chat/browser/promptSyntax/languageFeatures/markersProvider.ts

@@ -0,0 +1,144 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { assert } from '../../../../../../base/common/assert.js';
+import { ITextModel } from '../../../../../../editor/common/model.js';
+import { assertDefined } from '../../../../../../base/common/types.js';
+import { Disposable } from '../../../../../../base/common/lifecycle.js';
+import { IPromptsService } from '../../../common/promptSyntax/service/types.js';
+import { IPromptFileReference } from '../../../common/promptSyntax/parsers/types.js';
+import { TextModelPromptParser } from '../../../common/promptSyntax/parsers/textModelPromptParser.js';
+import { IMarkerData, IMarkerService, MarkerSeverity } from '../../../../../../platform/markers/common/markers.js';
+import { FailedToResolveContentsStream, NotPromptFile, ParseError, RecursiveReference } from '../../../common/promptFileReferenceErrors.js';
+
+/**
+ * TODO: @legomushroom
+ */
+const MARKERS_OWNER_ID = 'reusable-prompts-syntax';
+
+/**
+ * TODO: @legomushroom
+ */
+// TODO: @lego - move under /common
+export class MarkersProvider extends Disposable {
+	/**
+	 * TODO: @legomushroom
+	 */
+	private readonly parser: TextModelPromptParser;
+
+	constructor(
+		private readonly editor: ITextModel,
+		@IMarkerService private readonly markerService: IMarkerService,
+		@IPromptsService private readonly promptsService: IPromptsService,
+	) {
+		super();
+
+		this.parser = this.promptsService
+			.getSyntaxParserFor(this.editor)
+			.onUpdate(this.updateMarkers.bind(this))
+			.onDispose(this.dispose.bind(this));
+
+		// TODO @legomushroom - uncomment?
+		// this.updateMarkers();
+	}
+
+	/**
+	 * TODO: @legomushroom
+	 */
+	private async updateMarkers() {
+		// ensure that parsing process is settled
+		await this.parser.allSettled();
+
+		// clean up all previously added markers
+		this.markerService.remove(MARKERS_OWNER_ID, [this.editor.uri]);
+
+		const markers: IMarkerData[] = [];
+		for (const link of this.parser.allReferences) {
+			const { errorCondition, linkRange } = link;
+
+			if (!errorCondition || !linkRange) {
+				continue;
+			}
+
+			// the `NotPromptFile` error is allowed because we allow users
+			// to include non-prompt file links in the prompt files
+			// note! this check also handles the `FolderReference` error
+			if (errorCondition instanceof NotPromptFile) {
+				continue;
+			}
+
+			markers.push(toMarker(link));
+		}
+
+		this.markerService.changeOne(
+			MARKERS_OWNER_ID,
+			this.editor.uri,
+			markers,
+		);
+	}
+}
+
+/**
+ * TODO: @legomushroom
+ */
+// TODO: @legomushroom - add @throws info
+const toMarker = (
+	link: IPromptFileReference,
+): IMarkerData => {
+	const { errorCondition, linkRange } = link;
+
+	// a sanity check because this function must be
+	// used only if these attributes are present
+	assertDefined(
+		errorCondition,
+		'Error condition must to be defined.',
+	);
+	assertDefined(
+		linkRange,
+		'Link range must to be defined.',
+	);
+	assert(
+		!(errorCondition instanceof NotPromptFile),
+		'Error must not be of "not prompt file" type.',
+	);
+
+	// `FailedToResolveContentsStream` error check takes into account the `OpenFailed` error too
+	const severity = (errorCondition instanceof FailedToResolveContentsStream)
+		? MarkerSeverity.Error
+		: MarkerSeverity.Warning;
+
+	return {
+		message: getErrorMessage(errorCondition),
+		severity,
+		...linkRange,
+	};
+};
+
+/**
+ * TODO: @legomushroom
+ */
+// TODO: @legomushroom - add @throws info
+// TODO: @legomushroom - localize or reuse existing messages
+const getErrorMessage = (
+	error: ParseError,
+): string => {
+	// a sanity check because this function must be
+	// used only if error has correct type
+	assert(
+		!(error instanceof NotPromptFile),
+		'Error must not be of "not prompt file" type.',
+	);
+
+	// `FailedToResolveContentsStream` error takes into account the `OpenFailed` error too
+	if (error instanceof FailedToResolveContentsStream) {
+		return `The file '${error.uri.fsPath}' is not found.`;
+	}
+
+	if (error instanceof RecursiveReference) {
+		return 'The file contains recursive child reference that will be ignored.';
+	}
+
+	return `An unexpected error occurred: ${error.message}`;
+};

src/vs/workbench/contrib/chat/common/promptFileReferenceErrors.ts

@@ -41,36 +41,36 @@ export abstract class ParseError extends Error {
 }
 
 /**
- * A generic error for failing to resolve prompt contents stream.
+ * Base resolve error class used when file reference resolution fails.
  */
-export class FailedToResolveContentsStream extends ParseError {
-	public override errorType = 'FailedToResolveContentsStream';
+export abstract class ResolveError extends ParseError {
+	public abstract override errorType: string;
 
 	constructor(
 		public readonly uri: URI,
-		public readonly originalError: unknown,
-		message: string = `Failed to resolve prompt contents stream for '${uri.toString()}': ${originalError}.`,
+		message?: string,
+		options?: ErrorOptions,
 	) {
-		super(message);
+		super(message, options);
 	}
 }
 
-
 /**
- * Base resolve error class used when file reference resolution fails.
+ * A generic error for failing to resolve prompt contents stream.
  */
-export abstract class ResolveError extends ParseError {
-	public abstract override errorType: string;
+export class FailedToResolveContentsStream extends ResolveError {
+	public override errorType = 'FailedToResolveContentsStream';
 
 	constructor(
-		public readonly uri: URI,
-		message?: string,
-		options?: ErrorOptions,
+		uri: URI,
+		public readonly originalError: unknown,
+		message: string = `Failed to resolve prompt contents stream for '${uri.toString()}': ${originalError}.`,
 	) {
-		super(message, options);
+		super(uri, message);
 	}
 }
 
+
 /**
  * Error that reflects the case when attempt to open target file fails.
  */

src/vs/workbench/contrib/chat/common/promptSyntax/parsers/basePromptParser.ts

@@ -457,7 +457,6 @@ export abstract class BasePromptParser<T extends IPromptContentsProvider> extend
 			return undefined;
 		}
 
-
 		// if the first error is the error of the root reference,
 		// then return it as an `error` otherwise use `warning`
 		const [firstError, ...restErrors] = errors;

src/vs/workbench/contrib/chat/common/promptSyntax/utils/promptFilesLocator.ts

@@ -13,7 +13,7 @@ import { IWorkspaceContextService } from '../../../../../../platform/workspace/c
 import { IConfigurationService } from '../../../../../../platform/configuration/common/configuration.js';
 
 /**
- * Class to locate prompt files.
+ * Utility class to locate prompt files.
  */
 export class PromptFilesLocator {
 	constructor(