shared

README

Shared

A library for creating laraboot buildpacks

Contributing

Simply create an issue or a pull request.

Documentation

Overview

Package shared contains all shared public dependencies and definitions

Index

• func RunCommand(context packit.BuildContext, execName string, args ...string) ([]byte, error)
• type Contributor
  • func NewContributor(name string, context packit.BuildContext, layer packit.Layer) (Contributor, error)
  • func NewGlobalContributor(name string, context packit.BuildContext, layer packit.Layer) (Contributor, error)
  • func (l Contributor) Install() ([]byte, error)
  • func (l Contributor) WriteCustomInitFile(templateBody string, outputPath string, data interface{}) error
• type LarabootStruct
  • func NewFromFile(filename string) (LarabootStruct, error)
  • func NewFromString(jsonData string) (LarabootStruct, error)
• type LogEmitter
  • func NewLogEmitter(output io.Writer) LogEmitter
  • func (e LogEmitter) Candidates(entries []packit.BuildpackPlanEntry)
  • func (e LogEmitter) Environment(environment packit.Environment)

Functions

func RunCommand

func RunCommand(context packit.BuildContext, execName string, args ...string) ([]byte, error)

RunCommand runs a composer command .

Types

type Contributor

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

Contributor represents a PHP contribution by the buildpack.

func NewContributor

func NewContributor(name string, context packit.BuildContext, layer packit.Layer) (Contributor, error)

NewContributor creates a new Contributor instance.

func NewGlobalContributor

func NewGlobalContributor(name string, context packit.BuildContext, layer packit.Layer) (Contributor, error)

NewGlobalContributor creates a Contributor instance and set global = true.

func (Contributor) Install

func (l Contributor) Install() ([]byte, error)

Install the package It requieres `composer buildpack` to run the installation.

func (Contributor) WriteCustomInitFile

func (l Contributor) WriteCustomInitFile(templateBody string, outputPath string, data interface{}) error

WriteCustomInitFile writes an ini file.

type LarabootStruct

type LarabootStruct struct {
	Version   string `json:"version"`
	ProjectID string `json:"project_id"`
	Php       struct {
		Version string `json:"version"`
	} `json:"php"`
	Framework struct {
		Config struct {
			Overrides []struct {
				Key     string `json:"key"`
				Envs    string `json:"envs"`
				Default string `json:"default"`
			} `json:"overrides"`
		} `json:"config"`
		Auth struct {
			Stack string `json:"stack"`
		} `json:"auth"`
		Models []struct {
			Name    string `json:"name"`
			Columns []struct {
				Name string `json:"name"`
				Type string `json:"type"`
			} `json:"columns"`
		} `json:"models"`
	} `json:"Framework"`
	Build struct {
		Tasks []struct {
			Name   string `json:"name"`
			Path   string `json:"path"`
			Local  bool   `json:"local"`
			Format string `json:"format"`
			Env    struct {
			} `json:"env"`
		} `json:"tasks"`
	} `json:"Build"`
}

LarabootStruct : Laraboot file schema.

func NewFromFile

func NewFromFile(filename string) (LarabootStruct, error)

NewFromFile :Reads JSON data from file and returns the parsed map.

func NewFromString

func NewFromString(jsonData string) (
	LarabootStruct,
	error,
)

NewFromString : Reads JSON data from string and returns the parsed map.

type LogEmitter

type LogEmitter struct {
	// Emitter is embedded and therefore delegates all of its functions to the
	scribe.Emitter
}

LogEmitter .

func NewLogEmitter

func NewLogEmitter(output io.Writer) LogEmitter

NewLogEmitter .

func (LogEmitter) Candidates

func (e LogEmitter) Candidates(entries []packit.BuildpackPlanEntry)

Candidates logs Candidates.

func (LogEmitter) Environment

func (e LogEmitter) Environment(environment packit.Environment)

Environment logs an Environment subprocess.