gradle

Documentation

Overview

Package gradle implements analyzers for Gradle.

A `BuildTarget` in Gradle is `$PROJECT:$CONFIGURATION`, where the Gradle module would list its dependencies by running `gradle $PROJECT:dependencies --configuration=$CONFIGURATION`. The directory of the `build.gradle` file is specified by `Dir`.

Index

• func Discover(dir string, options map[string]interface{}) ([]module.Module, error)
• func DiscoverWithCommand(dir string, userOptions map[string]interface{}, ...) ([]module.Module, error)
• type Analyzer
  • func New(m module.Module) (*Analyzer, error)
  • func (a *Analyzer) Analyze() (graph.Deps, error)
  • func (a *Analyzer) Build() error
  • func (a *Analyzer) Clean() error
  • func (a *Analyzer) IsBuilt() (bool, error)
• type Options

Functions

func Discover

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

Discover searches for `build.gradle` files and creates a module for each `*:dependencies` task in the output of `gradle tasks`.

TODO: use the output of `gradle projects` and try `gradle <project>:dependencies` for each project?

func DiscoverWithCommand

func DiscoverWithCommand(dir string, userOptions map[string]interface{}, command func(string, string, int, ...string) (string, error)) ([]module.Module, error)

Types

type Analyzer

type Analyzer struct {
	Module  module.Module
	Options Options
	Input   gradle.Input
}

func New

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

func (*Analyzer) Analyze

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

func (*Analyzer) Build

func (a *Analyzer) Build() error

func (*Analyzer) Clean

func (a *Analyzer) Clean() error

func (*Analyzer) IsBuilt

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

type Options

type Options struct {
	Cmd               string `mapstructure:"cmd"`
	Task              string `mapstructure:"task"`
	Online            bool   `mapstructure:"online"`
	AllSubmodules     bool   `mapstructure:"all-submodules"`
	AllConfigurations bool   `mapstructure:"all-configurations"`
	Timeout           string `mapstructure:"timeout"`
	Retries           int    `mapstructure:"retries"`
	// TODO: These are temporary until v2 configuration files (with proper BuildTarget) are implemented.
	Project       string `mapstructure:"project"`
	Configuration string `mapstructure:"configuration"`
}