summaryrefslogtreecommitdiff
path: root/vendor/github.com/google/yamlfmt/engine
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/google/yamlfmt/engine')
-rw-r--r--vendor/github.com/google/yamlfmt/engine/consecutive_engine.go116
-rw-r--r--vendor/github.com/google/yamlfmt/engine/errors.go40
-rw-r--r--vendor/github.com/google/yamlfmt/engine/output.go148
3 files changed, 304 insertions, 0 deletions
diff --git a/vendor/github.com/google/yamlfmt/engine/consecutive_engine.go b/vendor/github.com/google/yamlfmt/engine/consecutive_engine.go
new file mode 100644
index 00000000..1ec241a2
--- /dev/null
+++ b/vendor/github.com/google/yamlfmt/engine/consecutive_engine.go
@@ -0,0 +1,116 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package engine
+
+import (
+ "fmt"
+ "os"
+
+ "github.com/google/yamlfmt"
+ "github.com/google/yamlfmt/internal/logger"
+)
+
+// Engine that will process each file one by one consecutively.
+type ConsecutiveEngine struct {
+ LineSepCharacter string
+ Formatter yamlfmt.Formatter
+ ContinueOnError bool
+ OutputFormat EngineOutputFormat
+ Quiet bool
+ Verbose bool
+}
+
+func (e *ConsecutiveEngine) FormatContent(content []byte) ([]byte, error) {
+ return e.Formatter.Format(content)
+}
+
+func (e *ConsecutiveEngine) Format(paths []string) (fmt.Stringer, error) {
+ formatDiffs, formatErrs := e.formatAll(paths)
+
+ // Debug format diff output.
+ logger.Debug(
+ logger.DebugCodeDiffs,
+ fmt.Sprintf("The following files were modified:\n%s", formatDiffs.StrOutput()),
+ )
+
+ if len(formatErrs) > 0 {
+ if e.ContinueOnError {
+ fmt.Print(formatErrs)
+ fmt.Println("Continuing...")
+ } else {
+ return nil, formatErrs
+ }
+ }
+ applyErr := formatDiffs.ApplyAll()
+ if applyErr != nil {
+ return nil, applyErr
+ }
+ return getEngineOutput(e.OutputFormat, yamlfmt.OperationFormat, formatDiffs, e.Quiet, e.Verbose)
+}
+
+func (e *ConsecutiveEngine) Lint(paths []string) (fmt.Stringer, error) {
+ formatDiffs, formatErrs := e.formatAll(paths)
+ if len(formatErrs) > 0 {
+ return nil, formatErrs
+ }
+ if formatDiffs.ChangedCount() == 0 {
+ return nil, nil
+ }
+ return getEngineOutput(e.OutputFormat, yamlfmt.OperationLint, formatDiffs, e.Quiet, e.Verbose)
+}
+
+func (e *ConsecutiveEngine) DryRun(paths []string) (fmt.Stringer, error) {
+ formatDiffs, formatErrs := e.formatAll(paths)
+ if len(formatErrs) > 0 {
+ return nil, formatErrs
+ }
+ if formatDiffs.ChangedCount() == 0 {
+ return nil, nil
+ }
+ return getEngineOutput(e.OutputFormat, yamlfmt.OperationDry, formatDiffs, e.Quiet, e.Verbose)
+}
+
+func (e *ConsecutiveEngine) formatAll(paths []string) (yamlfmt.FileDiffs, FormatErrors) {
+ formatDiffs := yamlfmt.FileDiffs{}
+ formatErrs := FormatErrors{}
+ for _, path := range paths {
+ fileDiff, err := e.formatFileContent(path)
+ if err != nil {
+ formatErrs = append(formatErrs, wrapFormatError(path, err))
+ continue
+ }
+ formatDiffs.Add(fileDiff)
+ }
+ return formatDiffs, formatErrs
+}
+
+func (e *ConsecutiveEngine) formatFileContent(path string) (*yamlfmt.FileDiff, error) {
+ content, err := os.ReadFile(path)
+ if err != nil {
+ return nil, err
+ }
+ formatted, err := e.FormatContent(content)
+ if err != nil {
+ return nil, err
+ }
+ return &yamlfmt.FileDiff{
+ Path: path,
+ Diff: &yamlfmt.FormatDiff{
+ Original: string(content),
+ Formatted: string(formatted),
+ LineSep: e.LineSepCharacter,
+ },
+ }, nil
+}
diff --git a/vendor/github.com/google/yamlfmt/engine/errors.go b/vendor/github.com/google/yamlfmt/engine/errors.go
new file mode 100644
index 00000000..27dbba15
--- /dev/null
+++ b/vendor/github.com/google/yamlfmt/engine/errors.go
@@ -0,0 +1,40 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package engine
+
+import "fmt"
+
+type FormatErrors []*FormatError
+
+func (e FormatErrors) Error() string {
+ errStr := "encountered the following formatting errors:\n"
+ for _, err := range e {
+ errStr += fmt.Sprintf("%s\n", err.Error())
+ }
+ return errStr
+}
+
+type FormatError struct {
+ path string
+ err error
+}
+
+func wrapFormatError(path string, err error) *FormatError {
+ return &FormatError{path: path, err: err}
+}
+
+func (e *FormatError) Error() string {
+ return fmt.Sprintf("%s: %v", e.path, e.err)
+}
diff --git a/vendor/github.com/google/yamlfmt/engine/output.go b/vendor/github.com/google/yamlfmt/engine/output.go
new file mode 100644
index 00000000..c6a2e9e2
--- /dev/null
+++ b/vendor/github.com/google/yamlfmt/engine/output.go
@@ -0,0 +1,148 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package engine
+
+import (
+ "encoding/json"
+ "fmt"
+ "sort"
+ "strings"
+
+ "github.com/google/yamlfmt"
+ "github.com/google/yamlfmt/internal/gitlab"
+)
+
+type EngineOutputFormat string
+
+const (
+ EngineOutputDefault EngineOutputFormat = "default"
+ EngineOutputSingeLine EngineOutputFormat = "line"
+ EngineOutputGitlab EngineOutputFormat = "gitlab"
+)
+
+func getEngineOutput(t EngineOutputFormat, operation yamlfmt.Operation, files yamlfmt.FileDiffs, quiet bool, verbose bool) (fmt.Stringer, error) {
+ switch t {
+ case EngineOutputDefault:
+ return engineOutput{Operation: operation, Files: files, Quiet: quiet, Verbose: verbose}, nil
+ case EngineOutputSingeLine:
+ return engineOutputSingleLine{Operation: operation, Files: files, Quiet: quiet}, nil
+ case EngineOutputGitlab:
+ return engineOutputGitlab{Operation: operation, Files: files, Compact: quiet}, nil
+
+ }
+ return nil, fmt.Errorf("unknown output type: %s", t)
+}
+
+type engineOutput struct {
+ Operation yamlfmt.Operation
+ Files yamlfmt.FileDiffs
+ Quiet bool
+ Verbose bool
+}
+
+func (eo engineOutput) String() string {
+ var msg string
+ switch eo.Operation {
+ case yamlfmt.OperationFormat:
+ // Formatting only produces output in verbose mode.
+ if !eo.Verbose {
+ return ""
+ }
+
+ msg = "The following files were modified:\n"
+ msg += eo.Files.StrOutputQuiet()
+ return msg
+ case yamlfmt.OperationLint:
+ msg = "The following formatting differences were found:"
+ if eo.Quiet {
+ msg = "The following files had formatting differences:"
+ }
+ case yamlfmt.OperationDry:
+ if len(eo.Files) > 0 {
+ if eo.Quiet {
+ msg = "The following files would be formatted:"
+ }
+ } else {
+ return "No files will be formatted."
+ }
+ }
+ var result string
+ if msg != "" {
+ result += fmt.Sprintf("%s\n\n", msg)
+ }
+ if eo.Quiet {
+ result += eo.Files.StrOutputQuiet()
+ } else {
+ result += fmt.Sprintf("%s\n", eo.Files.StrOutput())
+ }
+ return result
+}
+
+type engineOutputSingleLine struct {
+ Operation yamlfmt.Operation
+ Files yamlfmt.FileDiffs
+ Quiet bool
+}
+
+func (eosl engineOutputSingleLine) String() string {
+ var msg string
+ for _, fileDiff := range eosl.Files {
+ msg += fmt.Sprintf("%s: formatting difference found\n", fileDiff.Path)
+ }
+ return msg
+}
+
+type engineOutputGitlab struct {
+ Operation yamlfmt.Operation
+ Files yamlfmt.FileDiffs
+ Compact bool
+}
+
+func (eo engineOutputGitlab) String() string {
+ var findings []gitlab.CodeQuality
+
+ for _, file := range eo.Files {
+ if cq, ok := gitlab.NewCodeQuality(*file); ok {
+ findings = append(findings, cq)
+ }
+ }
+
+ if len(findings) == 0 {
+ return ""
+ }
+
+ sort.Sort(byPath(findings))
+
+ var b strings.Builder
+ enc := json.NewEncoder(&b)
+
+ if !eo.Compact {
+ enc.SetIndent("", " ")
+ }
+
+ if err := enc.Encode(findings); err != nil {
+ panic(err)
+ }
+ return b.String()
+}
+
+// byPath is used to sort by Location.Path.
+type byPath []gitlab.CodeQuality
+
+func (b byPath) Len() int { return len(b) }
+func (b byPath) Less(i, j int) bool { return b[i].Location.Path < b[j].Location.Path }
+func (b byPath) Swap(i, j int) {
+ b[i].Location.Path, b[j].Location.Path = b[j].Location.Path, b[i].Location.Path
+}
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-02 08:29:50 +0000