lint

package

v0.0.0-...-7b8b74e Latest Latest Go to latest Published: Oct 25, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Documentation ¶

Overview ¶

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.

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.

Index ¶

type AddOn
type Linter
- func New(opts ...Option) *Linter
- func (l *Linter) Validate(ctx context.Context, inst v1beta1.Installer) ([]Output, error)
- func (l *Linter) Versions(ctx context.Context, inst v1beta1.Installer) (map[string]AddOn, error)
type Option
- func WithAPIBaseURL(u *url.URL) Option
- func WithStaticVersions(versions map[string]AddOn) Option
type Output

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AddOn ¶

type AddOn struct {
	Latest   string   `json:"latest"`
	Versions []string `json:"versions"`
}

AddOn holds an add-on and its respective supported versions.

type Linter ¶

type Linter struct {
	// contains filtered or unexported fields
}

func New ¶

func New(opts ...Option) *Linter

New returns a new v1beta1.Installer linter. this linter is capable of evaluating if a struct has all its fields properly set, rules in the "rego/" directory are used.

func (*Linter) Validate ¶

func (l *Linter) Validate(ctx context.Context, inst v1beta1.Installer) ([]Output, error)

Validate checks the provided Installer for errors.

func (*Linter) Versions ¶

func (l *Linter) Versions(ctx context.Context, inst v1beta1.Installer) (map[string]AddOn, error)

Versions return a map containing all supported versions indexed by add-on name. it goes and fetch the versions from a remote endpoint.

type Option ¶

type Option func(*Linter)

Option is a function that sets an option in Linter object.

func WithAPIBaseURL ¶

func WithAPIBaseURL(u *url.URL) Option

WithAPIBaseURL sets a different api base url from where the linter attempts to load known versions for all addons. The default is "https://kurl.sh".

func WithStaticVersions ¶

func WithStaticVersions(versions map[string]AddOn) Option

WithStaticVersions set an static version of addon versions, avoids going to the the remote api to fetch a new list from time to time.

type Output ¶

type Output struct {
	Field   string `json:"field,omitempty"`
	Type    string `json:"type,omitempty"`
	Message string `json:"message,omitempty"`
}

Output holds the outcome of a lint pass on top of a Installer struct.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL