Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshspicer merged 6 commits into from
Oct 13, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63fb8ba
Change default value for codingAgent.codeLens setting
joshspicer Oct 10, 2025
533f1ea
[WIP] Fix test for codingAgent.codeLens setting (#7982)
Copilot Oct 10, 2025
c2270dc
check isComment first
joshspicer Oct 13, 2025
82ce9b8
swap order of checks
joshspicer Oct 13, 2025
e334afe
workaround for test
joshspicer Oct 13, 2025
3c715b3
Merge branch 'main' into joshspicer/todo-fix
joshspicer Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions src/issues/issueTodoProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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)))) {
Copy link
Member Author

@joshspicer joshspicer Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't decide what is more efficient/correct to do first, the comment check or the findTodoInLine() check. @alexr00 preference?

Copy link
Member

@alexr00 alexr00 Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, isComment ends up being a round trip to the renderer, so findTodoInLine is probably cheaper time-wise to do first.

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;
Expand Down
29 changes: 25 additions & 4 deletions src/test/issues/issueTodoProvider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down Expand Up @@ -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;
Expand Down