chore: add comments about TextEdits positions adjustements

ldez · ldez · commit db85f32c7ebf · 2024-12-17T01:47:23.000+01:00
diff --git a/pkg/goanalysis/runners.go b/pkg/goanalysis/runners.go
@@ -106,6 +106,8 @@ func buildIssues(diags []Diagnostic, linterNameBuilder func(diag *Diagnostic) st
 					end = edit.Pos
 				}
 
+				// To be applied the positions need to be "adjusted" based on the file.
+				// This is the difference between the "displayed" positions and "effective" positions.
 				nsf.TextEdits = append(nsf.TextEdits, analysis.TextEdit{
 					Pos:     token.Pos(diag.File.Offset(edit.Pos)),
 					End:     token.Pos(diag.File.Offset(end)),

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,8 @@ func buildIssues(diags []Diagnostic, linterNameBuilder func(diag *Diagnostic) st`
`106`	`106`	`end = edit.Pos`
`107`	`107`	`}`
`108`	`108`
	`109`	`+ // To be applied the positions need to be "adjusted" based on the file.`
	`110`	`+ // This is the difference between the "displayed" positions and "effective" positions.`
`109`	`111`	`nsf.TextEdits = append(nsf.TextEdits, analysis.TextEdit{`
`110`	`112`	`Pos: token.Pos(diag.File.Offset(edit.Pos)),`
`111`	`113`	`End: token.Pos(diag.File.Offset(end)),`