nudge

Documentation

Index

• Constants
• func MarkCompleted()
• func MarkDismissed()
• func MarkShown()
• func ShouldShowNudge() bool
• type NudgeState

Constants

const GitHubRepoURL = "https://github.com/Bharath-code/git-scope"

GitHubRepoURL is the URL to open when user presses S

const Version = "1.3.0"

Version is the current app version - used to track per-version nudge

Functions

func MarkCompleted

func MarkCompleted()

MarkCompleted marks the nudge as completed (S pressed, GitHub opened)

func MarkDismissed

func MarkDismissed()

MarkDismissed marks the nudge as dismissed (any key pressed)

func MarkShown

func MarkShown()

MarkShown marks the nudge as shown for the current version

func ShouldShowNudge

func ShouldShowNudge() bool

ShouldShowNudge checks if the star nudge should be shown Returns true only if: - Not already seen for this version - Not dismissed - Not completed (user already starred)

Types

type NudgeState

type NudgeState struct {
	SeenVersion string `json:"seenVersion"`
	Dismissed   bool   `json:"dismissed"`
	Completed   bool   `json:"completed"`
}

NudgeState represents the persistent state of the star nudge