formatting

Author: iisaduan

internal/format/span.go

@@ -268,7 +268,7 @@ func (w *formatSpanWorker) execute(s *formattingScanner) []core.TextChange {
 			w.insertIndentation(item.Loc.Pos(), indentation, false)
 		})
 
-		if opt.TrimTrailingWhitespace != false {
+		if opt.TrimTrailingWhitespace {
 			w.trimTrailingWhitespacesForRemainingRange(remainingTrivia)
 		}
 	}
@@ -303,6 +303,9 @@ func (w *formatSpanWorker) execute(s *formattingScanner) []core.TextChange {
 			// edit in the middle of a token where the range ended, so if we have a non-contiguous
 			// pair here, we're already done and we can ignore it.
 			parent := astnav.FindPrecedingToken(w.sourceFile, tokenInfo.Loc.End())
+			if parent != nil {
+				parent = parent.Parent
+			}
 			if parent == nil {
 				parent = w.previousParent
 			}

internal/fourslash/_scripts/convertFourslash.mts

@@ -179,6 +179,12 @@ function parseFourslashStatement(statement: ts.Statement): Cmd[] | undefined {
                 case "importFixAtPosition":
                     // `verify.importFixAtPosition(...)`
                     return parseImportFixAtPositionArgs(callExpression.arguments);
+                case "currentLineContentIs":
+                case "currentFileContentIs":
+                case "indentationIs":
+                case "indentationAtPositionIs":
+                case "textAtCaretIs":
+                    return parseCurrentContentIsArgs(func.text, callExpression.arguments);
                 case "quickInfoAt":
                 case "quickInfoExists":
                 case "quickInfoIs":
@@ -251,6 +257,9 @@ function parseFourslashStatement(statement: ts.Statement): Cmd[] | undefined {
             }
             return [result];
         }
+        if (namespace.text === "format") {
+            return parseFormatStatement(func.text, callExpression.arguments);
+        }
         // !!! other fourslash commands
     }
     console.error(`Unrecognized fourslash statement: ${statement.getText()}`);
@@ -307,6 +316,63 @@ function parseEditStatement(funcName: string, args: readonly ts.Expression[]): E
     }
 }
 
