fjira

Documentation

Index

• Constants
• Variables
• func EditWorkspaceAndReadSettings(input io.Reader, workspace string) (*workspaces.WorkspaceSettings, error)
• func Install(workspace string) (*workspaces.WorkspaceSettings, error)
• type CliArgs
• type Fjira
  • func CreateNewFjira(settings *workspaces.WorkspaceSettings) *Fjira
  • func (f *Fjira) Close()
  • func (f *Fjira) Run(args *CliArgs)

Constants

const (
	JiraTokenEnv    = "FJIRA_TOKEN"
	JiraUsernameEnv = "FJIRA_USERNAME"
	JiraTokenType   = "FJIRA_JIRA_TOKEN_TYPE"
	JiraRestUrlEnv  = "FJIRA_REST_URL"
)

const (
	WelcomeMessage = `` /* 207-byte string literal not displayed */

)

Variables

var (
	EnvironmentsMissingErr    = errors.New("cannot find " + JiraTokenEnv + " or " + JiraUsernameEnv + " or " + JiraRestUrlEnv + " environments. Please add them in order to use Jira REST API")
	WorkspaceFormatInvalidErr = errors.New("workspace name needs to match pattern [a-z0-9]{2,50}")
)

var InstallFailedErr = errors.New("cannot use fjira. Please check error logs in order to install missing packages")

Functions

func EditWorkspaceAndReadSettings

func EditWorkspaceAndReadSettings(input io.Reader, workspace string) (*workspaces.WorkspaceSettings, error)

func Install

func Install(workspace string) (*workspaces.WorkspaceSettings, error)

Types

type CliArgs

type CliArgs struct {
	ProjectId       string
	IssueKey        string
	Workspace       string
	WorkspaceSwitch bool
	WorkspaceEdit   bool
	JqlMode         bool
	FiltersMode     bool
}

CliArgs TODO - drop it, and use cobra directly

type Fjira

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

func CreateNewFjira

func CreateNewFjira(settings *workspaces.WorkspaceSettings) *Fjira

func (*Fjira) Close

func (f *Fjira) Close()

func (*Fjira) Run

func (f *Fjira) Run(args *CliArgs)