update

sourcegraph · umpox · Jan 14, 2025 · Jan 13, 2025 · Jan 13, 2025 · Jan 13, 2025
commit aa415568700f599677949f1d3cb083023788ebae
diff --git a/vscode/src/autoedits/renderer/decorators/blockify.test.ts b/vscode/src/autoedits/renderer/decorators/blockify.test.ts
@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest'
 import { document } from '../../../completions/test-helpers'
 import { blockify } from './blockify'
-import { AddedLinesDecorationInfo } from './default-decorator'
+import type { AddedLinesDecorationInfo } from './default-decorator'
 
 describe('blockify', () => {
     describe('space indentation', () => {
@@ -51,7 +51,7 @@ describe('blockify', () => {
         })
     })
 
-    describe('space indentation', () => {
+    describe('tab indentation', () => {
         // Content doesn't matter here, just the fact that this document uses tabs
         const mockSpacesDocument = document('\thello world\n\tgoodbye world')
 

diff --git a/vscode/src/autoedits/renderer/decorators/blockify.ts b/vscode/src/autoedits/renderer/decorators/blockify.ts
@@ -1,6 +1,6 @@
 import * as vscode from 'vscode'
 import { getEditorTabSize } from '@sourcegraph/cody-shared'
-import { AddedLinesDecorationInfo } from './default-decorator'
+import type { AddedLinesDecorationInfo } from './default-decorator'
 import detectIndent from 'detect-indent'
 
 export const UNICODE_SPACE = '\u00A0'
@@ -15,13 +15,16 @@ export function blockify(document: vscode.TextDocument, addedLines: AddedLinesDe
 export function convertToSpaceIndentation(document: vscode.TextDocument, addedLines: AddedLinesDecorationInfo[]): AddedLinesDecorationInfo[] {
     const incomingIndentation = detectIndent(addedLines.map((line) => line.lineText).join('\n')).type
     if (incomingIndentation === 'space') {
-        // Convert regular spaces to unicode spaces
+        // In order to reliably render spaces in VS Code decorations, we must convert them to
+        // their unicode equivalent
         return addedLines.map(line => ({
             ...line,
-            lineText: line.lineText.replace(/^( +)/, match => UNICODE_SPACE.repeat(match.length))
+            lineText: line.lineText.replace(/^\s+/, match => UNICODE_SPACE.repeat(match.length))
         }))
     }
 
+    // The incoming indentation is tab-based, but this will not render correctly in VS COde decorations.
+    // We must convert it to space indentation that matches the editor's tab size
     const tabSize = getEditorTabSize(document.uri, vscode.workspace, vscode.window)
     const tabAsSpace = UNICODE_SPACE.repeat(tabSize)
     return addedLines.map(line => ({
@@ -30,7 +33,6 @@ export function convertToSpaceIndentation(document: vscode.TextDocument, addedLi
     }))
 }
 
-
 function padTrailingWhitespaceBlock(addedLines: AddedLinesDecorationInfo[]): AddedLinesDecorationInfo[] {
     let maxLineWidth = 0
     for (const addedLine of addedLines) {
@@ -41,6 +43,7 @@ function padTrailingWhitespaceBlock(addedLines: AddedLinesDecorationInfo[]): Add
         lineText: line.lineText.padEnd(maxLineWidth, UNICODE_SPACE)
     }))
 }
+
 function removeLeadingWhitespaceBlock(addedLines: AddedLinesDecorationInfo[]): AddedLinesDecorationInfo[] {
     let leastCommonWhitespacePrefix: undefined | string = undefined
     for (const addedLine of addedLines) {
@@ -69,6 +72,7 @@ function removeLeadingWhitespaceBlock(addedLines: AddedLinesDecorationInfo[]): A
         ])
     }))
 }
+
 function getCommonPrefix(s1: string, s2: string): string {
     const minLength = Math.min(s1.length, s2.length)
     let commonPrefix = ''

diff --git a/vscode/src/autoedits/renderer/decorators/default-decorator.ts b/vscode/src/autoedits/renderer/decorators/default-decorator.ts
@@ -260,13 +260,15 @@ export class DefaultDecorator implements AutoEditsDecorator {
         startLine: number,
         replacerCol: number
     ): void {
-        const addedLinesInfo = blockify(this.editor.document, _addedLinesInfo)
+        // Blockify the added lines so they are suitable to be rendered together as a VS Code decoration
+        const blockifiedAddedLines = blockify(this.editor.document, _addedLinesInfo)
         const replacerDecorations: vscode.DecorationOptions[] = []
-        for (let i = 0; i < addedLinesInfo.length; i++) {
+
+        for (let i = 0; i < blockifiedAddedLines.length; i++) {
             const j = i + startLine
             const line = this.editor.document.lineAt(j)
             const lineReplacerCol = this.getReplacerColumn(line)
-            const decoration = addedLinesInfo[i]
+            const decoration = blockifiedAddedLines[i]
             const decorationStyle = cssPropertiesToString({
                 // Absolutely position the suggested code so that the cursor does not jump there
                 position: 'absolute',
@@ -291,7 +293,6 @@ export class DefaultDecorator implements AutoEditsDecorator {
                         // Required to make the viewport scrollable to view the suggestion if it's outside.
                         after: {
                             contentText:
-                            // Creates a spacer element with the same width as the suggested code to ensure proper scrolling
                             UNICODE_SPACE.repeat(3) + decoration.lineText.replace(/\S/g, UNICODE_SPACE),
                             margin: `0 0 0 ${replacerCol - lineReplacerCol}ch`,
                         },