localrun

Documentation

Overview

Package localrun provides helper methods for locally building a Kythe indexed repo.

Index

• Variables
• type Language
  • func KnownLanguage(s string) (Language, bool)
  • func (l Language) String() string
  • func (l Language) Valid() bool
• type LanguageSet
  • func AllLanguages() LanguageSet
  • func (ls LanguageSet) Has(l Language) bool
  • func (ls LanguageSet) Set(l Language)
  • func (ls LanguageSet) String() string
• type Runner
  • func (r *Runner) Extract(ctx context.Context) error
  • func (r *Runner) Index(ctx context.Context) error
  • func (r *Runner) PostProcess(ctx context.Context) error
  • func (r *Runner) Serve(ctx context.Context) error

Variables

var LanguageMap map[string]Language = makeLanguageMap()

LanguageMap is a mapping from the string name of each language to the enum value.

Types

type Language

type Language int

Language defines

const (
	Cxx Language
	Go
	Java
	Jvm
	Protobuf
	Python    // TODO: Python isn't shipping in Kythe right now by default.
	Textproto // TODO: Textproto isn't shipping in Kythe right now by default.
	TypeScript
)

This list must be kept in sync with Language.String.

func KnownLanguage

func KnownLanguage(s string) (Language, bool)

func (Language) String

func (l Language) String() string

String provides the string representation of this enum value.

func (Language) Valid

func (l Language) Valid() bool

Valid determines of the provided language is a valid enum value.

type LanguageSet

type LanguageSet map[Language]struct{}

LanguageSet is a set implementation that tracks langages.

func AllLanguages

func AllLanguages() LanguageSet

AllLanguages returns a language set that contains all available languages.

func (LanguageSet) Has

func (ls LanguageSet) Has(l Language) bool

Has checks if the provided language is in the set.

func (LanguageSet) Set

func (ls LanguageSet) Set(l Language)

Set the provided language in the set.

func (LanguageSet) String

func (ls LanguageSet) String() string

String implements Stringer.String.

type Runner

type Runner struct {
	// Generally useful configuration
	KytheRelease   string
	WorkingDir     string
	OutputDir      string
	WorkerPoolSize int
	CacheSize      *datasize.Size

	// Building/extracting options.
	Languages LanguageSet
	Targets   []string

	// Serving configuration options.
	Port            int
	Hostname        string
	PublicResources string

	// Timeout for indexing.
	Timeout time.Duration
	// contains filtered or unexported fields
}

Runner is responsible for indexing the repo with Kythe.

func (*Runner) Extract

func (r *Runner) Extract(ctx context.Context) error

Extract builds the provided targets and extracts compilation results.

func (*Runner) Index

func (r *Runner) Index(ctx context.Context) error

Index indexes the extracted data. Index is a reimplementation of the https://github.com/kythe/kythe/blob/master/kythe/release/kythe.sh script's --index mode.

func (*Runner) PostProcess

func (r *Runner) PostProcess(ctx context.Context) error

PostProcess postprocesses the supplied indexed data.

func (*Runner) Serve

func (r *Runner) Serve(ctx context.Context) error

Serve starts an http server on the provided port and allows web inspection of the indexed data.