diff --git a/modules/hackernews/settings.go b/modules/hackernews/settings.go index e4af6714..842b3c05 100644 --- a/modules/hackernews/settings.go +++ b/modules/hackernews/settings.go @@ -10,8 +10,8 @@ const defaultTitle = "HackerNews" type Settings struct { common *cfg.Common - numberOfStories int - storyType string + numberOfStories int `help:"Defines number of stories to be displayed. Default is 10" optional:"true"` + storyType string `help:"Category of story to see" values:"new, top, job, ask" optional:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/hibp/settings.go b/modules/hibp/settings.go index f5b9d0f3..49d1a26c 100644 --- a/modules/hibp/settings.go +++ b/modules/hibp/settings.go @@ -23,8 +23,8 @@ type Settings struct { colors common *cfg.Common - accounts []string - since string + accounts []string `help:"A list of the accounts to check the HIBP database for."` + since string `help:"Only check for breaches after this date. Set this if you’ve been breached in the past, have taken steps to mitigate that (changing passwords, cancelling accounts, etc.) and now only want to know about future breaches." values:"A date string in the format 'yyyy-mm-dd', ie: '2019-06-22'", optional:"true"` } // NewSettingsFromYAML creates a new settings instance from a YAML config block diff --git a/modules/jenkins/settings.go b/modules/jenkins/settings.go index 7669c7fb..9645ce1e 100644 --- a/modules/jenkins/settings.go +++ b/modules/jenkins/settings.go @@ -12,12 +12,12 @@ const defaultTitle = "Jenkins" type Settings struct { common *cfg.Common - apiKey string - jobNameRegex string - successBallColor string - url string - user string - verifyServerCertificate bool + apiKey string `help:"Your Jenkins API key."` + jobNameRegex string `help:"A regex that filters the jobs shown in the widget." optional:"true"` + successBallColor string `help:"Changes the default color of successful Jenkins jobs to the color of your choosing." values:"blue, green, purple, yellow, etc." optional:"true"` + url string `help:"The url to your Jenkins project or view."` + user string `help:"Your Jenkins username."` + verifyServerCertificate bool `help:"Determines whether or not the server’s certificate chain and host name are verified." values:"true or false" optional:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/jira/settings.go b/modules/jira/settings.go index 2fc176bf..887f560b 100644 --- a/modules/jira/settings.go +++ b/modules/jira/settings.go @@ -20,13 +20,13 @@ type Settings struct { colors common *cfg.Common - apiKey string - domain string - email string - jql string - projects []string - username string - verifyServerCertificate bool + apiKey string `help:"Your Jira API key."` + domain string `help:"Your Jira corporate domain."` + email string `help:"The email address associated with your Jira account."` + jql string `help:"Custom JQL to be appended to the search query." values:"See Search Jira like a boss with JQL for details." optional:"true"` + projects []string `help:"An array of projects to get data from"` + username string `help:"Your Jira username."` + verifyServerCertificate bool `help:"Determines whether or not the server’s certificate chain and host name are verified." values:"true or false" optional:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/mercurial/settings.go b/modules/mercurial/settings.go index 354fd6b7..5cb72155 100644 --- a/modules/mercurial/settings.go +++ b/modules/mercurial/settings.go @@ -10,9 +10,9 @@ const defaultTitle = "Mercurial" type Settings struct { common *cfg.Common - commitCount int - commitFormat string - repositories []interface{} + commitCount int `help:"The number of past commits to display." optional:"true"` + commitFormat string `help:"The string format for the commit message." optional:"true"` + repositories []interface{} `help:"Defines which mercurial repositories to watch." values:"A list of zero or more local file paths pointing to valid mercurial repositories."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/newrelic/settings.go b/modules/newrelic/settings.go index 7c72d3b8..cd0a15c2 100644 --- a/modules/newrelic/settings.go +++ b/modules/newrelic/settings.go @@ -12,9 +12,9 @@ const defaultTitle = "NewRelic" type Settings struct { common *cfg.Common - apiKey string - applicationID int - deployCount int + apiKey string `help:"Your New Relic API token."` + applicationID int `help:"The integer ID of the New Relic application you wish to report on."` + deployCount int `help:"The number of past deploys to display on screen." default:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/opsgenie/settings.go b/modules/opsgenie/settings.go index 0012e02a..99981313 100644 --- a/modules/opsgenie/settings.go +++ b/modules/opsgenie/settings.go @@ -12,10 +12,10 @@ const defaultTitle = "OpsGenie" type Settings struct { common *cfg.Common - apiKey string - displayEmpty bool - schedule []string - scheduleIdentifierType string + apiKey string `help:"Your OpsGenie API token."` + displayEmpty bool `help:"Whether schedules with no assigned person on-call should be displayed." optional:"true"` + schedule []string `help:"A list of names of the schedule(s) to retrieve."` + scheduleIdentifierType string `help:"Type of the schedule identifier." values:"id or name" optional:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/pagerduty/settings.go b/modules/pagerduty/settings.go index 3e6fa6ba..cba205de 100644 --- a/modules/pagerduty/settings.go +++ b/modules/pagerduty/settings.go @@ -12,11 +12,11 @@ const defaultTitle = "PagerDuty" type Settings struct { common *cfg.Common - apiKey string - escalationFilter []interface{} - scheduleIDs []interface{} - showIncidents bool - showSchedules bool + apiKey string `help:"Your PagerDuty API key."` + escalationFilter []interface{} `help:"An array of schedule names you want to filter on."` + scheduleIDs []interface{} `help:"An array of schedule IDs you want to restrict the query to."` + showIncidents bool `help:"Whether or not to list incidents." optional:"true"` + showSchedules bool `help:"Whether or not to show schedules." optional:"true"` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/power/settings.go b/modules/power/settings.go index eb61bd7b..d493d45b 100644 --- a/modules/power/settings.go +++ b/modules/power/settings.go @@ -9,8 +9,6 @@ const defaultTitle = "Power" type Settings struct { common *cfg.Common - - filePath string } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings { diff --git a/modules/rollbar/settings.go b/modules/rollbar/settings.go index 0c94dfe7..0799a708 100644 --- a/modules/rollbar/settings.go +++ b/modules/rollbar/settings.go @@ -10,12 +10,12 @@ const defaultTitle = "Rollbar" type Settings struct { common *cfg.Common - accessToken string - activeOnly bool - assignedToName string - count int - projectName string - projectOwner string + accessToken string `help:"Your Rollbar project access token (Only needs read capabilities)."` + activeOnly bool `help:"Only show items that are active." optional:"true"` + assignedToName string `help:"Set this to your username if you only want to see items assigned to you." optional:"true"` + count int `help:"How many items you want to see. 100 is max." optional:"true"` + projectName string `help:"This is used to create a link to the item."` + projectOwner string `help:"This is used to create a link to the item."` } func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {