Merge pull request #38 from justaugustus/cleanup

commands: Default to remote checks and introduce `--local-only` flag

Author: k8s-ci-robot

commands/commands.go

@@ -45,22 +45,16 @@ func New() *cobra.Command {
 	}
 
 	// Submit types
-	cmd.PersistentFlags().BoolVar(
-		&rootOpts.local,
-		"local",
-		false,
-		"if specified, subcommands will only perform local checks",
-	)
 
 	cmd.PersistentFlags().BoolVar(
-		&rootOpts.remote,
-		"remote",
+		&rootOpts.localOnly,
+		"local-only",
 		false,
-		"if specified, subcommands will query against remotes defined in the config",
+		"if specified, subcommands will only perform local checks",
 	)
 
 	cmd.PersistentFlags().StringVar(
-		&rootOpts.config,
+		&rootOpts.configFile,
 		"config",
 		defaultConfigFile,
 		"configuration file location",
@@ -80,6 +74,38 @@ func New() *cobra.Command {
 		fmt.Sprintf("the logging verbosity, either %s", log.LevelNames()),
 	)
 
+	// START - Deprecated flags
+
+	// TODO: Remove in the next (post-v0.3.0) minor release
+	cmd.PersistentFlags().BoolVar(
+		&rootOpts.localOnly,
+		"local",
+		false,
+		"if specified, subcommands will only perform local checks",
+	)
+
+	// TODO: Remove in the next (post-v0.3.0) minor release
+	cmd.PersistentFlags().BoolVar(
+		&rootOpts.remote,
+		"remote",
+		false,
+		"if specified, subcommands will query against remotes defined in the config",
+	)
+
+	// nolint: errcheck
+	cmd.PersistentFlags().MarkDeprecated(
+		"local",
+		"and will be removed in a future release. Use --local-only instead.",
+	)
+
+	// nolint: errcheck
+	cmd.PersistentFlags().MarkDeprecated(
+		"remote",
+		"as remote checks now happen by default.",
+	)
+
+	// END - Deprecated flags
+
 	AddCommands(cmd)
 	return cmd
 }

commands/options.go

@@ -24,16 +24,21 @@ import (
 )
 
 type options struct {
+	// configuration options
+	localOnly bool
+	remote    bool
+
+	// path options
+	basePath   string
+	configFile string
+
+	// command options
 	logLevel string
-	local    bool
-	remote   bool
-	config   string
-	basePath string
 }
 
 // setAndValidate sets some default options and verifies if options are valid
 func (o *options) setAndValidate() error {
-	logrus.Info("Validating zeitgeist options...")
+	logrus.Debug("Validating zeitgeist options...")
 
 	if o.basePath != "" {
 		if _, err := os.Stat(o.basePath); os.IsNotExist(err) {

commands/validate.go

@@ -49,16 +49,20 @@ func addValidate(topLevel *cobra.Command) {
 func runValidate(opts *options) error {
 	client := dependencies.NewClient()
 
-	if opts.remote {
-		updates, err := client.RemoteCheck(opts.config)
+	if opts.localOnly {
+		if err := client.LocalCheck(opts.configFile, opts.basePath); err != nil {
+			return errors.Wrap(err, "checking local dependencies")
+		}
+	} else {
+		updates, err := client.RemoteCheck(opts.configFile)
 		if err != nil {
-			return errors.Wrap(err, "check remote dependencies")
+			return errors.Wrap(err, "checking remote dependencies")
 		}
 
 		for _, update := range updates {
 			fmt.Println(update)
 		}
 	}
 
-	return client.LocalCheck(opts.config, opts.basePath)
+	return nil
 }