Merge pull request #491 from Seanstoppable/evenmoremoresettings

Add help strings from h-r

modules/hackernews/settings.go

@@ -10,8 +10,8 @@ const defaultTitle = "HackerNews"
 type Settings struct {
 	common *cfg.Common
 
-	numberOfStories int
+	numberOfStories int    `help:"Defines number of stories to be displayed. Default is 10" optional:"true"`
-	storyType       string
+	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 {

modules/hibp/settings.go

@@ -23,8 +23,8 @@ type Settings struct {
 	colors
 	common *cfg.Common
 
-	accounts []string
+	accounts []string `help:"A list of the accounts to check the HIBP database for."`
-	since    string
+	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

modules/jenkins/settings.go

@@ -12,12 +12,12 @@ const defaultTitle = "Jenkins"
 type Settings struct {
 	common *cfg.Common
 
-	apiKey                  string
+	apiKey                  string `help:"Your Jenkins API key."`
-	jobNameRegex            string
+	jobNameRegex            string `help:"A regex that filters the jobs shown in the widget." optional:"true"`
-	successBallColor        string
+	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
+	url                     string `help:"The url to your Jenkins project or view."`
-	user                    string
+	user                    string `help:"Your Jenkins username."`
-	verifyServerCertificate bool
+	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 {

modules/jira/settings.go

@@ -20,13 +20,13 @@ type Settings struct {
 	colors
 	common *cfg.Common
 
-	apiKey                  string
+	apiKey                  string   `help:"Your Jira API key."`
-	domain                  string
+	domain                  string   `help:"Your Jira corporate domain."`
-	email                   string
+	email                   string   `help:"The email address associated with your Jira account."`
-	jql                     string
+	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
+	projects                []string `help:"An array of projects to get data from"`
-	username                string
+	username                string   `help:"Your Jira username."`
-	verifyServerCertificate bool
+	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 {

modules/mercurial/settings.go

@@ -10,9 +10,9 @@ const defaultTitle = "Mercurial"
 type Settings struct {
 	common *cfg.Common
 
-	commitCount  int
+	commitCount  int           `help:"The number of past commits to display." optional:"true"`
-	commitFormat string
+	commitFormat string        `help:"The string format for the commit message." optional:"true"`
-	repositories []interface{}
+	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 {

modules/newrelic/settings.go

@@ -12,9 +12,9 @@ const defaultTitle = "NewRelic"
 type Settings struct {
 	common *cfg.Common
 
-	apiKey        string
+	apiKey        string `help:"Your New Relic API token."`
-	applicationID int
+	applicationID int    `help:"The integer ID of the New Relic application you wish to report on."`
-	deployCount   int
+	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 {

modules/opsgenie/settings.go

@@ -12,10 +12,10 @@ const defaultTitle = "OpsGenie"
 type Settings struct {
 	common *cfg.Common
 
-	apiKey                 string
+	apiKey                 string   `help:"Your OpsGenie API token."`
-	displayEmpty           bool
+	displayEmpty           bool     `help:"Whether schedules with no assigned person on-call should be displayed." optional:"true"`
-	schedule               []string
+	schedule               []string `help:"A list of names of the schedule(s) to retrieve."`
-	scheduleIdentifierType string
+	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 {

modules/pagerduty/settings.go

@@ -12,11 +12,11 @@ const defaultTitle = "PagerDuty"
 type Settings struct {
 	common *cfg.Common
 
-	apiKey           string
+	apiKey           string        `help:"Your PagerDuty API key."`
-	escalationFilter []interface{}
+	escalationFilter []interface{} `help:"An array of schedule names you want to filter on."`
-	scheduleIDs      []interface{}
+	scheduleIDs      []interface{} `help:"An array of schedule IDs you want to restrict the query to."`
-	showIncidents    bool
+	showIncidents    bool          `help:"Whether or not to list incidents." optional:"true"`
-	showSchedules    bool
+	showSchedules    bool          `help:"Whether or not to show schedules." optional:"true"`
 }
 
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {

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 {

modules/rollbar/settings.go

@@ -10,12 +10,12 @@ const defaultTitle = "Rollbar"
 type Settings struct {
 	common *cfg.Common
 
-	accessToken    string
+	accessToken    string `help:"Your Rollbar project access token (Only needs read capabilities)."`
-	activeOnly     bool
+	activeOnly     bool   `help:"Only show items that are active." optional:"true"`
-	assignedToName string
+	assignedToName string `help:"Set this to your username if you only want to see items assigned to you." optional:"true"`
-	count          int
+	count          int    `help:"How many items you want to see. 100 is max." optional:"true"`
-	projectName    string
+	projectName    string `help:"This is used to create a link to the item."`
-	projectOwner   string
+	projectOwner   string `help:"This is used to create a link to the item."`
 }
 
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {