Add SecondaryMessage lint replacements

Author: jribbink

internal/cadence/lint_test.go

@@ -189,6 +189,33 @@ func Test_Lint(t *testing.T) {
 		)
 	})
 
+	t.Run("generates synthetic replacement for replacement category diagnostics", func(t *testing.T) {
+		t.Parallel()
+
+		state := setupMockState(t)
+
+		results, err := lintFiles(state, "ReplacementHint.cdc")
+		require.NoError(t, err)
+
+		require.Len(t, results.Results, 1)
+		require.Len(t, results.Results[0].Diagnostics, 1)
+
+		diagnostic := results.Results[0].Diagnostics[0]
+
+		// Should have the replacement category
+		require.Equal(t, "replacement-hint", diagnostic.Category)
+
+		// Should have a secondary message with the replacement suggestion
+		require.Equal(t, "consider replacing with:", diagnostic.Message)
+		require.Equal(t, "1.0", diagnostic.SecondaryMessage)
+
+		// Should have synthetic suggested fixes generated from secondary message
+		require.Len(t, diagnostic.SuggestedFixes, 1)
+		require.Equal(t, "consider replacing with: `1.0`", diagnostic.SuggestedFixes[0].Message)
+		require.Len(t, diagnostic.SuggestedFixes[0].TextEdits, 1)
+		require.Equal(t, "1.0", diagnostic.SuggestedFixes[0].TextEdits[0].Replacement)
+	})
+
 	t.Run("linter resolves imports from flowkit state", func(t *testing.T) {
 		t.Parallel()
 
@@ -476,6 +503,12 @@ func setupMockState(t *testing.T) *flowkit.State {
 			qqq
 		}
 	}`), 0644)
+	_ = afero.WriteFile(mockFs, "ReplacementHint.cdc", []byte(`
+	access(all) contract ReplacementHint {
+		access(all) fun test() {
+			let x = UFix64(1)
+		}
+	}`), 0644)
 	_ = afero.WriteFile(mockFs, "CadenceV1Error.cdc", []byte(`
 	access(all) contract CadenceV1Error {
 		init() {

internal/cadence/linter.go

@@ -156,6 +156,28 @@ func (l *linter) lintFile(
 	}
 	analysisProgram.Run(analyzers, report)
 
+	// Generate synthetic replacements for replacement category diagnostics
+	// that don't have suggested fixes
+	for i := range diagnostics {
+		diagnostic := &diagnostics[i]
+		if diagnostic.Category == cdclint.ReplacementCategory &&
+			len(diagnostic.SuggestedFixes) == 0 &&
+			diagnostic.SecondaryMessage != "" {
+			// Create a synthetic suggested fix from the secondary message
+			diagnostic.SuggestedFixes = []cdcerrors.SuggestedFix[ast.TextEdit]{
+				{
+					Message: fmt.Sprintf("%s `%s`", diagnostic.Message, diagnostic.SecondaryMessage),
+					TextEdits: []ast.TextEdit{
+						{
+							Range:       diagnostic.Range,
+							Replacement: diagnostic.SecondaryMessage,
+						},
+					},
+				},
+			}
+		}
+	}
+
 	return diagnostics, nil
 }