[prompt snippets]: move more codec files around

microsoft · Nov 22, 2024 · dc90f20 · dc90f20
1 parent 7ba7102
commit dc90f20
Show file tree

Hide file tree

Showing 14 changed files with 66 additions and 140 deletions.
diff --git a/src/vs/editor/common/codecs/baseToken.ts b/src/vs/editor/common/codecs/baseToken.ts
@@ -9,7 +9,7 @@ import { Range } from '../../../editor/common/core/range.js';
  * Base class for all tokens with a `range` that
  * reflects token position in the original data.
  */
-export class BaseToken {
+export abstract class BaseToken {
 	constructor(
 		public readonly range: Range,
 	) { }
@@ -20,4 +20,20 @@ export class BaseToken {
 	public sameRange(other: Range): boolean {
 		return this.range.equalsRange(other);
 	}
+
+	/**
+	 * Returns a string representation of the token.
+	 */
+	public abstract toString(): string;
+
+	/**
+	 * Check if this token is equal to another one.
+	 */
+	public equals<T extends BaseToken>(other: T): boolean {
+		if (!(other instanceof this.constructor)) {
+			return false;
+		}
+
+		return this.sameRange(other.range);
+	}
 }
diff --git a/src/vs/editor/common/codecs/linesCodec/tokens/line.ts b/src/vs/editor/common/codecs/linesCodec/tokens/line.ts
@@ -42,8 +42,12 @@ export class Line extends BaseToken {
 	/**
 	 * Check if this token is equal to another one.
 	 */
-	public equals(other: Line): boolean {
-		if (!super.sameRange(other.range)) {
+	public override equals<T extends BaseToken>(other: T): boolean {
+		if (!super.equals(other)) {
+			return false;
+		}
+
+		if (!(other instanceof Line)) {
 			return false;
 		}
 

diff --git a/src/vs/editor/common/codecs/linesCodec/tokens/newLine.ts b/src/vs/editor/common/codecs/linesCodec/tokens/newLine.ts
@@ -42,13 +42,6 @@ export class NewLine extends BaseToken {
 		);
 	}
 
-	/**
-	 * Check if this token is equal to another one.
-	 */
-	public equals(other: NewLine): boolean {
-		return super.sameRange(other.range);
-	}
-
 	/**
 	 * Returns a string representation of the token.
 	 */

diff --git a/src/vs/editor/common/codecs/simpleCodec/tokens/space.ts b/src/vs/editor/common/codecs/simpleCodec/tokens/space.ts
@@ -37,13 +37,6 @@ export class Space extends BaseToken {
 		));
 	}
 
-	/**
-	 * Check if this token is equal to another one.
-	 */
-	public equals(other: Space): boolean {
-		return super.sameRange(other.range);
-	}
-
 	/**
 	 * Returns a string representation of the token.
 	 */

diff --git a/src/vs/editor/common/codecs/simpleCodec/tokens/tab.ts b/src/vs/editor/common/codecs/simpleCodec/tokens/tab.ts
@@ -38,13 +38,6 @@ export class Tab extends BaseToken {
 		));
 	}
 
-	/**
-	 * Check if this token is equal to another one.
-	 */
-	public equals(other: Tab): boolean {
-		return super.sameRange(other.range);
-	}
-
 	/**
 	 * Returns a string representation of the token.
 	 */

diff --git a/src/vs/editor/common/codecs/simpleCodec/tokens/word.ts b/src/vs/editor/common/codecs/simpleCodec/tokens/word.ts
@@ -51,8 +51,12 @@ export class Word extends BaseToken {
 	/**
 	 * Check if this token is equal to another one.
 	 */
-	public equals(other: Word): boolean {
-		if (!super.sameRange(other.range)) {
+	public override equals<T extends BaseToken>(other: T): boolean {
+		if (!super.equals(other)) {
+			return false;
+		}
+
+		if (!(other instanceof Word)) {
 			return false;
 		}
 

diff --git a/src/vs/editor/test/common/utils/testDecoder.ts b/src/vs/editor/test/common/utils/testDecoder.ts
@@ -10,9 +10,6 @@ import { BaseToken } from '../../../common/codecs/baseToken.js';
 import { Disposable } from '../../../../base/common/lifecycle.js';
 import { WriteableStream } from '../../../../base/common/stream.js';
 import { BaseDecoder } from '../../../../base/common/codecs/baseDecoder.js';
-import { Line, NewLine } from '../../../common/codecs/linesCodec/tokens/index.js';
-import { Space, Tab, Word } from '../../../common/codecs/simpleCodec/tokens/index.js';
-import { FileReference } from '../../../common/codecs/chatbotPromptCodec/tokens/fileReference.js';
 
 /**
  * (pseudo)Random boolean generator.
@@ -99,91 +96,10 @@ export class TestDecoder<T extends BaseToken, D extends BaseDecoder<T>> extends
 			const expectedToken = expectedTokens[i];
 			const receivedtoken = receivedTokens[i];
 
-			if (expectedToken instanceof Line) {
-				assert(
-					receivedtoken instanceof Line,
-					`Token '${i}' must be a 'Line', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' to be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			if (expectedToken instanceof NewLine) {
-				assert(
-					receivedtoken instanceof NewLine,
-					`Token '${i}' must be a 'NewLine', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			if (expectedToken instanceof Space) {
-				assert(
-					receivedtoken instanceof Space,
-					`Token '${i}' must be a 'Space', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			if (expectedToken instanceof Word) {
-				assert(
-					receivedtoken instanceof Word,
-					`Token '${i}' must be a 'Word', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			if (expectedToken instanceof Tab) {
-				assert(
-					receivedtoken instanceof Tab,
-					`Token '${i}' must be a 'Tab ', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			if (expectedToken instanceof FileReference) {
-				assert(
-					receivedtoken instanceof FileReference,
-					`Token '${i}' must be a 'FileReference ', got '${receivedtoken}'.`,
-				);
-
-				assert(
-					receivedtoken.equals(expectedToken),
-					`Expected token '${i}' be '${expectedToken}', got '${receivedtoken}'.`,
-				);
-
-				continue;
-			}
-
-			throw new Error(`Unexpected token type for '${expectedToken}'.`);
+			assert(
+				receivedtoken.equals(expectedToken),
+				`Expected token '${i}' to be '${expectedToken}', got '${receivedtoken}'.`,
+			);
 		}
 
 		assert.strictEqual(

diff --git a/src/vs/workbench/contrib/chat/browser/chatInputPart.ts b/src/vs/workbench/contrib/chat/browser/chatInputPart.ts
@@ -150,9 +150,12 @@ export class ChatInputPart extends Disposable implements IHistoryNavigationWidge
 		chatWidget: IChatWidget,
 	): IChatRequestVariableEntry[] {
 		const contextArr = [...this.attachmentModel.attachments];
+
 		if (this._implicitContext?.enabled && this._implicitContext.value) {
 			const mainEntry = this._implicitContext.toBaseEntry();
 
+			contextArr.push(mainEntry);
+
 			// if the implicit context is a file, it can have nested
 			// file references that should be included in the context
 			if (this._implicitContext.validFileReferenceUris) {
@@ -168,7 +171,6 @@ export class ChatInputPart extends Disposable implements IHistoryNavigationWidge
 			}
 		}
 
-
 		// factor in nested references of dynamic variables into the implicit attached context
 		for (const part of chatWidget.parsedInput.parts) {
 			if (!(part instanceof ChatRequestDynamicVariablePart)) {

diff --git a/.../chatbotPromptCodec/chatbotPromptCodec.ts → .../chatbotPromptCodec/chatbotPromptCodec.ts b/.../chatbotPromptCodec/chatbotPromptCodec.ts → .../chatbotPromptCodec/chatbotPromptCodec.ts
@@ -3,10 +3,10 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { VSBuffer } from '../../../../base/common/buffer.js';
-import { Disposable } from '../../../../base/common/lifecycle.js';
-import { ReadableStream } from '../../../../base/common/stream.js';
-import { ICodec } from '../../../../base/common/codecs/types/ICodec.js';
+import { VSBuffer } from '../../../../../../base/common/buffer.js';
+import { Disposable } from '../../../../../../base/common/lifecycle.js';
+import { ReadableStream } from '../../../../../../base/common/stream.js';
+import { ICodec } from '../../../../../../base/common/codecs/types/ICodec.js';
 import { ChatbotPromptDecoder, TChatbotPromptToken } from './chatbotPromptDecoder.js';
 
 /**

diff --git a/...hatbotPromptCodec/chatbotPromptDecoder.ts → ...hatbotPromptCodec/chatbotPromptDecoder.ts b/...hatbotPromptCodec/chatbotPromptDecoder.ts → ...hatbotPromptCodec/chatbotPromptDecoder.ts
@@ -3,12 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { Word } from '../simpleCodec/tokens/index.js';
 import { FileReference } from './tokens/fileReference.js';
-import { VSBuffer } from '../../../../base/common/buffer.js';
-import { ReadableStream } from '../../../../base/common/stream.js';
-import { BaseDecoder } from '../../../../base/common/codecs/baseDecoder.js';
-import { SimpleDecoder, TSimpleToken } from '../simpleCodec/simpleDecoder.js';
+import { VSBuffer } from '../../../../../../base/common/buffer.js';
+import { ReadableStream } from '../../../../../../base/common/stream.js';
+import { BaseDecoder } from '../../../../../../base/common/codecs/baseDecoder.js';
+import { Word } from '../../../../../../editor/common/codecs/simpleCodec/tokens/index.js';
+import { SimpleDecoder, TSimpleToken } from '../../../../../../editor/common/codecs/simpleCodec/simpleDecoder.js';
 
 /**
  * Tokens handled by the `ChatbotPromptDecoder` decoder.

diff --git a/...hatbotPromptCodec/tokens/fileReference.ts → ...hatbotPromptCodec/tokens/fileReference.ts b/...hatbotPromptCodec/tokens/fileReference.ts → ...hatbotPromptCodec/tokens/fileReference.ts
@@ -3,10 +3,11 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { BaseToken } from '../../baseToken.js';
-import { Word } from '../../simpleCodec/tokens/index.js';
-import { assert } from '../../../../../base/common/assert.js';
-import { Range } from '../../../../../editor/common/core/range.js';
+import { assert } from '../../../../../../../base/common/assert.js';
+import { Range } from '../../../../../../../editor/common/core/range.js';
+import { BaseToken } from '../../../../../../../editor/common/codecs/baseToken.js';
+import { Word } from '../../../../../../../editor/common/codecs/simpleCodec/tokens/index.js';
+
 
 // Start sequence for a file reference token in a prompt.
 const TOKEN_START: string = '#file:';
@@ -77,11 +78,15 @@ export class FileReference extends BaseToken {
 	/**
 	 * Check if this token is equal to another one.
 	 */
-	public equals(other: FileReference): boolean {
+	public override equals<T extends BaseToken>(other: T): boolean {
 		if (!super.sameRange(other.range)) {
 			return false;
 		}
 
+		if (!(other instanceof FileReference)) {
+			return false;
+		}
+
 		return this.text === other.text;
 	}
 

diff --git a/src/vs/workbench/contrib/chat/common/promptFileReference.ts b/src/vs/workbench/contrib/chat/common/promptFileReference.ts
@@ -8,9 +8,9 @@ import { Emitter } from '../../../../base/common/event.js';
 import { extUri } from '../../../../base/common/resources.js';
 import { Disposable } from '../../../../base/common/lifecycle.js';
 import { Location } from '../../../../editor/common/languages.js';
+import { ChatbotPromptCodec } from './codecs/chatbotPromptCodec/chatbotPromptCodec.js';
 import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
 import { FileOpenFailed, NotPromptSnippetFile, RecursiveReference } from './promptFileReferenceErrors.js';
-import { ChatbotPromptCodec } from '../../../../editor/common/codecs/chatbotPromptCodec/chatbotPromptCodec.js';
 import { FileChangesEvent, FileChangeType, IFileService, IFileStreamContent } from '../../../../platform/files/common/files.js';
 
 /**

diff --git a/.../common/codecs/chatbotPromptCodec.test.ts → .../common/codecs/chatbotPromptCodec.test.ts b/.../common/codecs/chatbotPromptCodec.test.ts → .../common/codecs/chatbotPromptCodec.test.ts
@@ -3,13 +3,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { TestDecoder } from '../utils/testDecoder.js';
-import { Range } from '../../../common/core/range.js';
-import { VSBuffer } from '../../../../base/common/buffer.js';
-import { newWriteableStream } from '../../../../base/common/stream.js';
-import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../base/test/common/utils.js';
+import { VSBuffer } from '../../../../../../base/common/buffer.js';
+import { Range } from '../../../../../../editor/common/core/range.js';
+import { newWriteableStream } from '../../../../../../base/common/stream.js';
+import { TestDecoder } from '../../../../../../editor/test/common/utils/testDecoder.js';
 import { FileReference } from '../../../common/codecs/chatbotPromptCodec/tokens/fileReference.js';
 import { ChatbotPromptCodec } from '../../../common/codecs/chatbotPromptCodec/chatbotPromptCodec.js';
+import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../../../base/test/common/utils.js';
 import { ChatbotPromptDecoder, TChatbotPromptToken } from '../../../common/codecs/chatbotPromptCodec/chatbotPromptDecoder.js';
 
 /**

diff --git a/...ommon/codecs/chatbotPromptDecoder.test.ts → ...ommon/codecs/chatbotPromptDecoder.test.ts b/...ommon/codecs/chatbotPromptDecoder.test.ts → ...ommon/codecs/chatbotPromptDecoder.test.ts
@@ -3,12 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { TestDecoder } from '../utils/testDecoder.js';
-import { Range } from '../../../common/core/range.js';
-import { VSBuffer } from '../../../../base/common/buffer.js';
-import { newWriteableStream } from '../../../../base/common/stream.js';
-import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../base/test/common/utils.js';
+import { VSBuffer } from '../../../../../../base/common/buffer.js';
+import { Range } from '../../../../../../editor/common/core/range.js';
+import { newWriteableStream } from '../../../../../../base/common/stream.js';
+import { TestDecoder } from '../../../../../../editor/test/common/utils/testDecoder.js';
 import { FileReference } from '../../../common/codecs/chatbotPromptCodec/tokens/fileReference.js';
+import { ensureNoDisposablesAreLeakedInTestSuite } from '../../../../../../base/test/common/utils.js';
 import { ChatbotPromptDecoder, TChatbotPromptToken } from '../../../common/codecs/chatbotPromptCodec/chatbotPromptDecoder.js';
 
 /**