github.com/anchore/syft@v1.4.2-0.20240516191711-1bec1fc5d397/syft/event/event.go (about)

     1  /*
     2  Package event provides event types for all events that the syft library published onto the event bus. By convention, for each event
     3  defined here there should be a corresponding event parser defined in the parsers/ child package.
     4  */
     5  package event
     6  
     7  import (
     8  	"github.com/wagoodman/go-partybus"
     9  )
    10  
    11  const (
    12  	typePrefix    = "syft"
    13  	cliTypePrefix = typePrefix + "-cli"
    14  
    15  	// Events from the syft library
    16  
    17  	// FileIndexingStarted is a partybus event that occurs when the directory resolver begins indexing a filesystem
    18  	FileIndexingStarted partybus.EventType = typePrefix + "-file-indexing-started-event"
    19  
    20  	// AttestationStarted is a partybus event that occurs when starting an SBOM attestation process
    21  	AttestationStarted partybus.EventType = typePrefix + "-attestation-started-event"
    22  
    23  	// CatalogerTaskStarted is a partybus event that occurs when starting a task within a cataloger
    24  	CatalogerTaskStarted partybus.EventType = typePrefix + "-cataloger-task-started"
    25  
    26  	// Events exclusively for the CLI
    27  
    28  	// CLIAppUpdateAvailable is a partybus event that occurs when an application update is available
    29  	CLIAppUpdateAvailable partybus.EventType = cliTypePrefix + "-app-update-available"
    30  
    31  	// CLIReport is a partybus event that occurs when an analysis result is ready for final presentation to stdout
    32  	CLIReport partybus.EventType = cliTypePrefix + "-report"
    33  
    34  	// CLINotification is a partybus event that occurs when auxiliary information is ready for presentation to stderr
    35  	CLINotification partybus.EventType = cliTypePrefix + "-notification"
    36  )