+function parseFormatStatement(funcName: string, args: readonly ts.Expression[]): FormatCmd[] | undefined {
+    switch (funcName) {
+        case "document": {
+            return [{
+                kind: "format",
+                goStatement: `f.FormatDocument(t, "")`,
+            }];
+        }
+        case "setOption":
+            const optName = getGoStringLiteral(getStringLiteralLike(args[0])!.text);
+            return [{
+                kind: "format",
+                goStatement: `f.SetFormatOption(t, ${optName}, ${args[1].getText()})`,
+            }];
+        case "selection":
+        case "onType":
+        case "copyFormatOptions":
+        case "setFormatOptions":
+            console.error(`format function not implemented: ${funcName}`);
+            break;
+        default:
+            console.error(`Unrecognized format function: ${funcName}`);
+    }
+    return undefined;
+}
+
+function parseCurrentContentIsArgs(funcName: string, args: readonly ts.Expression[]): VerifyContentCmd[] | undefined {
+    switch (funcName) {
+        case "currentFileContentIs":
+            return [{
+                kind: "verifyContent",
+                goStatement: `f.VerifyCurrentFileContent(t, ${getGoStringLiteralFromNode(args[0])!})`,
+            }];
+        case "currentLineContentIs":
+            return [{
+                kind: "verifyContent",
+                goStatement: `f.VerifyCurrentLineContent(t, ${getGoStringLiteralFromNode(args[0])!})`,
+            }];
+        case "indentationIs":
+            // return [{
+            //     kind: "verifyContent",
+            //     goStatement: `f.VerifyIndentation(t, ${getNumericLiteral(args[0])?.text})`,
+            // }];
+        case "indentationAtPositionIs":
+        case "textAtCaretIs":
+            console.error(`unimplemented verify content function: ${funcName}`);
+            return undefined;
+            // return [{
+            //     kind: "verifyContent",
+            //     goStatement: `f.VerifyTextAtCaret(t, ${getGoStringLiteral(args[0].getText())})`,
+            // }];
+        default:
+            console.error(`Unrecognized verify content function: ${funcName}`);
+            return undefined;
+    }
+}
+
 function getGoMultiLineStringLiteral(text: string): string {
     if (!text.includes("`") && !text.includes("\\")) {
         return "`" + text + "`";
@@ -318,6 +384,24 @@ function getGoStringLiteral(text: string): string {
     return `${JSON.stringify(text)}`;
 }
 
+function getGoStringLiteralFromNode(node: ts.Node): string | undefined {
+    const stringLiteralLike = getStringLiteralLike(node);
+    if (stringLiteralLike) {
+        return getGoMultiLineStringLiteral(stringLiteralLike.text);
+    }
+    switch (node.kind) {
+        case ts.SyntaxKind.BinaryExpression: {
+            const binaryExpr = node as ts.BinaryExpression;
+            const left = getGoStringLiteralFromNode(binaryExpr.left);
+            const right = getGoStringLiteralFromNode(binaryExpr.right);
+            const op = binaryExpr.operatorToken.getText();
+            return left + op + right;
+        }
+        default:
+            console.error(`Unhandled case ${node.kind} in getGoStringLiteralFromNode: ${node.getText()}`);
+    }
+}
+
 function parseGoToArgs(args: readonly ts.Expression[], funcName: string): GoToCmd[] | undefined {
     switch (funcName) {
         case "marker": {
@@ -2498,6 +2582,16 @@ interface EditCmd {
     goStatement: string;
 }
 
+interface FormatCmd {
+    kind: "format"; // | "formatSelection" | "formatOnType" | "copyFormatOptions" | "setFormatOptions" | "setOption";
+    goStatement: string;
+}
+
+interface VerifyContentCmd {
+    kind: "verifyContent";
+    goStatement: string;
+}
+
 interface VerifyQuickInfoCmd {
     kind: "quickInfoIs" | "quickInfoAt" | "quickInfoExists" | "notQuickInfoExists";
     marker?: string;
@@ -2582,7 +2676,9 @@ type Cmd =
     | VerifyNoSignatureHelpForTriggerReasonCmd
     | VerifyBaselineCallHierarchy
     | GoToCmd
+    | FormatCmd
     | EditCmd
+    | VerifyContentCmd
     | VerifyQuickInfoCmd
     | VerifyBaselineRenameCmd
     | VerifyRenameInfoCmd
@@ -2860,6 +2956,8 @@ function generateCmd(cmd: Cmd): string {
         case "goTo":
             return generateGoToCommand(cmd);
         case "edit":
+        case "format":
+        case "verifyContent":
             return cmd.goStatement;
         case "quickInfoAt":
         case "quickInfoIs":

internal/fourslash/_scripts/failingTests.txt

@@ -3,6 +3,7 @@ TestAmbientShorthandGotoDefinition
 TestArgumentsAreAvailableAfterEditsAtEndOfFunction
 TestAugmentedTypesClass1
 TestAugmentedTypesClass3Fourslash
+TestAutoFormattingOnPasting
 TestAutoImportCompletionAmbientMergedModule1
 TestAutoImportCompletionExportListAugmentation1
 TestAutoImportCompletionExportListAugmentation2
@@ -32,7 +33,10 @@ TestAutoImportProvider_pnpm
 TestAutoImportProvider_wildcardExports1
 TestAutoImportProvider_wildcardExports2
 TestAutoImportProvider_wildcardExports3
+TestAutoImportProvider1
 TestAutoImportProvider4
+TestAutoImportProvider7
+TestAutoImportProvider8
 TestAutoImportSortCaseSensitivity1
 TestAutoImportSymlinkCaseSensitive
 TestAutoImportTypeImport1
@@ -241,10 +245,87 @@ TestExportDefaultClass
 TestExportDefaultFunction
 TestFindReferencesBindingPatternInJsdocNoCrash1
 TestFindReferencesBindingPatternInJsdocNoCrash2
+TestForceIndentAfterNewLineInsert
+TestFormat01
+TestFormatAfterObjectLiteral
+TestFormatArrayLiteralExpression
+TestFormatAsyncClassMethod1
+TestFormatAsyncClassMethod2
+TestFormatColonAndQMark
+TestFormatComments
+TestFormatConflictDiff3Marker1
+TestFormatConflictMarker1
+TestFormatDebuggerStatement
+TestFormatDocumentPreserveTrailingWhitespace
+TestFormatDocumentWithJSDoc
+TestFormatDocumentWithTrivia
+TestFormatDotAfterNumber
+TestFormatEmptyParamList
+TestFormatIfTryCatchBlocks
+TestFormatIfWithEmptyCondition
+TestFormatImplicitModule
+TestFormatMultipleFunctionArguments
+TestFormatNoSpaceAfterTemplateHeadAndMiddle
+TestFormatObjectBindingPattern
+TestFormatOnSemiColonAfterBreak
+TestFormatRemoveNewLineAfterOpenBrace
+TestFormatSpaceAfterImplementsExtends
+TestFormatSpaceAfterTemplateHeadAndMiddle
+TestFormatSpaceBetweenFunctionAndArrayIndex
+TestFormattingAfterMultiLineIfCondition
+TestFormattingAwait
+TestFormattingChainingMethods
+TestFormattingDecorators
+TestFormattingDoubleLessThan
+TestFormattingForIn
+TestFormattingForLoopSemicolons
+TestFormattingForOfKeyword
+TestFormattingGlobalAugmentation2
+TestFormattingInExpressionsInTsx
+TestFormattingJsxTexts2
+TestFormattingJsxTexts3
+TestFormattingJsxTexts4
+TestFormattingMappedType
+TestFormattingMultilineCommentsWithTabs1
+TestFormattingNestedScopes
+TestFormattingNonNullAssertionOperator
+TestFormattingObjectLiteral
+TestFormattingObjectLiteralOpenCurlyNewline
+TestFormattingObjectLiteralOpenCurlyNewlineAssignment
+TestFormattingObjectLiteralOpenCurlyNewlineTyping
+TestFormattingObjectLiteralOpenCurlySingleLine
+TestFormattingOfExportDefault
+TestFormattingOnClasses
+TestFormattingOnClosingBracket
+TestFormattingOnDocumentReadyFunction
+TestFormattingOnDoWhileNoSemicolon
+TestFormattingOnEmptyInterfaceLiteral
+TestFormattingOnInvalidCodes
+TestFormattingOnModuleIndentation
+TestFormattingOnNestedDoWhileByEnter
+TestFormattingOnObjectLiteral
+TestFormattingOnSingleLineBlocks
+TestFormattingOnStatementsWithNoSemicolon
+TestFormattingOnTabAfterCloseCurly
+TestFormattingOnVariety
+TestFormattingReplaceTabsWithSpaces
+TestFormattingSpaceAfterCommaBeforeOpenParen
+TestFormattingSpaceBeforeFunctionParen
+TestFormattingSpaceBetweenParent
+TestFormattingSpacesAfterConstructor
+TestFormattingTemplates
+TestFormattingVoid
+TestFormatTryFinally
+TestFormatTsxClosingAfterJsxText
+TestFormatVariableDeclarationList
+TestFormatWithStatement
+TestFunctionIndentation
+TestFunctionTypePredicateFormatting
 TestGenericCombinators3
 TestGenericCombinatorWithConstraints1
 TestGenericFunctionWithGenericParams1
 TestGenericInterfacesWithConstraints1
+TestGenericsFormattingMultiline
 TestGenericTypeWithMultipleBases1MultiFile
 TestGetJavaScriptCompletions10
 TestGetJavaScriptCompletions12
@@ -285,6 +366,8 @@ TestImportCompletionsPackageJsonImportsPattern_ts_ts
 TestImportCompletionsPackageJsonImportsPattern2
 TestImportFixesGlobalTypingsCache
 TestImportNameCodeFix_avoidRelativeNodeModules
+TestImportNameCodeFix_externalNonRelateive2
+TestImportNameCodeFix_externalNonRelative1
 TestImportNameCodeFix_fileWithNoTrailingNewline
 TestImportNameCodeFix_HeaderComment1
 TestImportNameCodeFix_HeaderComment2
@@ -329,6 +412,7 @@ TestImportTypeCompletions6
 TestImportTypeCompletions7
 TestImportTypeCompletions8
 TestImportTypeCompletions9
+TestIndentationInJsx3
 TestIndexerReturnTypes1
 TestIndirectClassInstantiation
 TestInstanceTypesForGenericType1
@@ -378,11 +462,13 @@ TestMemberListOfExportedClass
 TestMemberListOnContextualThis
 TestModuleNodeNextAutoImport2
 TestModuleNodeNextAutoImport3
+TestMultilineCommentBeforeOpenBrace
 TestNgProxy1
 TestNodeModulesImportCompletions1
 TestNoQuickInfoForLabel
 TestNoQuickInfoInWhitespace
 TestNumericPropertyNames
+TestOptionalPropertyFormatting
 TestOverloadQuickInfo
 TestParameterWithDestructuring
 TestParameterWithNestedDestructuring
@@ -550,11 +636,14 @@ TestRenameFromNodeModulesDep4
 TestRenamePrivateFields
 TestReverseMappedTypeQuickInfo
 TestSelfReferencedExternalModule
+TestSemicolonFormattingNestedStatements
+TestSpaceAfterReturn
 TestStringCompletionsImportOrExportSpecifier
 TestStringCompletionsVsEscaping
 TestSymbolCompletionLowerPriority
 TestSyntheticImportFromBabelGeneratedFile1
 TestSyntheticImportFromBabelGeneratedFile2
+TestTabbingAfterNewlineInsertedBeforeWhile
 TestThisBindingInLambda
 TestThisPredicateFunctionQuickInfo01
 TestThisPredicateFunctionQuickInfo02
@@ -571,3 +660,7 @@ TestTsxQuickInfo5
 TestTsxQuickInfo6
 TestTsxQuickInfo7
 TestTypeOperatorNodeBuilding
+TestUnclosedStringLiteralAutoformating
+TestWhiteSpaceTrimming
+TestWhiteSpaceTrimming2
+TestWhiteSpaceTrimming4