feat: make fixes/suggestions opt-in

Author: camchenry

cmd/tsgolint/headless.go

@@ -63,8 +63,8 @@ type headlessDiagnostic struct {
 	Range       headlessRange        `json:"range"`
 	Rule        string               `json:"rule"`
 	Message     headlessRuleMessage  `json:"message"`
-	Fixes       []headlessFix        `json:"fixes"`
-	Suggestions []headlessSuggestion `json:"suggestions"`
+	Fixes       []headlessFix        `json:"fixes,omitempty"`
+	Suggestions []headlessSuggestion `json:"suggestions,omitempty"`
 	FilePath    string               `json:"file_path"`
 }
 
@@ -102,15 +102,19 @@ func runHeadless(args []string) int {
 	logLevel := utils.GetLogLevel()
 
 	var (
-		traceOut   string
-		cpuprofOut string
-		heapOut    string
-		allocsOut  string
+		traceOut       string
+		cpuprofOut     string
+		heapOut        string
+		allocsOut      string
+		fix            bool
+		fixSuggestions bool
 	)
 	flag.StringVar(&traceOut, "trace", "", "file to put trace to")
 	flag.StringVar(&cpuprofOut, "cpuprof", "", "file to put cpu profiling to")
 	flag.StringVar(&heapOut, "heap", "", "file to put heap profiling to")
 	flag.StringVar(&allocsOut, "allocs", "", "file to put allocs profiling to")
+	flag.BoolVar(&fix, "fix", false, "generate fixes for code problems")
+	flag.BoolVar(&fixSuggestions, "fix-suggestions", false, "generate suggestions for code problems")
 	flag.CommandLine.Parse(args)
 
 	log.SetOutput(os.Stderr)
@@ -236,28 +240,34 @@ func runHeadless(args []string) int {
 				Range:       headlessRangeFromRange(d.Range),
 				Rule:        d.RuleName,
 				Message:     headlessRuleMessageFromRuleMessage(d.Message),
-				Fixes:       make([]headlessFix, len(d.Fixes())),
-				Suggestions: make([]headlessSuggestion, len(d.GetSuggestions())),
+				Fixes:       nil,
+				Suggestions: nil,
 				FilePath:    d.SourceFile.FileName(),
 			}
-			for i, fix := range d.Fixes() {
-				hd.Fixes[i] = headlessFix{
-					Text:  fix.Text,
-					Range: headlessRangeFromRange(fix.Range),
-				}
-			}
-			for i, suggestion := range d.GetSuggestions() {
-				hd.Suggestions[i] = headlessSuggestion{
-					Message: headlessRuleMessageFromRuleMessage(d.Message),
-					Fixes:   make([]headlessFix, len(suggestion.Fixes())),
-				}
-				for j, fix := range suggestion.Fixes() {
-					hd.Suggestions[i].Fixes[j] = headlessFix{
+			if fix {
+				hd.Fixes = make([]headlessFix, len(d.Fixes()))
+				for i, fix := range d.Fixes() {
+					hd.Fixes[i] = headlessFix{
 						Text:  fix.Text,
 						Range: headlessRangeFromRange(fix.Range),
 					}
 				}
 			}
+			if fixSuggestions {
+				hd.Suggestions = make([]headlessSuggestion, len(d.GetSuggestions()))
+				for i, suggestion := range d.GetSuggestions() {
+					hd.Suggestions[i] = headlessSuggestion{
+						Message: headlessRuleMessageFromRuleMessage(d.Message),
+						Fixes:   make([]headlessFix, len(suggestion.Fixes())),
+					}
+					for j, fix := range suggestion.Fixes() {
+						hd.Suggestions[i].Fixes[j] = headlessFix{
+							Text:  fix.Text,
+							Range: headlessRangeFromRange(fix.Range),
+						}
+					}
+				}
+			}
 			writeMessage(w, headlessMessageTypeDiagnostic, hd)
 			if w.Available() < 4096 {
 				w.Flush()
@@ -297,6 +307,10 @@ func runHeadless(args []string) int {
 		func(d rule.RuleDiagnostic) {
 			diagnosticsChan <- d
 		},
+		linter.Fixes{
+			Fix:            fix,
+			FixSuggestions: fixSuggestions,
+		},
 	)
 
 	close(diagnosticsChan)

cmd/tsgolint/main.go

@@ -470,6 +470,10 @@ func runMain() int {
 		func(d rule.RuleDiagnostic) {
 			diagnosticsChan <- d
 		},
+		linter.Fixes{
+			Fix:            true,
+			FixSuggestions: true,
+		},
 	)
 
 	close(diagnosticsChan)

internal/linter/linter.go

@@ -28,7 +28,12 @@ type Workload struct {
 	UnmatchedFiles []string
 }
 
-func RunLinter(logLevel utils.LogLevel, currentDirectory string, workload Workload, workers int, fs vfs.FS, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic)) error {
+type Fixes struct {
+	Fix            bool
+	FixSuggestions bool
+}
+
+func RunLinter(logLevel utils.LogLevel, currentDirectory string, workload Workload, workers int, fs vfs.FS, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic), fixState Fixes) error {
 
 	idx := 0
 	for configFileName, filePaths := range workload.Programs {
@@ -75,7 +80,7 @@ func RunLinter(logLevel utils.LogLevel, currentDirectory string, workload Worklo
 			panic(fmt.Sprintf("Expected file '%s' to be in program '%s'", unmatchedFilesString, configFileName))
 		}
 
-		err = RunLinterOnProgram(logLevel, program, sourceFiles, workers, getRulesForFile, onDiagnostic)
+		err = RunLinterOnProgram(logLevel, program, sourceFiles, workers, getRulesForFile, onDiagnostic, fixState)
 		if err != nil {
 			return err
 		}
@@ -100,7 +105,7 @@ func RunLinter(logLevel utils.LogLevel, currentDirectory string, workload Worklo
 			files = append(files, sf)
 		}
 
-		err = RunLinterOnProgram(logLevel, program, files, workers, getRulesForFile, onDiagnostic)
+		err = RunLinterOnProgram(logLevel, program, files, workers, getRulesForFile, onDiagnostic, fixState)
 		if err != nil {
 			return err
 		}
@@ -110,7 +115,7 @@ func RunLinter(logLevel utils.LogLevel, currentDirectory string, workload Worklo
 
 }
 
-func RunLinterOnProgram(logLevel utils.LogLevel, program *compiler.Program, files []*ast.SourceFile, workers int, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic)) error {
+func RunLinterOnProgram(logLevel utils.LogLevel, program *compiler.Program, files []*ast.SourceFile, workers int, getRulesForFile func(sourceFile *ast.SourceFile) []ConfiguredRule, onDiagnostic func(diagnostic rule.RuleDiagnostic), fixState Fixes) error {
 	type checkerWorkload struct {
 		checker *checker.Checker
 		program *compiler.Program
@@ -162,7 +167,10 @@ func RunLinterOnProgram(logLevel utils.LogLevel, program *compiler.Program, file
 								})
 							},
 							ReportRangeWithSuggestions: func(textRange core.TextRange, msg rule.RuleMessage, suggestionsFn func() []rule.RuleSuggestion) {
-								suggestions := suggestionsFn()
+								var suggestions []rule.RuleSuggestion = nil
+								if fixState.FixSuggestions {
+									suggestions = suggestionsFn()
+								}
 								onDiagnostic(rule.RuleDiagnostic{
 									RuleName:    r.Name,
 									Range:       textRange,
@@ -180,7 +188,10 @@ func RunLinterOnProgram(logLevel utils.LogLevel, program *compiler.Program, file
 								})
 							},
 							ReportNodeWithFixes: func(node *ast.Node, msg rule.RuleMessage, fixesFn func() []rule.RuleFix) {
-								fixes := fixesFn()
+								var fixes []rule.RuleFix = nil
+								if fixState.Fix {
+									fixes = fixesFn()
+								}
 								onDiagnostic(rule.RuleDiagnostic{
 									RuleName:   r.Name,
 									Range:      utils.TrimNodeTextRange(file, node),

internal/rule_tester/rule_tester.go

@@ -97,6 +97,10 @@ func RunRuleTester(rootDir string, tsconfigPath string, t *testing.T, r *rule.Ru
 
 				diagnostics = append(diagnostics, diagnostic)
 			},
+			linter.Fixes{
+				Fix:            true,
+				FixSuggestions: true,
+			},
 		)
 
 		assert.NilError(t, err, "error running linter. code:\n", code)