bazelfiles

Documentation

Overview

package bazelfiles is used to find and handle Bazel WORKSPACE and bzl files.

Index

• Constants
• type BazelFile
• type BazelFileType
• type Helper
  • func New() (*Helper, error)
  • func (h *Helper) Diff(bf BazelFile, buildfile *build.File) (string, error)
  • func (h *Helper) FindFiles() ([]BazelFile, error)
  • func (h *Helper) LoadFile(bf BazelFile) (*build.File, error)
  • func (h *Helper) WriteFile(bf BazelFile, buildfile *build.File) error
• type LookupEnv

Constants

const (
	// BazelFileTypeBzl is a .bzl file.
	BazelFileTypeBzl = iota
	// BazelFileTypeWorkspace is a WORKSPACE or WORKSPACE.bzlmod file.
	BazelFileTypeWorkspace
)

Types

type BazelFile

type BazelFile struct {
	RelPath string
	AbsPath string
	Type    BazelFileType
}

BazelFile is a reference (path) to a Bazel file.

type BazelFileType

type BazelFileType int

BazelFileType is the type of a Bazel file.

type Helper

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

Helper is used to find and handle Bazel WORKSPACE and bzl files.

func New

func New() (*Helper, error)

New creates a new BazelFilesHelper.

func (*Helper) Diff

func (h *Helper) Diff(bf BazelFile, buildfile *build.File) (string, error)

Diff returns the diff between the saved and the updated (in-memory) version of a Bazel file.

func (*Helper) FindFiles

func (h *Helper) FindFiles() ([]BazelFile, error)

FindFiles returns the paths to all Bazel files in the Bazel workspace.

func (*Helper) LoadFile

func (h *Helper) LoadFile(bf BazelFile) (*build.File, error)

LoadFile loads a Bazel file.

func (*Helper) WriteFile

func (h *Helper) WriteFile(bf BazelFile, buildfile *build.File) error

WriteFile writes (updates) a Bazel file.

type LookupEnv

type LookupEnv func(key string) (string, bool)

LookupEnv can be the real os.LookupEnv or a mock for testing.