Remove deprecated '--sort-by-XXX' flags

khos2ow · khos2ow · commit 258f4603fb18 · 2021-06-02T13:00:38.000-04:00
In v0.13.0 flags `--sort-by-required` and `--sort-by-type` have been
deprecated in favor of `--sort-by required` and `--sort-by type`
respectively. And they are completely being removed now (two releases
after original announcement)

Signed-off-by: Khosrow Moossavi &lt;khos2ow@gmail.com&gt;
diff --git a/cmd/root.go b/cmd/root.go
@@ -74,11 +74,6 @@ func NewCommand() *cobra.Command {
 	cmd.PersistentFlags().BoolVar(new(bool), "hide-all", false, "hide all sections (default false)")
 	cmd.PersistentFlags().MarkDeprecated("show-all", "more information: https://terraform-docs.io/user-guide/how-to/#visibility-of-sections\n\n") //nolint:errcheck,gosec
 	cmd.PersistentFlags().MarkDeprecated("hide-all", "more information: https://terraform-docs.io/user-guide/how-to/#visibility-of-sections\n\n") //nolint:errcheck,gosec
-
-	cmd.PersistentFlags().BoolVar(&config.Sort.Criteria.Required, "sort-by-required", false, "sort items by name and print required ones first (default false)")
-	cmd.PersistentFlags().BoolVar(&config.Sort.Criteria.Type, "sort-by-type", false, "sort items by type of them (default false)")
-	cmd.PersistentFlags().MarkDeprecated("sort-by-required", "use '--sort-by required' instead\n\n") //nolint:errcheck,gosec
-	cmd.PersistentFlags().MarkDeprecated("sort-by-type", "use '--sort-by type' instead\n\n")         //nolint:errcheck,gosec
 	// <==
 
 	cmd.PersistentFlags().StringVar(&config.HeaderFrom, "header-from", "main.tf", "relative path of a file to read header from")
diff --git a/internal/cli/config.go b/internal/cli/config.go
@@ -342,36 +342,22 @@ var allSorts = []string{
 // SortTypes list.
 var SortTypes = strings.Join(allSorts, ", ")
 
-type sortby struct {
-	Name     bool `name:"name"`
-	Required bool `name:"required"`
-	Type     bool `name:"type"`
-}
 type sort struct {
-	Enabled  bool   `mapstructure:"enabled"`
-	By       string `mapstructure:"by"`
-	Criteria sortby `mapstructure:"-"`
+	Enabled bool   `mapstructure:"enabled"`
+	By      string `mapstructure:"by"`
 }
 
 func defaultSort() sort {
 	return sort{
 		Enabled: true,
 		By:      sortName,
-		Criteria: sortby{
-			Name:     true,
-			Required: false,
-			Type:     false,
-		},
 	}
 }
 
 func (s *sort) validate() error {
 	if !contains(allSorts, s.By) {
 		return fmt.Errorf("'%s' is not a valid sort type", s.By)
 	}
-	if s.Criteria.Required && s.Criteria.Type {
-		return fmt.Errorf("'--sort-by-required' and '--sort-by-type' can't be used together")
-	}
 	return nil
 }
 
@@ -461,11 +447,6 @@ func (c *Config) process() error { //nolint:gocyclo
 		}
 	}
 
-	// Enable specified sort criteria
-	c.Sort.Criteria.Name = c.Sort.Enabled && c.Sort.By == sortName
-	c.Sort.Criteria.Required = c.Sort.Enabled && c.Sort.By == sortRequired
-	c.Sort.Criteria.Type = c.Sort.Enabled && c.Sort.By == sortType
-
 	return nil
 }
 
@@ -499,9 +480,9 @@ func (c *Config) extract() (*print.Settings, *terraform.Options) {
 	options.OutputValuesPath = c.OutputValues.From
 
 	// sort
-	options.SortBy.Name = c.Sort.Enabled && c.Sort.Criteria.Name
-	options.SortBy.Required = c.Sort.Enabled && c.Sort.Criteria.Required
-	options.SortBy.Type = c.Sort.Enabled && c.Sort.Criteria.Type
+	options.SortBy.Name = c.Sort.Enabled && c.Sort.By == sortName
+	options.SortBy.Required = c.Sort.Enabled && c.Sort.By == sortRequired
+	options.SortBy.Type = c.Sort.Enabled && c.Sort.By == sortType
 
 	// settings
 	settings.EscapeCharacters = c.Settings.Escape
