Skip to content

Port baseline diagnostics tests #2097

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
merged 4 commits into from
Nov 17, 2025
Merged

Port baseline diagnostics tests #2097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a302914
implement diagnostic baselining in fourslash
gabritto Nov 14, 2025
4f25845
remove commented out
gabritto Nov 14, 2025
b587710
Merge branch 'main' into gabritto/testdiagnostics2
gabritto Nov 14, 2025
8ffc4cf
rename types in fourslash
gabritto Nov 14, 2025
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
161 changes: 123 additions & 38 deletions internal/diagnosticwriter/diagnosticwriter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,87 @@ import (
"github.com/microsoft/typescript-go/internal/tspath"
)

type FileLike interface {
FileName() string
Text() string
ECMALineMap() []core.TextPos
}

// Diagnostic interface abstracts over ast.Diagnostic and LSP diagnostics
type Diagnostic interface {
File() FileLike
Pos() int
End() int
Len() int
Code() int32
Category() diagnostics.Category
Message() string
MessageChain() []Diagnostic
RelatedInformation() []Diagnostic
}

// ASTDiagnostic wraps ast.Diagnostic to implement the Diagnostic interface
type ASTDiagnostic struct {
*ast.Diagnostic
}

func (d *ASTDiagnostic) RelatedInformation() []Diagnostic {
related := d.Diagnostic.RelatedInformation()
result := make([]Diagnostic, len(related))
for i, r := range related {
result[i] = &ASTDiagnostic{r}
}
return result
}

func (d *ASTDiagnostic) File() FileLike {
if file := d.Diagnostic.File(); file != nil {
return file
}
return nil
}

func (d *ASTDiagnostic) MessageChain() []Diagnostic {
chain := d.Diagnostic.MessageChain()
result := make([]Diagnostic, len(chain))
for i, c := range chain {
result[i] = &ASTDiagnostic{c}
}
return result
}

func WrapASTDiagnostic(d *ast.Diagnostic) *ASTDiagnostic {
return &ASTDiagnostic{d}
}

func WrapASTDiagnostics(diags []*ast.Diagnostic) []*ASTDiagnostic {
result := make([]*ASTDiagnostic, len(diags))
for i, d := range diags {
result[i] = WrapASTDiagnostic(d)
}
return result
}

func FromASTDiagnostics(diags []*ast.Diagnostic) []Diagnostic {
result := make([]Diagnostic, len(diags))
for i, d := range diags {
result[i] = WrapASTDiagnostic(d)
}
return result
}

func ToDiagnostics[T Diagnostic](diags []T) []Diagnostic {
result := make([]Diagnostic, len(diags))
for i, d := range diags {
result[i] = d
}
return result
}

func CompareASTDiagnostics(a, b *ASTDiagnostic) int {
return ast.CompareDiagnostics(a.Diagnostic, b.Diagnostic)
}

