fix(method-snippets): now method snippets always insert single-line snippet

test: don't fail other tests when one is failing

Author: zardoy

typescript/src/constructMethodSnippet.ts

@@ -44,12 +44,15 @@ export default (languageService: ts.LanguageService, sourceFile: ts.SourceFile,
                       ts.factory.createParameterDeclaration(
                           undefined,
                           valueDeclaration.dotDotDotToken,
-                          !ts.isIdentifier(valueDeclaration.name) && insertMode !== 'always-declaration'
-                              ? cloneBindingName(valueDeclaration.name)
-                              : valueDeclaration.name,
+                          insertMode === 'always-declaration' ? valueDeclaration.name : cloneBindingName(valueDeclaration.name),
                           insertMode === 'always-declaration' ? valueDeclaration.questionToken : undefined,
                           undefined,
-                          insertMode === 'always-declaration' ? valueDeclaration.initializer : undefined,
+                          insertMode === 'always-declaration' && valueDeclaration.initializer
+                              ? ts.setEmitFlags(
+                                    tsFull.factory.cloneNode(valueDeclaration.initializer as any),
+                                    ts.EmitFlags.SingleLine | ts.EmitFlags.NoAsciiEscaping,
+                                )
+                              : undefined,
                       ),
                       valueDeclaration.getSourceFile(),
                   )
