Included diagnostics in scip snapshot output

bindings/go/scip/testutil/format.go

@@ -17,6 +17,7 @@ import (
 // that is suitable for snapshot testing.
 func FormatSnapshots(
 	index *scip.Index,
+	includeDiagnostics bool,
 	commentSyntax string,
 	symbolFormatter scip.SymbolFormatter,
 	customProjectRoot string,
@@ -40,7 +41,7 @@ func FormatSnapshots(
 	var documentErrors error
 	for _, document := range index.Documents {
 		sourceFilePath := filepath.Join(localSourcesRoot, document.RelativePath)
-		snapshot, err := FormatSnapshot(document, index, commentSyntax, symbolFormatter, sourceFilePath)
+		snapshot, err := FormatSnapshot(document, index, includeDiagnostics, commentSyntax, symbolFormatter, sourceFilePath)
 		err = symbolFormatter.OnError(err)
 		if err != nil {
 			documentErrors = errors.CombineErrors(
@@ -65,6 +66,7 @@ func FormatSnapshots(
 func FormatSnapshot(
 	document *scip.Document,
 	index *scip.Index,
+	includeDiagnostics bool,
 	commentSyntax string,
 	formatter scip.SymbolFormatter,
 	sourceFilePath string,
@@ -152,6 +154,14 @@ func FormatSnapshot(
 				}
 			}
 
+			if includeDiagnostics {
+				for _, diagnostic := range occ.Diagnostics {
+					b.WriteString(prefix)
+					b.WriteString("diagnostic ")
+					b.WriteString(diagnostic.Code)
+				}
+			}
+
 			b.WriteString("\n")
 			i++
 		}

cmd/scip/main_test.go

@@ -92,7 +92,7 @@ func TestSCIPSnapshots(t *testing.T) {
 		require.Nil(t, err)
 		symbolFormatter := scip.DescriptorOnlyFormatter
 		symbolFormatter.IncludePackageName = func(name string) bool { return name != testName }
-		snapshots, err := testutil.FormatSnapshots(index, "#", symbolFormatter, inputDirectory)
+		snapshots, err := testutil.FormatSnapshots(index, false, "#", symbolFormatter, inputDirectory)
 		require.Nil(t, err)
 		if debugSnapshotAbspaths != nil && *debugSnapshotAbspaths {
 			inputDirAbsPath, err := filepath.Abs(inputDirectory)

cmd/scip/snapshot.go

@@ -13,11 +13,12 @@ import (
 )
 
 type snapshotFlags struct {
-	from              string
-	output            string
-	customProjectRoot string
-	strict            bool
-	commentSyntax     string
+	from               string
+	output             string
+	includeDiagnostics bool
+	customProjectRoot  string
+	strict             bool
+	commentSyntax      string
 }
 
 func snapshotCommand() cli.Command {
@@ -44,6 +45,12 @@ and symbol information.`,
 				Destination: &snapshotFlags.strict,
 				Value:       true,
 			},
+			&cli.BoolFlag{
+				Name:        "include-diagnostics",
+				Usage:       "Whether or not to include scip diagnostics in snapshot files",
+				Destination: &snapshotFlags.includeDiagnostics,
+				Value:       false,
+			},
 			&cli.StringFlag{
 				Name:        "comment-syntax",
 				Usage:       "Comment syntax to use for snapshot files",
@@ -76,7 +83,7 @@ func snapshotMain(flags snapshotFlags) error {
 			return errors.Wrap(err, "use --strict=false to ignore this error")
 		}
 	}
-	snapshots, err := testutil.FormatSnapshots(index, flags.commentSyntax, symbolFormatter, flags.customProjectRoot)
+	snapshots, err := testutil.FormatSnapshots(index, flags.includeDiagnostics, flags.commentSyntax, symbolFormatter, flags.customProjectRoot)
 	if err != nil {
 		return err
 	}

docs/CLI.md

@@ -107,6 +107,7 @@ OPTIONS:
    --to value              Path to output directory for snapshot files (default: "scip-snapshot")
    --project-root value    Override project root in the SCIP file. For example, this can be helpful when the SCIP index was created inside a Docker image or created on another computer
    --strict                If true, fail fast on errors (default: true)
+   --include-diagnostics   Whether or not to include scip diagnostics in snapshot files (default: false)
    --comment-syntax value  Comment syntax to use for snapshot files (default: "//")
 ```