setupchecklist

package

v0.3.4 Latest Latest Go to latest Published: Oct 26, 2026 License: AGPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getsphericon/sphericon

Links

Open Source Insights

Documentation ¶

Overview ¶

Package setupchecklist reads the Workspace's Setup checklist (GLOSSARY "Setup checklist"): five steps, each read off rows the Workspace already has, never ticked by hand. It is a point-in-time read model with no state of its own; no step blocks another.

Index ¶

type Checklist
- func Read(ctx context.Context, s *ent.Scoped) (Checklist, error)
- func (c Checklist) Complete() bool
type Status
type Steps

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Checklist ¶

type Checklist struct {
	Steps Steps
}

Checklist is the read model for one Workspace.

func Read ¶

func Read(ctx context.Context, s *ent.Scoped) (Checklist, error)

Read computes the checklist of the Workspace behind s.

func (Checklist) Complete ¶

func (c Checklist) Complete() bool

Complete reports whether every required step is done. The Test inbox step is a way to see the product work before a provider exists, so a Workspace with a real provider is not held to it.

type Status ¶

type Status string

Status is where one step stands. Only the Sending domain step is ever Pending.

const (
	Todo    Status = "todo"
	Pending Status = "pending"
	Done    Status = "done"
)

type Steps ¶

type Steps struct {
	Integration, TestInbox, SendingDomain, Contact, SentEmail Status
}

Steps are the checklist's steps, in the order it shows them.

Source Files ¶

View all Source files

setupchecklist.go

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