forked from ribice/glice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
overrides_file.go
65 lines (55 loc) · 1.84 KB
/
overrides_file.go
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
package glice
import (
"path/filepath"
"strings"
)
const (
OverridesFilename = "overrides.yaml"
OverridesNotes = "This note is auto-generated by 'glice audit --overrides'.\n" +
"\n" +
"The contents of this YAML file should be manually edited and verified\n" +
"before being copied into 'glice.yaml', this file deleted, then your\n" +
"'glice.yaml' should be committed to your project's Git repo.\n" +
"\n" +
"Also be sure to change any license from 'NOASSERTION' to the correct\n" +
"license upon discovering what this dependency's license actually is.\n" +
"\n" +
"And for other licenses you choose to override that are not in the list\n" +
"of allowed licenses se sure to include a note for the dependency about\n" +
"why you are overriding license compliance, and also if you plan for\n" +
"the override to just be TEMPORARY, and if so be sure to specify the\n" +
"criteria to be satisfied before the override can be removed.\n"
)
var _ FilepathGetter = (*OverridesFile)(nil)
type OverridesFile struct {
Filepath string `yaml:"-"`
SchemaVersion string `yaml:"schema"`
Notes string `yaml:"notes"`
Editors Editors `yaml:"editors"`
Overrides Overrides `yaml:"overrides"`
}
func NewOverridesFile(dir string) *OverridesFile {
pf := &OverridesFile{
Filepath: filepath.Join(dir, OverridesFilename),
Notes: strings.TrimSpace(OverridesNotes),
}
pf.ensureValidProperties()
return pf
}
func (of *OverridesFile) GetFilepath() string {
return of.Filepath
}
func (of *OverridesFile) Exists() (exists bool) {
return FileExists(of.Filepath)
}
func (of *OverridesFile) ensureValidProperties() {
if of.SchemaVersion == "" {
of.SchemaVersion = ProjectFileSchemaVersion
}
if of.Overrides == nil {
of.Overrides = make(Overrides, 0)
}
}
func (of *OverridesFile) Save() error {
return SaveYAMLFile(of)
}