diagnostic back

Author: sahar-azizighannad

stack_diagnostic.go

@@ -0,0 +1,48 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tfe
+
+// StackDiagnostic represents any sourcebundle.Diagnostic value. The simplest form has
+// just a severity, single line summary, and optional detail. If there is more
+// information about the source of the diagnostic, this is represented in the
+// range field.
+type StackDiagnostic struct {
+	Severity string           `jsonapi:"attr,severity"`
+	Summary  string           `jsonapi:"attr,summary"`
+	Detail   string           `jsonapi:"attr,detail"`
+	Range    *DiagnosticRange `jsonapi:"attr,range"`
+}
+
+// DiagnosticPos represents a position in the source code.
+type DiagnosticPos struct {
+	// Line is a one-based count for the line in the indicated file.
+	Line int `jsonapi:"attr,line"`
+
+	// Column is a one-based count of Unicode characters from the start of the line.
+	Column int `jsonapi:"attr,column"`
+
+	// Byte is a zero-based offset into the indicated file.
+	Byte int `jsonapi:"attr,byte"`
+}
+
+// DiagnosticRange represents the filename and position of the diagnostic
+// subject. This defines the range of the source to be highlighted in the
+// output. Note that the snippet may include additional surrounding source code
+// if the diagnostic has a context range.
+//
+// The stacks-specific source field represents the full source bundle address
+// of the file, while the filename field is the sub path relative to its
+// enclosing package. This represents an attempt to be somewhat backwards
+// compatible with the existing Terraform JSON diagnostic format, where
+// filename is root module relative.
+//
+// The Start position is inclusive, and the End position is exclusive. Exact
+// positions are intended for highlighting for human interpretation only and
+// are subject to change.
+type DiagnosticRange struct {
+	Filename string        `jsonapi:"attr,filename"`
+	Source   string        `jsonapi:"attr,source"`
+	Start    DiagnosticPos `jsonapi:"attr,start"`
+	End      DiagnosticPos `jsonapi:"attr,end"`
+}