bits

package

v1.35.3 Latest Latest Go to latest Published: Apr 12, 2024 License: MPL-2.0 Imports: 15 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/encoredev/encore

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Describe(ctx context.Context, dir string) (desc *app.Desc, err error)
func Extract(ctx context.Context, b *Bit, dst string) error
type Bit
- func Get(ctx context.Context, slug string) (*Bit, error)
- func List(ctx context.Context) ([]*Bit, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotFound = errors.New("bit not found")

ErrNotFound is reported by Get if the bit with the given slug is not found.

Functions ¶

func Describe ¶

func Describe(ctx context.Context, dir string) (desc *app.Desc, err error)

Describe describes the contents of the bit extracted in dir.

func Extract ¶

func Extract(ctx context.Context, b *Bit, dst string) error

Extract downloads and extracts a bit into a given directory.

Types ¶

type Bit ¶

type Bit struct {
	Slug        string
	Title       string
	Description string

	// GitHubTree is a URL to the GitHub tree for this bit,
	// in the format expected by github.ParseTree.
	GitHubTree string
}

func Get ¶

func Get(ctx context.Context, slug string) (*Bit, error)

Get retrieves a bit by its slug.

func List ¶

func List(ctx context.Context) ([]*Bit, error)

List lists available bits.

Source Files ¶

View all Source files

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