1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
}
|
