Make including JS Doc optional (#1186)

Author: dbaeumer

package.json

@@ -2827,6 +2827,16 @@
 						],
 						"markdownDescription": "%github.copilot.chat.languageContext.typescript.items%"
 					},
+					"github.copilot.chat.languageContext.typescript.includeDocumentation": {
+						"type": "boolean",
+						"default": false,
+						"scope": "resource",
+						"tags": [
+							"experimental",
+							"onExP"
+						],
+						"markdownDescription": "%github.copilot.chat.languageContext.typescript.includeDocumentation%"
+					},
 					"github.copilot.chat.languageContext.typescript.cacheTimeout": {
 						"type": "number",
 						"default": 500,

package.nls.json

@@ -229,6 +229,7 @@
 	"github.copilot.chat.completionContext.typescript.mode": "The execution mode of the TypeScript Copilot context provider.",
 	"github.copilot.chat.languageContext.typescript.enabled": "Enables the TypeScript language context provider for inline completions",
 	"github.copilot.chat.languageContext.typescript.items": "Controls which kind of items are included in the TypeScript language context provider.",
+	"github.copilot.chat.languageContext.typescript.includeDocumentation": "Controls whether to include documentation comments in the generated code snippets.",
 	"github.copilot.chat.languageContext.typescript.cacheTimeout": "The cache population timeout for the TypeScript language context provider in milliseconds. The default is 500 milliseconds.",
 	"github.copilot.chat.languageContext.fix.typescript.enabled": "Enables the TypeScript language context provider for /fix commands",
 	"github.copilot.chat.languageContext.inline.typescript.enabled": "Enables the TypeScript language context provider for inline chats (both generate and edit)",

src/extension/typescriptContext/common/serverProtocol.ts

@@ -399,6 +399,7 @@ export interface ComputeContextRequestArgs extends tt.server.protocol.FileLocati
 	timeBudget: number;
 	primaryCharacterBudget: number;
 	secondaryCharacterBudget: number;
+	includeDocumentation?: boolean;
 	neighborFiles?: readonly FilePath[];
 	clientSideRunnableResults?: readonly CachedContextRunnableResult[];
 }

src/extension/typescriptContext/serverPlugin/src/common/baseContextProviders.ts

@@ -523,15 +523,15 @@ export class TypeOfExpressionRunnable extends AbstractContextRunnable {
 			if (returnTypeSymbol === undefined) {
 				continue;
 			}
-			const snippetBuilder = new CodeSnippetBuilder(this.session, this.symbols, sourceFile);
+			const snippetBuilder = new CodeSnippetBuilder(this.context, this.symbols, sourceFile);
 			snippetBuilder.addTypeSymbol(returnTypeSymbol, returnTypeSymbol.name);
 			result.addSnippet(snippetBuilder, this.location, undefined);
 		}
 		const typeSymbol = type.getSymbol();
 		if (typeSymbol === undefined) {
 			return;
 		}
-		const snippetBuilder = new CodeSnippetBuilder(this.session, this.symbols, sourceFile);
+		const snippetBuilder = new CodeSnippetBuilder(this.context, this.symbols, sourceFile);
 		snippetBuilder.addTypeSymbol(typeSymbol, typeSymbol.name);
 		result.addSnippet(snippetBuilder, this.location, undefined);
 	}

src/extension/typescriptContext/serverPlugin/src/common/classContextProvider.ts

@@ -9,7 +9,7 @@ const ts = TS();
 import { CodeSnippetBuilder } from './code';
 import { AbstractContextRunnable, ComputeCost, ContextProvider, ContextResult, Search, SnippetLocation, type ComputeContextSession, type ContextRunnableCollector, type RequestContext, type RunnableResult } from './contextProvider';
 import { EmitMode, Priorities, SpeculativeKind } from './protocol';
-import tss, { ClassDeclarations, ReferencedByVisitor, Symbols } from './typescripts';
+import tss, { ClassDeclarations, ReferencedByVisitor, Symbols, type DirectSuperSymbolInfo } from './typescripts';
 
 export type TypeInfo = {
 	symbol: tt.Symbol;
@@ -284,9 +284,23 @@ export class SuperClassRunnable extends AbstractContextRunnable {
 			return;
 		}
 
-		const [extendsClass, extendsName] = symbols.getExtendsSymbol(clazz);
-		if (extendsClass !== undefined && extendsName !== undefined) {
-			this.handleSymbol(extendsClass, extendsName);
+		const directSuperSymbolInfo: DirectSuperSymbolInfo | undefined = symbols.getDirectSuperSymbols(clazz);
+		if (directSuperSymbolInfo === undefined) {
+			return;
+		}
+		if (directSuperSymbolInfo.extends !== undefined) {
+			const { symbol, name } = directSuperSymbolInfo.extends;
+			if (symbol !== undefined && name !== undefined) {
+				this.handleSymbol(symbol, name);
+			}
+		}
+		if (directSuperSymbolInfo.implements !== undefined) {
+			for (const impl of directSuperSymbolInfo.implements) {
+				const { symbol, name } = impl;
+				if (symbol !== undefined && name !== undefined) {
+					this.handleSymbol(symbol, name);
+				}
+			}
 		}
 	}
 }
@@ -323,7 +337,7 @@ class SimilarClassRunnable extends AbstractContextRunnable {
 		if (foundInProgram === undefined || similarClass === undefined) {
 			return;
 		}
-		const code = new CodeSnippetBuilder(this.session, this.context.getSymbols(foundInProgram), classDeclaration.getSourceFile());
+		const code = new CodeSnippetBuilder(this.context, this.context.getSymbols(foundInProgram), classDeclaration.getSourceFile());
 		code.addDeclaration(similarClass.declaration);
 		result.addSnippet(code, this.location, undefined);
 	}