okbuck

package

v0.7.33 Latest Latest Go to latest Published: Jul 1, 2019 License: MPL-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

github.com/joey-fossa/fossa-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package okbuck implements the analyzer for OkBuck. https://github.com/uber/okbuck.

A `BuildTarget` in OkBuck is defined as a Build Target by OkBuck which is in in the format of `//src/build:target`. OkBuck defines this as a string used to identify a Build Rule.

This package is implemented by externally calling the `okbuck` build tool.

FAQ ¶

1. Why is analyzing manifest files not a supported strategy as it is for other tools?

`.buckconfig` can be used to discover cells but the `repository` field which defines cells is not required . `BUCK` files are written in Skylark (a dialect of Python) and are impossible to statically analyze. `buck audit` provides json formatted data for dependency and input information.

Index ¶

func Discover(dir string, opts map[string]interface{}) ([]module.Module, error)
type Analyzer
- func New(module module.Module) (*Analyzer, error)
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Discover ¶

func Discover(dir string, opts map[string]interface{}) ([]module.Module, error)

Discover searches for `buckw` executables in the present directory.

Types ¶

type Analyzer ¶

type Analyzer struct {
	Module  module.Module
	Setup   okbuck.OkBuck
	Options Options
}

Analyzer defines a OkBuck analyzer.

func New ¶

func New(module module.Module) (*Analyzer, error)

New constructs a new OkBuck analyzer from a module.

func (*Analyzer) Analyze ¶

func (a *Analyzer) Analyze() (graph.Deps, error)

Analyze analyzes an OkBuck build target and its dependencies.

func (*Analyzer) Build ¶

func (a *Analyzer) Build() error

Build is not implemented.

func (*Analyzer) Clean ¶

func (a *Analyzer) Clean() error

Clean is not implemented.

func (*Analyzer) IsBuilt ¶

func (a *Analyzer) IsBuilt() (bool, error)

IsBuilt is not implemented.

type Options ¶ added in v0.7.19

type Options struct {
	ClassPath string `mapstructure:"classpath"` // Specify the classpath to target for a specific configurations dependencies.
}

Options sets analyzer options for Go modules.

Source Files ¶

View all Source files

okbuck.go

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