only show TODO code lens on lines that start with a comment token (#7962)

* Change default value for codingAgent.codeLens setting

While #7962 is under discussion

* [WIP] Fix test for codingAgent.codeLens setting (#7982)

* Initial plan

* Fix IssueTodoProvider test by enabling codeLens setting

Co-authored-by: joshspicer <23246594+joshspicer@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: joshspicer <23246594+joshspicer@users.noreply.github.com>

* check isComment first

* swap order of checks

* workaround for test

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

Author: joshspicer

src/issues/issueTodoProvider.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import { MAX_LINE_LENGTH } from './util';
+import { isComment, MAX_LINE_LENGTH } from './util';
 import { CODING_AGENT, CREATE_ISSUE_TRIGGERS, ISSUES_SETTINGS_NAMESPACE, SHOW_CODE_LENS } from '../common/settingKeys';
 import { escapeRegExp } from '../common/utils';
 import { CopilotRemoteAgentManager } from '../github/copilotRemoteAgent';
@@ -114,19 +114,24 @@ export class IssueTodoProvider implements vscode.CodeActionProvider, vscode.Code
 
 		const codeLenses: vscode.CodeLens[] = [];
 		for (let lineNumber = 0; lineNumber < document.lineCount; lineNumber++) {
-			const line = document.lineAt(lineNumber).text;
+			const textLine = document.lineAt(lineNumber);
+			const { text: line, firstNonWhitespaceCharacterIndex } = textLine;
 			const todoInfo = this.findTodoInLine(line);
-			if (todoInfo) {
-				const { match, search, insertIndex } = todoInfo;
-				const range = new vscode.Range(lineNumber, search, lineNumber, search + match[0].length);
-				if (this.copilotRemoteAgentManager && (await this.copilotRemoteAgentManager.isAvailable())) {
-					const startAgentCodeLens = new vscode.CodeLens(range, {
-						title: vscode.l10n.t('Delegate to coding agent'),
-						command: 'issue.startCodingAgentFromTodo',
-						arguments: [{ document, lineNumber, line, insertIndex, range }],
-					});
-					codeLenses.push(startAgentCodeLens);
-				}
+			if (!todoInfo) {
+				continue;
+			}
+			if (!(await isComment(document, new vscode.Position(lineNumber, firstNonWhitespaceCharacterIndex)))) {
+				continue;
+			}
+			const { match, search, insertIndex } = todoInfo;
+			const range = new vscode.Range(lineNumber, search, lineNumber, search + match[0].length);
+			if (this.copilotRemoteAgentManager && (await this.copilotRemoteAgentManager.isAvailable())) {
+				const startAgentCodeLens = new vscode.CodeLens(range, {
+					title: vscode.l10n.t('Delegate to coding agent'),
+					command: 'issue.startCodingAgentFromTodo',
+					arguments: [{ document, lineNumber, line, insertIndex, range }],
+				});
+				codeLenses.push(startAgentCodeLens);
 			}
 		}
 		return codeLenses;

src/test/issues/issueTodoProvider.test.ts

@@ -8,12 +8,31 @@ import * as vscode from 'vscode';
 import { IssueTodoProvider } from '../../issues/issueTodoProvider';
 import { CopilotRemoteAgentManager } from '../../github/copilotRemoteAgent';
 import { CODING_AGENT, CREATE_ISSUE_TRIGGERS, ISSUES_SETTINGS_NAMESPACE, SHOW_CODE_LENS } from '../../common/settingKeys';
+import * as issueUtil from '../../issues/util';
 
 const mockCopilotManager: Partial<CopilotRemoteAgentManager> = {
 	isAvailable: () => Promise.resolve(true)
 }
 
 describe('IssueTodoProvider', function () {
+	// Mock isComment
+	// We don't have a real 'vscode.TextDocument' in these tests, which
+	// causes 'vscode.languages.getTokenInformationAtPosition' to throw.
+	const originalIsComment = issueUtil.isComment;
+	before(() => {
+		(issueUtil as any).isComment = async (document: vscode.TextDocument, position: vscode.Position) => {
+			try {
+				const lineText = document.lineAt(position.line).text;
+				return lineText.trim().startsWith('//');
+			} catch {
+				return false;
+			}
+		};
+	});
+	after(() => {
+		(issueUtil as any).isComment = originalIsComment;
+	});
+
 	it('should provide both actions when CopilotRemoteAgentManager is available', async function () {
 		const mockContext = {
 			subscriptions: []
@@ -119,10 +138,12 @@ describe('IssueTodoProvider', function () {
 
 		// Create a mock document with TODO comment
 		const document = {
-			lineAt: (line: number) => ({
-				text: line === 1 ? '  // TODO: Fix this' : 'function test() {}'
-			}),
-			lineCount: 4
+			lineAt: (lineNo: number) => ({
+				text: lineNo === 1 ? '  // TODO: Fix this' : 'function test() {}',
+				firstNonWhitespaceCharacterIndex: lineNo === 1 ? 2 : 0,
+			} as vscode.TextLine),
+			lineCount: 4,
+			languageId: 'javascript'
 		} as vscode.TextDocument;
 
 		const originalGetConfiguration = vscode.workspace.getConfiguration;