Skip to content

Fixes #70832: Never guess tabSize when inserting tabs #73042

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
alexdima merged 1 commit into from
May 24, 2019
Merged

Fixes #70832: Never guess tabSize when inserting tabs #73042

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
30 changes: 17 additions & 13 deletions src/vs/editor/common/model/indentationGuesser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,22 +177,26 @@ export function guessIndentation(source: ITextBuffer, defaultTabSize: number, de
}

let tabSize = defaultTabSize;
let tabSizeScore = (insertSpaces ? 0 : 0.1 * linesCount);

// console.log("score threshold: " + tabSizeScore);
// Guess tabSize only if inserting spaces...
if (insertSpaces) {
let tabSizeScore = (insertSpaces ? 0 : 0.1 * linesCount);

ALLOWED_TAB_SIZE_GUESSES.forEach((possibleTabSize) => {
let possibleTabSizeScore = spacesDiffCount[possibleTabSize];
if (possibleTabSizeScore > tabSizeScore) {
tabSizeScore = possibleTabSizeScore;
tabSize = possibleTabSize;
}
});
// console.log("score threshold: " + tabSizeScore);

ALLOWED_TAB_SIZE_GUESSES.forEach((possibleTabSize) => {
let possibleTabSizeScore = spacesDiffCount[possibleTabSize];
if (possibleTabSizeScore > tabSizeScore) {
tabSizeScore = possibleTabSizeScore;
tabSize = possibleTabSize;
}
});

// Let a tabSize of 2 win even if it is not the maximum
// (only in case 4 was guessed)
if (tabSize === 4 && spacesDiffCount[4] > 0 && spacesDiffCount[2] > 0 && spacesDiffCount[2] >= spacesDiffCount[4] / 2) {
tabSize = 2;
// Let a tabSize of 2 win even if it is not the maximum
// (only in case 4 was guessed)
if (tabSize === 4 && spacesDiffCount[4] > 0 && spacesDiffCount[2] > 0 && spacesDiffCount[2] >= spacesDiffCount[4] / 2) {
tabSize = 2;
}
}


Expand Down
51 changes: 42 additions & 9 deletions src/vs/editor/test/common/model/textModel.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,41 @@ function testGuessIndentation(defaultInsertSpaces: boolean, defaultTabSize: numb
assert.equal(r.tabSize, expectedTabSize, msg);
}

function assertGuess(expectedInsertSpaces: boolean | undefined, expectedTabSize: number | undefined, text: string[], msg?: string): void {
function assertGuess(expectedInsertSpaces: boolean | undefined, expectedTabSize: number | undefined | [number], text: string[], msg?: string): void {
if (typeof expectedInsertSpaces === 'undefined') {
// cannot guess insertSpaces
if (typeof expectedTabSize === 'undefined') {
// cannot guess tabSize
testGuessIndentation(true, 13370, true, 13370, text, msg);
testGuessIndentation(false, 13371, false, 13371, text, msg);
} else {
} else if (typeof expectedTabSize === 'number') {
// can guess tabSize
testGuessIndentation(true, 13370, true, expectedTabSize, text, msg);
testGuessIndentation(false, 13371, false, expectedTabSize, text, msg);
} else {
// can only guess tabSize when insertSpaces is true
testGuessIndentation(true, 13370, true, expectedTabSize[0], text, msg);
testGuessIndentation(false, 13371, false, 13371, text, msg);
}
} else {
// can guess insertSpaces
if (typeof expectedTabSize === 'undefined') {
// cannot guess tabSize
testGuessIndentation(true, 13370, expectedInsertSpaces, 13370, text, msg);
testGuessIndentation(false, 13371, expectedInsertSpaces, 13371, text, msg);
} else {
} else if (typeof expectedTabSize === 'number') {
// can guess tabSize
testGuessIndentation(true, 13370, expectedInsertSpaces, expectedTabSize, text, msg);
testGuessIndentation(false, 13371, expectedInsertSpaces, expectedTabSize, text, msg);
} else {
// can only guess tabSize when insertSpaces is true
if (expectedInsertSpaces === true) {
testGuessIndentation(true, 13370, expectedInsertSpaces, expectedTabSize[0], text, msg);
testGuessIndentation(false, 13371, expectedInsertSpaces, expectedTabSize[0], text, msg);
} else {
testGuessIndentation(true, 13370, expectedInsertSpaces, 13370, text, msg);
testGuessIndentation(false, 13371, expectedInsertSpaces, 13371, text, msg);
}
}
}
}
Expand Down Expand Up @@ -219,7 +232,7 @@ suite('Editor Model - TextModel', () => {
'\tx'
], '7xTAB');

assertGuess(undefined, 2, [
assertGuess(undefined, [2], [
'\tx',
' x',
'\tx',
Expand All @@ -239,7 +252,7 @@ suite('Editor Model - TextModel', () => {
'\tx',
' x'
], '4x1, 4xTAB');
assertGuess(false, 2, [
assertGuess(false, undefined, [
'\tx',
'\tx',
' x',
Expand All @@ -250,7 +263,7 @@ suite('Editor Model - TextModel', () => {
'\tx',
' x',
], '4x2, 5xTAB');
assertGuess(false, 2, [
assertGuess(false, undefined, [
'\tx',
'\tx',
'x',
Expand All @@ -261,7 +274,7 @@ suite('Editor Model - TextModel', () => {
'\tx',
' x',
], '1x2, 5xTAB');
assertGuess(false, 4, [
assertGuess(false, undefined, [
'\tx',
'\tx',
'x',
Expand All @@ -272,7 +285,7 @@ suite('Editor Model - TextModel', () => {
'\tx',
' x',
], '1x4, 5xTAB');
assertGuess(false, 2, [
assertGuess(false, undefined, [
'\tx',
'\tx',
'x',
Expand Down Expand Up @@ -524,7 +537,7 @@ suite('Editor Model - TextModel', () => {
' \t x',
'\tx'
], 'mixed whitespace 1');
assertGuess(false, 4, [
assertGuess(false, undefined, [
'\tx',
'\t x'
], 'mixed whitespace 2');
Expand Down Expand Up @@ -575,6 +588,26 @@ suite('Editor Model - TextModel', () => {
]);
});

test('issue #70832: Broken indentation detection', () => {
assertGuess(false, undefined, [
'x',
'x',
'x',
'x',
' x',
' x',
' x',
' x',
' x',
' x',
' x',
' x',
' x',
' x',
'x',
]);
});

test('validatePosition', () => {

let m = TextModel.createFromString('line one\nline two');
Expand Down