type FormattingOptions struct {
tspath.ComparePathsOptions
NewLine string
Expand All @@ -36,7 +117,7 @@ const (
ellipsis = "..."
)

func FormatDiagnosticsWithColorAndContext(output io.Writer, diags []*ast.Diagnostic, formatOpts *FormattingOptions) {
func FormatDiagnosticsWithColorAndContext(output io.Writer, diags []Diagnostic, formatOpts *FormattingOptions) {
if len(diags) == 0 {
return
}
Expand All @@ -48,10 +129,10 @@ func FormatDiagnosticsWithColorAndContext(output io.Writer, diags []*ast.Diagnos
}
}

func FormatDiagnosticWithColorAndContext(output io.Writer, diagnostic *ast.Diagnostic, formatOpts *FormattingOptions) {
func FormatDiagnosticWithColorAndContext(output io.Writer, diagnostic Diagnostic, formatOpts *FormattingOptions) {
if diagnostic.File() != nil {
file := diagnostic.File()
pos := diagnostic.Loc().Pos()
pos := diagnostic.Pos()
WriteLocation(output, file, pos, formatOpts, writeWithStyleAndReset)
fmt.Fprint(output, " - ")
}
Expand Down Expand Up @@ -83,7 +164,7 @@ func FormatDiagnosticWithColorAndContext(output io.Writer, diagnostic *ast.Diagn
}
}

func writeCodeSnippet(writer io.Writer, sourceFile *ast.SourceFile, start int, length int, squiggleColor string, indent string, formatOpts *FormattingOptions) {
func writeCodeSnippet(writer io.Writer, sourceFile FileLike, start int, length int, squiggleColor string, indent string, formatOpts *FormattingOptions) {
firstLine, firstLineChar := scanner.GetECMALineAndCharacterOfPosition(sourceFile, start)
lastLine, lastLineChar := scanner.GetECMALineAndCharacterOfPosition(sourceFile, start+length)
if length == 0 {
Expand Down Expand Up @@ -118,7 +199,7 @@ func writeCodeSnippet(writer io.Writer, sourceFile *ast.SourceFile, start int, l
if i < lastLineOfFile {
lineEnd = scanner.GetECMAPositionOfLineAndCharacter(sourceFile, i+1, 0)
} else {
lineEnd = sourceFile.Loc.End()
lineEnd = len(sourceFile.Text())
}

lineContent := strings.TrimRightFunc(sourceFile.Text()[lineStart:lineEnd], unicode.IsSpace) // trim from end
Expand Down Expand Up @@ -167,21 +248,25 @@ func writeCodeSnippet(writer io.Writer, sourceFile *ast.SourceFile, start int, l
}
}

func FlattenDiagnosticMessage(d *ast.Diagnostic, newLine string) string {
func FlattenDiagnosticMessage(d Diagnostic, newLine string) string {
var output strings.Builder
WriteFlattenedDiagnosticMessage(&output, d, newLine)
return output.String()
}

func WriteFlattenedDiagnosticMessage(writer io.Writer, diagnostic *ast.Diagnostic, newline string) {
func WriteFlattenedASTDiagnosticMessage(writer io.Writer, diagnostic *ast.Diagnostic, newline string) {
WriteFlattenedDiagnosticMessage(writer, WrapASTDiagnostic(diagnostic), newline)
}

func WriteFlattenedDiagnosticMessage(writer io.Writer, diagnostic Diagnostic, newline string) {
fmt.Fprint(writer, diagnostic.Message())

for _, chain := range diagnostic.MessageChain() {
flattenDiagnosticMessageChain(writer, chain, newline, 1 /*level*/)
}
}

func flattenDiagnosticMessageChain(writer io.Writer, chain *ast.Diagnostic, newLine string, level int) {
func flattenDiagnosticMessageChain(writer io.Writer, chain Diagnostic, newLine string, level int) {
fmt.Fprint(writer, newLine)
for range level {
fmt.Fprint(writer, " ")
Expand Down Expand Up @@ -215,7 +300,7 @@ func writeWithStyleAndReset(output io.Writer, text string, formatStyle string) {
fmt.Fprint(output, resetEscapeSequence)
}

func WriteLocation(output io.Writer, file *ast.SourceFile, pos int, formatOpts *FormattingOptions, writeWithStyleAndReset FormattedWriter) {
func WriteLocation(output io.Writer, file FileLike, pos int, formatOpts *FormattingOptions, writeWithStyleAndReset FormattedWriter) {
firstLine, firstChar := scanner.GetECMALineAndCharacterOfPosition(file, pos)
var relativeFileName string
if formatOpts != nil {
Expand All @@ -235,12 +320,12 @@ func WriteLocation(output io.Writer, file *ast.SourceFile, pos int, formatOpts *

type ErrorSummary struct {
TotalErrorCount int
GlobalErrors []*ast.Diagnostic
ErrorsByFiles map[*ast.SourceFile][]*ast.Diagnostic
SortedFileList []*ast.SourceFile
GlobalErrors []Diagnostic
ErrorsByFile map[FileLike][]Diagnostic
SortedFiles []FileLike
}

func WriteErrorSummaryText(output io.Writer, allDiagnostics []*ast.Diagnostic, formatOpts *FormattingOptions) {
func WriteErrorSummaryText(output io.Writer, allDiagnostics []Diagnostic, formatOpts *FormattingOptions) {
// Roughly corresponds to 'getErrorSummaryText' from watch.ts

errorSummary := getErrorSummary(allDiagnostics)
Expand All @@ -249,12 +334,12 @@ func WriteErrorSummaryText(output io.Writer, allDiagnostics []*ast.Diagnostic, f
return
}

firstFile := &ast.SourceFile{}
if len(errorSummary.SortedFileList) > 0 {
firstFile = errorSummary.SortedFileList[0]
var firstFile FileLike
if len(errorSummary.SortedFiles) > 0 {
firstFile = errorSummary.SortedFiles[0]
}
firstFileName := prettyPathForFileError(firstFile, errorSummary.ErrorsByFiles[firstFile], formatOpts)
numErroringFiles := len(errorSummary.ErrorsByFiles)
firstFileName := prettyPathForFileError(firstFile, errorSummary.ErrorsByFile[firstFile], formatOpts)
numErroringFiles := len(errorSummary.ErrorsByFile)

var message string
if totalErrorCount == 1 {
Expand Down Expand Up @@ -287,10 +372,10 @@ func WriteErrorSummaryText(output io.Writer, allDiagnostics []*ast.Diagnostic, f
}
}

func getErrorSummary(diags []*ast.Diagnostic) *ErrorSummary {
func getErrorSummary(diags []Diagnostic) *ErrorSummary {
var totalErrorCount int
var globalErrors []*ast.Diagnostic
var errorsByFiles map[*ast.SourceFile][]*ast.Diagnostic
var globalErrors []Diagnostic
var errorsByFile map[FileLike][]Diagnostic

for _, diagnostic := range diags {
if diagnostic.Category() != diagnostics.CategoryError {
Expand All @@ -301,32 +386,32 @@ func getErrorSummary(diags []*ast.Diagnostic) *ErrorSummary {
if diagnostic.File() == nil {
globalErrors = append(globalErrors, diagnostic)
} else {
if errorsByFiles == nil {
errorsByFiles = make(map[*ast.SourceFile][]*ast.Diagnostic)
if errorsByFile == nil {
errorsByFile = make(map[FileLike][]Diagnostic)
}
errorsByFiles[diagnostic.File()] = append(errorsByFiles[diagnostic.File()], diagnostic)
errorsByFile[diagnostic.File()] = append(errorsByFile[diagnostic.File()], diagnostic)
}
}

// !!!
// Need an ordered map here, but sorting for consistency.
sortedFileList := slices.SortedFunc(maps.Keys(errorsByFiles), func(a, b *ast.SourceFile) int {
sortedFiles := slices.SortedFunc(maps.Keys(errorsByFile), func(a, b FileLike) int {
return strings.Compare(a.FileName(), b.FileName())
})

return &ErrorSummary{
TotalErrorCount: totalErrorCount,
GlobalErrors: globalErrors,
ErrorsByFiles: errorsByFiles,
SortedFileList: sortedFileList,
ErrorsByFile: errorsByFile,
SortedFiles: sortedFiles,
}
}

func writeTabularErrorsDisplay(output io.Writer, errorSummary *ErrorSummary, formatOpts *FormattingOptions) {
sortedFiles := errorSummary.SortedFileList
sortedFiles := errorSummary.SortedFiles

maxErrors := 0
for _, errorsForFile := range errorSummary.ErrorsByFiles {
for _, errorsForFile := range errorSummary.ErrorsByFile {
maxErrors = max(maxErrors, len(errorsForFile))
}

Expand All @@ -344,7 +429,7 @@ func writeTabularErrorsDisplay(output io.Writer, errorSummary *ErrorSummary, for
fmt.Fprint(output, formatOpts.NewLine)

for _, file := range sortedFiles {
fileErrors := errorSummary.ErrorsByFiles[file]
fileErrors := errorSummary.ErrorsByFile[file]
errorCount := len(fileErrors)

fmt.Fprintf(output, "%*d ", leftPaddingGoal, errorCount)
Expand All @@ -353,11 +438,11 @@ func writeTabularErrorsDisplay(output io.Writer, errorSummary *ErrorSummary, for
}
}

func prettyPathForFileError(file *ast.SourceFile, fileErrors []*ast.Diagnostic, formatOpts *FormattingOptions) string {
func prettyPathForFileError(file FileLike, fileErrors []Diagnostic, formatOpts *FormattingOptions) string {
if file == nil || len(fileErrors) == 0 {
return ""
}
line := scanner.GetECMALineOfPosition(file, fileErrors[0].Loc().Pos())
line := scanner.GetECMALineOfPosition(file, fileErrors[0].Pos())
fileName := file.FileName()
if tspath.PathIsAbsolute(fileName) && tspath.PathIsAbsolute(formatOpts.CurrentDirectory) {
fileName = tspath.ConvertToRelativePath(file.FileName(), formatOpts.ComparePathsOptions)
Expand All @@ -370,15 +455,15 @@ func prettyPathForFileError(file *ast.SourceFile, fileErrors []*ast.Diagnostic,
)
}

func WriteFormatDiagnostics(output io.Writer, diagnostics []*ast.Diagnostic, formatOpts *FormattingOptions) {
func WriteFormatDiagnostics(output io.Writer, diagnostics []Diagnostic, formatOpts *FormattingOptions) {
for _, diagnostic := range diagnostics {
WriteFormatDiagnostic(output, diagnostic, formatOpts)
}
}

func WriteFormatDiagnostic(output io.Writer, diagnostic *ast.Diagnostic, formatOpts *FormattingOptions) {
func WriteFormatDiagnostic(output io.Writer, diagnostic Diagnostic, formatOpts *FormattingOptions) {
if diagnostic.File() != nil {
line, character := scanner.GetECMALineAndCharacterOfPosition(diagnostic.File(), diagnostic.Loc().Pos())
line, character := scanner.GetECMALineAndCharacterOfPosition(diagnostic.File(), diagnostic.Pos())
fileName := diagnostic.File().FileName()
relativeFileName := tspath.ConvertToRelativePath(fileName, formatOpts.ComparePathsOptions)
fmt.Fprintf(output, "%s(%d,%d): ", relativeFileName, line+1, character+1)
Expand All @@ -389,14 +474,14 @@ func WriteFormatDiagnostic(output io.Writer, diagnostic *ast.Diagnostic, formatO
fmt.Fprint(output, formatOpts.NewLine)
}

func FormatDiagnosticsStatusWithColorAndTime(output io.Writer, time string, diag *ast.Diagnostic, formatOpts *FormattingOptions) {
func FormatDiagnosticsStatusWithColorAndTime(output io.Writer, time string, diag Diagnostic, formatOpts *FormattingOptions) {
fmt.Fprint(output, "[")
writeWithStyleAndReset(output, time, foregroundColorEscapeGrey)
fmt.Fprint(output, "] ")
WriteFlattenedDiagnosticMessage(output, diag, formatOpts.NewLine)
}

func FormatDiagnosticsStatusAndTime(output io.Writer, time string, diag *ast.Diagnostic, formatOpts *FormattingOptions) {
func FormatDiagnosticsStatusAndTime(output io.Writer, time string, diag Diagnostic, formatOpts *FormattingOptions) {
fmt.Fprint(output, time, " - ")
WriteFlattenedDiagnosticMessage(output, diag, formatOpts.NewLine)
}
Expand All @@ -406,7 +491,7 @@ var ScreenStartingCodes = []int32{
diagnostics.File_change_detected_Starting_incremental_compilation.Code(),
}

func TryClearScreen(output io.Writer, diag *ast.Diagnostic, options *core.CompilerOptions) bool {
func TryClearScreen(output io.Writer, diag Diagnostic, options *core.CompilerOptions) bool {
if !options.PreserveWatchOutput.IsTrue() &&
!options.ExtendedDiagnostics.IsTrue() &&
!options.Diagnostics.IsTrue() &&
Expand Down
14 changes: 8 additions & 6 deletions internal/execute/tsc/diagnostics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ func CreateDiagnosticReporter(sys System, w io.Writer, options *core.CompilerOpt
formatOpts := getFormatOptsOfSys(sys)
if shouldBePretty(sys, options) {
return func(diagnostic *ast.Diagnostic) {
diagnosticwriter.FormatDiagnosticWithColorAndContext(w, diagnostic, formatOpts)
diagnosticwriter.FormatDiagnosticWithColorAndContext(w, diagnosticwriter.WrapASTDiagnostic(diagnostic), formatOpts)
fmt.Fprint(w, formatOpts.NewLine)
}
}
return func(diagnostic *ast.Diagnostic) {
diagnosticwriter.WriteFormatDiagnostic(w, diagnostic, formatOpts)
diagnosticwriter.WriteFormatDiagnostic(w, diagnosticwriter.WrapASTDiagnostic(diagnostic), formatOpts)
}
}

Expand Down Expand Up @@ -127,7 +127,7 @@ func CreateReportErrorSummary(sys System, options *core.CompilerOptions) Diagnos
if shouldBePretty(sys, options) {
formatOpts := getFormatOptsOfSys(sys)
return func(diagnostics []*ast.Diagnostic) {
diagnosticwriter.WriteErrorSummaryText(sys.Writer(), diagnostics, formatOpts)
diagnosticwriter.WriteErrorSummaryText(sys.Writer(), diagnosticwriter.FromASTDiagnostics(diagnostics), formatOpts)
}
}
return QuietDiagnosticsReporter
Expand All @@ -141,11 +141,12 @@ func CreateBuilderStatusReporter(sys System, w io.Writer, options *core.Compiler
formatOpts := getFormatOptsOfSys(sys)
writeStatus := core.IfElse(shouldBePretty(sys, options), diagnosticwriter.FormatDiagnosticsStatusWithColorAndTime, diagnosticwriter.FormatDiagnosticsStatusAndTime)
return func(diagnostic *ast.Diagnostic) {
writerDiagnostic := diagnosticwriter.WrapASTDiagnostic(diagnostic)
if testing != nil {
testing.OnBuildStatusReportStart(w)
defer testing.OnBuildStatusReportEnd(w)
}
writeStatus(w, sys.Now().Format("03:04:05 PM"), diagnostic, formatOpts)
writeStatus(w, sys.Now().Format("03:04:05 PM"), writerDiagnostic, formatOpts)
fmt.Fprint(w, formatOpts.NewLine, formatOpts.NewLine)
}
}
Expand All @@ -154,13 +155,14 @@ func CreateWatchStatusReporter(sys System, options *core.CompilerOptions, testin
formatOpts := getFormatOptsOfSys(sys)
writeStatus := core.IfElse(shouldBePretty(sys, options), diagnosticwriter.FormatDiagnosticsStatusWithColorAndTime, diagnosticwriter.FormatDiagnosticsStatusAndTime)
return func(diagnostic *ast.Diagnostic) {
writerDiagnostic := diagnosticwriter.WrapASTDiagnostic(diagnostic)
writer := sys.Writer()
if testing != nil {
testing.OnWatchStatusReportStart()
defer testing.OnWatchStatusReportEnd()
}
diagnosticwriter.TryClearScreen(writer, diagnostic, options)
writeStatus(writer, sys.Now().Format("03:04:05 PM"), diagnostic, formatOpts)
diagnosticwriter.TryClearScreen(writer, writerDiagnostic, options)
writeStatus(writer, sys.Now().Format("03:04:05 PM"), writerDiagnostic, formatOpts)
fmt.Fprint(writer, formatOpts.NewLine, formatOpts.NewLine)
}
}
Loading