manifest

Documentation

Overview

Package manifest reads and writes Encore app manifests.

Index

• func SetTutorial(appRoot string, tutorial string) (err error)
• type Manifest
  • func ReadOrCreate(appRoot string) (mf *Manifest, err error)

Functions

func SetTutorial

func SetTutorial(appRoot string, tutorial string) (err error)

SetTutorial sets the tutorial field on the app manifest

Types

type Manifest

type Manifest struct {
	// AppID is a unique identifier for the app.
	// It uses the encore.dev app slug if the app
	// is linked, and is otherwise a randomly generated id.
	AppID string `json:"appID,omitempty"`

	// LocalID is a unique id for the app that's only used locally.
	// It is randomly generated on first use.
	LocalID string `json:"local_id"`

	// Tutorial is set to the name of the tutorial the user is currently on or empty.
	Tutorial string `json:"tutorial"`
}

Manifest represents the persisted manifest for an Encore application. It is not intended to be committed to source control.

func ReadOrCreate

func ReadOrCreate(appRoot string) (mf *Manifest, err error)

ReadOrCreate reads the manifest for the app rooted at appRoot. If it doesn't exist it creates it first.