render

Documentation

Overview

Package render generates HTML pages listing edits.

Index

• func OpenFile(ctx context.Context, edits []seed.Edit, opts ...Option) error
• func OpenHTTP(ctx context.Context, addr string, edits []seed.Edit, opts ...Option) error
• func TransformTS(ts, fn string, minify bool) (string, error)
• func Write(w io.Writer, edits []seed.Edit, opts ...Option) error
• type EditInfo
  • func NewEditInfo(edit seed.Edit, serverURL string) (*EditInfo, error)
  • func NewEditInfos(edits []seed.Edit, serverURL string) ([]*EditInfo, error)
• type Option
  • func MinifyJS(v bool) Option
  • func ServerURL(u string) Option
  • func Version(v string) Option
• type Stream
  • func NewStream(rw http.ResponseWriter, nowFunc func() time.Time) *Stream
  • func (s *Stream) Edits(edits []*EditInfo) error
  • func (s *Stream) Error(text string) error
  • func (s *Stream) Log(text string) error

Functions

func OpenFile

func OpenFile(ctx context.Context, edits []seed.Edit, opts ...Option) error

OpenFile writes an HTML page containing edits to a temporary file and opens it in a browser.

func OpenHTTP

func OpenHTTP(ctx context.Context, addr string, edits []seed.Edit, opts ...Option) error

OpenHTTP starts a local HTTP server at addr and opens an HTML page containing edits in a browser. This is fairly complicated but it can be convenient if the browser doesn't have direct filesystem access (e.g. the server is running in a Chrome OS VM), and I think that a fixed host:port may be needed in order to permanently tell Chrome to avoid blocking popups.

func TransformTS

func TransformTS(ts, fn string, minify bool) (string, error)

TransformTS transpiles the supplied TypeScript code from the named file to JavaScript.

func Write

func Write(w io.Writer, edits []seed.Edit, opts ...Option) error

Write writes an HTML page containing the supplied edits to w.

Types

type EditInfo

type EditInfo struct {
	Desc   string      `json:"desc"`
	URL    string      `json:"url"`    // includes params iff GET
	Params []paramInfo `json:"params"` // includes params iff POST
}

EditInfo is a version of seed.Edit used in HTML pages. It's used both for passing edits to indexTmpl in CLI mode and for returning edits via XHRs when running in server mode.

func NewEditInfo

func NewEditInfo(edit seed.Edit, serverURL string) (*EditInfo, error)

NewEditInfo converts a seed.Edit into an EditInfo struct.

func NewEditInfos

func NewEditInfos(edits []seed.Edit, serverURL string) ([]*EditInfo, error)

NewEditInfos calls NewEditInfo for each of the supplied edits.

type Option

type Option func(*config)

Option can be passed to configure the page.

func MinifyJS

func MinifyJS(v bool) Option

MinifyJS configures whether the page's JavaScript is minified. Minification is performed by default.

func ServerURL

func ServerURL(u string) Option

ServerURL sets the base MusicBrainz server URL, e.g. "https://musicbrainz.org" or "https://test.musicbrainz.org".

func Version

func Version(v string) Option

Version sets an optional yambs version to include in the page.

type Stream

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

Stream writes JSON-serialized messages to a http.ResponseWriter.

func NewStream

func NewStream(rw http.ResponseWriter, nowFunc func() time.Time) *Stream

NewStream returns a new Stream. Data shouldn't be written to rw before (or after) calling this. Non-test code should just pass time.Now as nowFunc.

func (*Stream) Edits

func (s *Stream) Edits(edits []*EditInfo) error

Edits writes the supplied edits to the stream.

func (*Stream) Error

func (s *Stream) Error(text string) error

Error writes the supplied fatal error to the stream.

func (*Stream) Log

func (s *Stream) Log(text string) error

Log implements the clog.Logger interface.