summaryrefslogtreecommitdiff
path: root/vendor/github.com/google/yamlfmt/formatters/basic/features.go
blob: de736f4ff2086b71fe2c26a39fd537fd0a32645f (plain)
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
// 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 basic

import (
	"github.com/braydonk/yaml"
	"github.com/google/yamlfmt"
	"github.com/google/yamlfmt/formatters/basic/anchors"
	"github.com/google/yamlfmt/internal/features"
	"github.com/google/yamlfmt/internal/hotfix"
)

func ConfigureFeaturesFromConfig(config *Config) yamlfmt.FeatureList {
	lineSep, err := config.LineEnding.Separator()
	if err != nil {
		lineSep = "\n"
	}
	configuredFeatures := []yamlfmt.Feature{}
	if config.RetainLineBreaks || config.RetainLineBreaksSingle {
		configuredFeatures = append(
			configuredFeatures,
			hotfix.MakeFeatureRetainLineBreak(lineSep, config.RetainLineBreaksSingle),
		)
	}
	if config.TrimTrailingWhitespace {
		configuredFeatures = append(
			configuredFeatures,
			features.MakeFeatureTrimTrailingWhitespace(lineSep),
		)
	}
	if config.EOFNewline {
		configuredFeatures = append(
			configuredFeatures,
			features.MakeFeatureEOFNewline(lineSep),
		)
	}
	if config.StripDirectives {
		configuredFeatures = append(
			configuredFeatures,
			hotfix.MakeFeatureStripDirectives(lineSep),
		)
	}
	return configuredFeatures
}

// These features will directly use the `yaml.Node` type and
// as such are specific to this formatter.
type YAMLFeatureFunc func(yaml.Node) error
type YAMLFeatureList []YAMLFeatureFunc

func (y YAMLFeatureList) ApplyFeatures(node yaml.Node) error {
	for _, f := range y {
		if err := f(node); err != nil {
			return err
		}
	}
	return nil
}

func ConfigureYAMLFeaturesFromConfig(config *Config) YAMLFeatureList {
	var features YAMLFeatureList
	if config.DisallowAnchors {
		features = append(features, anchors.Check)
	}
	return features
}