@@ -65,6 +68,7 @@ export default (languageService: ts.LanguageService, sourceFile: ts.SourceFile,
     // return `(${paramsToInsert.map((param, i) => `\${${i + 1}:${param.replaceAll}}`).join(', ')})`
 
     function cloneBindingName(node: ts.BindingName): ts.BindingName {
+        if (ts.isIdentifier(node)) return ts.factory.createIdentifier(node.text)
         return elideInitializerAndSetEmitFlags(node) as ts.BindingName
         function elideInitializerAndSetEmitFlags(node: ts.Node): ts.Node {
             let visited = ts.visitEachChild(

typescript/test/completions.spec.ts

@@ -5,7 +5,7 @@ import { findChildContainingExactPosition } from '../src/utils'
 import handleCommand from '../src/specialCommands/handle'
 import _ from 'lodash'
 import { defaultConfigFunc, entrypoint, settingsOverride, sharedLanguageService } from './shared'
-import { fileContentsSpecialPositions, fourslashLikeTester, getCompletionsAtPosition } from './testing'
+import { fileContentsSpecialPositions, fourslashLikeTester, getCompletionsAtPosition, overrideSettings } from './testing'
 import constructMethodSnippet from '../src/constructMethodSnippet'
 
 const { languageService, languageServiceHost, updateProject, getCurrentFile } = sharedLanguageService
@@ -150,33 +150,54 @@ describe('Method snippets', () => {
                 } = {}, ...c): void
             }
             baz/*5*/
+
+            // should ignores comments
+            declare const withComments = (
+                a: boolean,
+                // comment
+                b: boolean,
+                /* jsdoc */
+                c: boolean
+            ) => void
+
+            withComments/*6*/
         `)
 
         compareMethodSnippetAgainstMarker(markers, 1, null)
         compareMethodSnippetAgainstMarker(markers, 2, '()')
         compareMethodSnippetAgainstMarker(markers, 3, '(a)')
         compareMethodSnippetAgainstMarker(markers, 4, '($b)')
         compareMethodSnippetAgainstMarker(markers, 5, '(a, b, { d, e: {} }, ...c)')
+        compareMethodSnippetAgainstMarker(markers, 6, '(a, b, c)')
     })
 
     test('Insert text = always-declaration', () => {
-        settingsOverride['methodSnippets.insertText'] = 'always-declaration'
+        overrideSettings({
+            'methodSnippets.insertText': 'always-declaration',
+        })
         const [, _, markers] = fileContentsSpecialPositions(/* ts */ `
             declare const baz: {
-                (a: string = "test", b?, {
-                    d = false,
-                    e: {}
-                } = { }, ...c): void
+                (
+                    a: string =
+                        "super" +
+                        "test",
+                    b?, {
+                        d = false,
+                        e: {}
+                    } = { },
+                    ...c
+                ): void
             }
             baz/*1*/
         `)
 
-        compareMethodSnippetAgainstMarker(markers, 1, '(a = "test", b?, { d = false, e: {} } = {}, ...c)')
-        settingsOverride['methodSnippets.insertText'] = 'binding-name'
+        compareMethodSnippetAgainstMarker(markers, 1, '(a = "super" + "test", b?, { d = false, e: {} } = {}, ...c)')
     })
 
     test('methodSnippets.skip', () => {
-        settingsOverride['methodSnippets.skip'] = 'optional-and-rest'
+        overrideSettings({
+            'methodSnippets.skip': 'optional-and-rest',
+        })
         const [, _, markers] = fileContentsSpecialPositions(/* ts */ `
             declare const baz: {
                 (a: string = "test", b?, {
@@ -327,7 +348,9 @@ test('Switch Case Exclude Covered', () => {
 })
 
 test('Case-sensetive completions', () => {
-    settingsOverride.caseSensitiveCompletions = true
+    overrideSettings({
+        caseSensitiveCompletions: true,
+    })
     const [_positivePositions, _negativePositions, numPositions] = fileContentsSpecialPositions(/* ts */ `
         const a = {
             TestItem: 5,
@@ -348,7 +371,9 @@ test('Case-sensetive completions', () => {
 })
 
 test('Fix properties sorting', () => {
-    settingsOverride.fixSuggestionsSorting = true
+    overrideSettings({
+        fixSuggestionsSorting: true,
+    })
     const tester = fourslashLikeTester(/* tsx */ `
         let a: {
             d
@@ -386,6 +411,9 @@ test('Fix properties sorting', () => {
 // ts 5
 test.todo('Change to function kind', () => {
     settingsOverride['experiments.changeKindToFunction'] = true
+    overrideSettings({
+        'experiments.changeKindToFunction': true,
+    })
     const tester = fourslashLikeTester(/* ts */ `
         // declare const foo: boolean
         const foo = () => {}
@@ -579,37 +607,40 @@ test('In Keyword Completions', () => {
             "insertText": "a",
             "isSnippet": true,
             "kind": "string",
+            "labelDetails": {
+              "description": "2, 3",
+            },
             "name": "a",
-            "sourceDisplay": [
-              {
-                "kind": "text",
-                "text": "2, 3",
-              },
-            ],
+            "replacementSpan": {
+              "length": 0,
+              "start": 101,
+            },
           },
           {
             "insertText": "b",
             "isSnippet": true,
             "kind": "string",
+            "labelDetails": {
+              "description": "2",
+            },
             "name": "☆b",
-            "sourceDisplay": [
-              {
-                "kind": "text",
-                "text": "2",
-              },
-            ],
+            "replacementSpan": {
+              "length": 0,
+              "start": 101,
+            },
           },
           {
             "insertText": "c",
             "isSnippet": true,
             "kind": "string",
+            "labelDetails": {
+              "description": "3",
+            },
             "name": "☆c",
-            "sourceDisplay": [
-              {
-                "kind": "text",
-                "text": "3",
-              },
-            ],
+            "replacementSpan": {
+              "length": 0,
+              "start": 101,
+            },
           },
         ],
         "prevCompletionsMap": {

typescript/test/testing.ts

@@ -1,6 +1,7 @@
 import _ from 'lodash'
 import { getCompletionsAtPosition as getCompletionsAtPositionRaw } from '../src/completionsAtPosition'
-import { defaultConfigFunc, entrypoint, sharedLanguageService } from './shared'
+import { Configuration } from '../src/types'
+import { defaultConfigFunc, entrypoint, sharedLanguageService, settingsOverride } from './shared'
 
 interface CompletionPartMatcher {
     names?: string[]
@@ -48,6 +49,18 @@ export const getCompletionsAtPosition = (pos: number, { fileName = entrypoint, s
     }
 }
 
+// shouldn't be used twice in the same test
+export const overrideSettings = (newOverrides: Partial<Configuration>) => {
+    const oldOverrides = { ...settingsOverride, ...Object.fromEntries(Object.entries(newOverrides).map(([key]) => [key, undefined])) }
+    Object.assign(settingsOverride, newOverrides)
+    let cleaned = false
+    afterEach(() => {
+        if (cleaned) return
+        cleaned = true
+        Object.assign(settingsOverride, oldOverrides)
+    })
+}
+
 export const fourslashLikeTester = (contents: string, fileName = entrypoint) => {
     const [positive, _negative, numberedPositions] = fileContentsSpecialPositions(contents, fileName)