Skip to content

Trim surrounding whitespace from line comment token #316763

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

Open
verifizieren wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −2
Open

Trim surrounding whitespace from line comment token #316763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions src/vs/editor/common/languages/languageConfigurationRegistry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,10 +457,13 @@ export class ResolvedLanguageConfiguration {
const comments: ICommentsConfiguration = {};

if (commentRule.lineComment) {
// Surrounding whitespace is not part of the comment marker; spacing on
// insertion is controlled by the `editor.comments.insertSpace` setting.
// Keeping it would break comment toggling, see #249958.
if (typeof commentRule.lineComment === 'string') {
comments.lineCommentToken = commentRule.lineComment;
comments.lineCommentToken = commentRule.lineComment.trim();
} else {
comments.lineCommentToken = commentRule.lineComment.comment;
comments.lineCommentToken = commentRule.lineComment.comment.trim();
Comment thread
verifizieren marked this conversation as resolved.
comments.lineCommentNoIndent = commentRule.lineComment.noIndent;
}
}
Expand Down
66 changes: 66 additions & 0 deletions src/vs/editor/contrib/comment/test/browser/lineCommentCommand.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,72 @@ suite('Editor Contrib - Line Comment Command', () => {
);
});

test('toggle line comment when the comment token has surrounding whitespace (#249958)', function () {
const testLineCommentCommand = createTestCommandHelper(
{ lineComment: ' !@# ' },
(accessor, sel) => new LineCommentCommand(accessor.get(ILanguageConfigurationService), sel, 4, Type.Toggle, true, true)
);

// Adds the trimmed comment token
testLineCommentCommand(
[
'some text'
],
new Selection(1, 1, 1, 1),
[
'!@# some text'
],
new Selection(1, 5, 1, 5)
);

// Toggling again removes it instead of stacking another comment
testLineCommentCommand(
[
'!@# some text'
],
new Selection(1, 1, 1, 1),
[
'some text'
],
new Selection(1, 1, 1, 1)
);
});

test('toggle line comment when the object-form comment token has surrounding whitespace (#249958)', function () {
const testLineCommentCommand = createTestCommandHelper(
{ lineComment: { comment: ' !@# ', noIndent: true } },
(accessor, sel) => new LineCommentCommand(accessor.get(ILanguageConfigurationService), sel, 4, Type.Toggle, true, true)
);

// Adds the trimmed comment token at the first column (noIndent)
testLineCommentCommand(
[
'some text',
'\tsome more text'
],
new Selection(2, 1, 2, 1),
[
'some text',
'!@# \tsome more text'
],
new Selection(2, 5, 2, 5)
);

// Toggling again removes it instead of stacking another comment
testLineCommentCommand(
[
'some text',
'!@# \tsome more text'
],
new Selection(2, 1, 2, 1),
[
'some text',
'\tsome more text'
],
new Selection(2, 1, 2, 1)
);
});

function createSimpleModel(lines: string[]): ISimpleModel {
return {
getLineContent: (lineNumber: number) => {
Expand Down