Move language-to-comment mapping to runtimeLanguageContext

Author: brdskggs

packages/amazonq/test/unit/codewhisperer/util/runtimeLanguageContext.test.ts

@@ -333,6 +333,40 @@ describe('runtimeLanguageContext', function () {
         }
     })
 
+    describe('getSingleLineCommentPrefix', function () {
+        it('should return the correct comment prefix for supported languages', function () {
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('java'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('javascript'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('jsonc'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('kotlin'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('lua'), '-- ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('python'), '# ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('ruby'), '# ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('sql'), '-- ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('tf'), '# ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('typescript'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('vue'), '')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('yaml'), '# ')
+        })
+
+        it('should normalize language ID before getting comment prefix', function () {
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('hcl'), '# ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('javascriptreact'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('shellscript'), '# ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('typescriptreact'), '// ')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('yml'), '# ')
+        })
+
+        it('should return empty string for unsupported languages', function () {
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('nonexistent'), '')
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix(undefined), '')
+        })
+
+        it('should return empty string for plaintext', function () {
+            assert.strictEqual(languageContext.getSingleLineCommentPrefix('plaintext'), '')
+        })
+    })
+
     // for now we will only jsx mapped to javascript, tsx mapped to typescript, all other language should remain the same
     describe('test covertCwsprRequest', function () {
         const leftFileContent = 'left'

packages/core/src/codewhisperer/util/editorContext.ts

@@ -25,11 +25,6 @@ import { predictionTracker } from '../nextEditPrediction/activation'
 
 let tabSize: number = getTabSizeSetting()
 
-const languageCommentChars: Record<string, string> = {
-    python: '# ',
-    java: '// ',
-}
-
 function getEnclosingNotebook(editor: vscode.TextEditor): vscode.NotebookDocument | undefined {
     // For notebook cells, find the existing notebook with a cell that matches the current editor.
     return vscode.workspace.notebookDocuments.find(
@@ -77,14 +72,14 @@ export function getNotebookContext(
 
 export function getNotebookCellContext(cell: vscode.NotebookCell, referenceLanguage?: string): string {
     // Extract the text verbatim if the cell is code and the cell has the same language.
-    // Otherwise, add the correct comment string for the refeference language
+    // Otherwise, add the correct comment string for the reference language
     const cellText = cell.document.getText()
     if (
         cell.kind === vscode.NotebookCellKind.Markup ||
         (runtimeLanguageContext.normalizeLanguage(cell.document.languageId) ?? cell.document.languageId) !==
             referenceLanguage
     ) {
-        const commentPrefix = (referenceLanguage && languageCommentChars[referenceLanguage]) ?? ''
+        const commentPrefix = runtimeLanguageContext.getSingleLineCommentPrefix(referenceLanguage)
         if (commentPrefix === '') {
             return cellText
         }

packages/core/src/codewhisperer/util/runtimeLanguageContext.ts

@@ -58,6 +58,13 @@ export class RuntimeLanguageContext {
      */
     private supportedLanguageExtensionMap: ConstantMap<string, CodewhispererLanguage>
 
+    /**
+     * A map storing single-line comment prefixes for different languages
+     * Key: CodewhispererLanguage
+     * Value: Comment prefix string
+     */
+    private languageSingleLineCommentPrefixMap: ConstantMap<CodewhispererLanguage, string>
+
     constructor() {
         this.supportedLanguageMap = createConstantMap<
             CodeWhispererConstants.PlatformLanguageId | CodewhispererLanguage,
@@ -146,6 +153,39 @@ export class RuntimeLanguageContext {
             psm1: 'powershell',
             r: 'r',
         })
+        this.languageSingleLineCommentPrefixMap = createConstantMap<CodewhispererLanguage, string>({
+            c: '// ',
+            cpp: '// ',
+            csharp: '// ',
+            dart: '// ',
+            go: '// ',
+            hcl: '# ',
+            java: '// ',
+            javascript: '// ',
+            json: '// ',
+            jsonc: '// ',
+            jsx: '// ',
+            kotlin: '// ',
+            lua: '-- ',
+            php: '// ',
+            plaintext: '',
+            powershell: '# ',
+            python: '# ',
+            r: '# ',
+            ruby: '# ',
+            rust: '// ',
+            scala: '// ',
+            shell: '# ',
+            sql: '-- ',
+            swift: '// ',
+            systemVerilog: '// ',
+            tf: '# ',
+            tsx: '// ',
+            typescript: '// ',
+            vue: '', // vue lacks a single-line comment prefix
+            yaml: '# ',
+            yml: '# ',
+        })
     }
 
     /**
@@ -159,6 +199,16 @@ export class RuntimeLanguageContext {
         return this.supportedLanguageMap.get(languageId)
     }
 
+    /**
+     * Get the comment prefix for a given language
+     * @param language The language to get comment prefix for
+     * @returns The comment prefix string, or empty string if not found
+     */
+    public getSingleLineCommentPrefix(language?: string): string {
+        const normalizedLanguage = this.normalizeLanguage(language)
+        return normalizedLanguage ? (this.languageSingleLineCommentPrefixMap.get(normalizedLanguage) ?? '') : ''
+    }
+
     /**
      * Normalize client side language id to service aware language id (service is not aware of jsx/tsx)
      * Only used when invoking CodeWhisperer service API, for client usage please use normalizeLanguage