forked from bufbuild/buf
/
bandeps.go
75 lines (63 loc) · 2.21 KB
/
bandeps.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
66
67
68
69
70
71
72
73
74
75
// Copyright 2020-2023 Buf Technologies, Inc.
//
// 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 bandeps
import (
"context"
"fmt"
"github.com/bufbuild/buf/private/pkg/app"
"github.com/bufbuild/buf/private/pkg/command"
"go.uber.org/zap"
)
const (
tracerName = "bufbuild/buf/bandeps"
)
// Checker is a checker.
type Checker interface {
// Check runs bandeps in the current directory with the configuration.
Check(
ctx context.Context,
envStdioContainer app.EnvStdioContainer,
externalConfig ExternalConfig,
) ([]Violation, error)
}
func NewChecker(logger *zap.Logger, runner command.Runner) Checker {
return newChecker(logger, runner)
}
// Violation is a violation.
type Violation interface {
fmt.Stringer
Package() string
Dep() string
Note() string
key() string
}
// ExternalConfig is an external configuation.
type ExternalConfig struct {
Bans []ExternalBanConfig `json:"bans,omitempty" yaml:"bans,omitempty"`
}
// ExternalConfig is an external ban configuation.
type ExternalBanConfig struct {
// Packages are the package expressions to get dependencies for.
Packages ExternalPackageConfig `json:"packages,omitempty" yaml:"packages,omitempty"`
// Deps are package expressions that cannot be depended on for Packages.
Deps ExternalPackageConfig `json:"deps,omitempty" yaml:"deps,omitempty"`
// Note is a note to print out regarding why this ban exists.
Note string `json:"note,omitempty" yaml:"note,omitempty"`
}
type ExternalPackageConfig struct {
// Use are the package expressions to list with go list.
Use []string `json:"use,omitempty" yaml:"use,omitempty"`
// Except are the package expressions that should be excluded from Use.
Except []string `json:"except,omitempty" yaml:"except,omitempty"`
}