Help us shape the future of Go! Take the 2026 Go Developer Survey

output

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommentJSON added in v0.3.0

type CommentJSON struct {
	EntityID string     `json:"entityId"`
	Author   *UserJSON  `json:"author"`
	Text     *string    `json:"text"`
	Created  time.Time  `json:"created"`
	Updated  *time.Time `json:"updated"`
	Deleted  bool       `json:"deleted"`
}

type CommentRemovalJSON added in v0.3.0

type CommentRemovalJSON struct {
	EntityID string `json:"entityId"`
	Removed  bool   `json:"removed"`
}

type FieldJSON

type FieldJSON struct {
	EntityID     string            `json:"entityId,omitempty"`
	Name         string            `json:"name"`
	Type         string            `json:"type"`
	Cardinality  string            `json:"cardinality,omitempty"`
	Value        any               `json:"value"`
	StateMachine bool              `json:"stateMachine,omitempty"`
	Transitions  []FieldOptionJSON `json:"transitions,omitempty"`
}

type FieldOptionJSON

type FieldOptionJSON struct {
	EntityID string `json:"entityId"`
	Name     string `json:"name"`
}

type Format

type Format string
const (
	FormatHuman Format = "human"
	FormatJSON  Format = "json"
	FormatPlain Format = "plain"
)

type IssueJSON

type IssueJSON struct {
	ID          string      `json:"id"`
	EntityID    string      `json:"entityId"`
	Summary     string      `json:"summary"`
	Description string      `json:"description,omitempty"`
	Project     ProjectJSON `json:"project"`
	Reporter    *UserJSON   `json:"reporter,omitempty"`
	Updater     *UserJSON   `json:"updater,omitempty"`
	Created     time.Time   `json:"created"`
	Updated     time.Time   `json:"updated"`
	Resolved    *time.Time  `json:"resolved,omitempty"`
	Fields      []FieldJSON `json:"fields,omitempty"`
	Tags        []TagJSON   `json:"tags,omitempty"`
}

type IssueLinkChangeJSON added in v0.4.0

type IssueLinkChangeJSON struct {
	IssueID       string           `json:"issueId"`
	TargetIssueID string           `json:"targetIssueId"`
	Relation      LinkRelationJSON `json:"relation"`
	Present       bool             `json:"present"`
	Changed       bool             `json:"changed"`
}

type IssueLinkListJSON added in v0.4.0

type IssueLinkListJSON struct {
	IssueID  string             `json:"issueId"`
	Relation LinkRelationJSON   `json:"relation"`
	Issues   []IssueSummaryJSON `json:"issues"`
}

type IssueSummaryJSON added in v0.3.0

type IssueSummaryJSON struct {
	ID       string      `json:"id"`
	EntityID string      `json:"entityId"`
	Summary  string      `json:"summary"`
	Project  ProjectJSON `json:"project"`
	Created  time.Time   `json:"created"`
	Updated  time.Time   `json:"updated"`
	Resolved *time.Time  `json:"resolved"`
}

type LinkRelationJSON added in v0.4.0

type LinkRelationJSON struct {
	Type      LinkRelationTypeJSON `json:"type"`
	Direction string               `json:"direction"`
	Label     string               `json:"label"`
}

type LinkRelationTypeJSON added in v0.4.0

type LinkRelationTypeJSON struct {
	EntityID string `json:"entityId"`
	Name     string `json:"name"`
}

type LinkTypeJSON added in v0.4.0

type LinkTypeJSON struct {
	EntityID    string  `json:"entityId"`
	Name        string  `json:"name"`
	Directed    bool    `json:"directed"`
	Aggregation bool    `json:"aggregation"`
	Outward     string  `json:"outward"`
	Inward      *string `json:"inward"`
}

type OpenJSON added in v0.4.0

type OpenJSON struct {
	URL    string `json:"url"`
	Opened bool   `json:"opened"`
}

type ProjectJSON

type ProjectJSON struct {
	EntityID  string `json:"entityId"`
	Name      string `json:"name"`
	ShortName string `json:"shortName"`
}

type Renderer

type Renderer struct {
	Out    io.Writer
	Format Format
}

func New

func New(out io.Writer, jsonMode, plainMode bool) (*Renderer, error)

func (*Renderer) Comment added in v0.3.0

func (r *Renderer) Comment(comment domain.Comment) error

func (*Renderer) CommentRemoval added in v0.3.0

func (r *Renderer) CommentRemoval(id string) error

func (*Renderer) Comments added in v0.3.0

func (r *Renderer) Comments(comments []domain.Comment) error

func (*Renderer) Field

func (r *Renderer) Field(field domain.IssueField) error

func (*Renderer) Fields

func (r *Renderer) Fields(fields []domain.IssueField) error

func (*Renderer) Issue

func (r *Renderer) Issue(issue domain.Issue) error

func (*Renderer) IssueLinkChange added in v0.4.0

func (r *Renderer) IssueLinkChange(item domain.IssueLinkChange) error
func (r *Renderer) IssueLinks(item domain.IssueLinkList) error

func (*Renderer) IssueSummaries added in v0.3.0

func (r *Renderer) IssueSummaries(items []domain.IssueSummary) error

func (*Renderer) JSON

func (r *Renderer) JSON(v any) error

func (*Renderer) LinkTypes added in v0.4.0

func (r *Renderer) LinkTypes(items []domain.LinkType) error

func (*Renderer) Open added in v0.4.0

func (r *Renderer) Open(url string, opened bool) error

func (*Renderer) SavedSearch added in v0.3.0

func (r *Renderer) SavedSearch(search domain.SavedSearch, issues []domain.IssueSummary) error

func (*Renderer) Tags

func (r *Renderer) Tags(tags []domain.Tag) error

func (*Renderer) User

func (r *Renderer) User(user domain.User) error

func (*Renderer) WorkItem added in v0.4.0

func (r *Renderer) WorkItem(item domain.WorkItem) error

func (*Renderer) WorkItemRemoval added in v0.4.0

func (r *Renderer) WorkItemRemoval(id string) error

func (*Renderer) WorkItemTypes added in v0.4.0

func (r *Renderer) WorkItemTypes(items []domain.WorkItemType) error

func (*Renderer) WorkItems added in v0.4.0

func (r *Renderer) WorkItems(items []domain.WorkItem) error

type SavedSearchJSON added in v0.3.0

type SavedSearchJSON struct {
	EntityID string             `json:"entityId"`
	Name     string             `json:"name"`
	Query    string             `json:"query"`
	Owner    *UserJSON          `json:"owner"`
	Issues   []IssueSummaryJSON `json:"issues"`
}

type TagJSON

type TagJSON struct {
	EntityID string `json:"entityId,omitempty"`
	Name     string `json:"name"`
}

type UserJSON

type UserJSON struct {
	EntityID string `json:"entityId"`
	Login    string `json:"login"`
	Name     string `json:"name,omitempty"`
}

type WorkItemJSON added in v0.4.0

type WorkItemJSON struct {
	EntityID        string            `json:"entityId"`
	Date            string            `json:"date"`
	DurationMinutes int64             `json:"durationMinutes"`
	Text            *string           `json:"text"`
	Author          *WorkItemUserJSON `json:"author"`
	Creator         *WorkItemUserJSON `json:"creator"`
	Type            *WorkItemTypeJSON `json:"type"`
	Created         time.Time         `json:"created"`
	Updated         *time.Time        `json:"updated"`
}

type WorkItemRemovalJSON added in v0.4.0

type WorkItemRemovalJSON struct {
	EntityID string `json:"entityId"`
	Removed  bool   `json:"removed"`
}

type WorkItemTypeJSON added in v0.4.0

type WorkItemTypeJSON struct {
	EntityID string `json:"entityId"`
	Name     string `json:"name"`
}

type WorkItemUserJSON added in v0.4.0

type WorkItemUserJSON struct {
	EntityID string `json:"entityId"`
	Login    string `json:"login"`
	Name     string `json:"name"`
}

Jump to

Keyboard shortcuts

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