tablizer/cmd/root.go

/*
Copyright © 2022-2025 Thomas von Dein

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package cmd

import (
	"errors"
	"fmt"
	"os"
	"slices"
	"strings"

	"github.com/spf13/cobra"
	"codeberg.org/scip/tablizer/cfg"
	"codeberg.org/scip/tablizer/lib"
)

func completion(cmd *cobra.Command, mode string) error {
	switch mode {
	case "bash":
		return cmd.Root().GenBashCompletion(os.Stdout)
	case "zsh":
		return cmd.Root().GenZshCompletion(os.Stdout)
	case "fish":
		return cmd.Root().GenFishCompletion(os.Stdout, true)
	case "powershell":
		return cmd.Root().GenPowerShellCompletionWithDesc(os.Stdout)
	default:
		return errors.New("invalid shell parameter! Valid ones: bash|zsh|fish|powershell")
	}
}

// we die with exit 1 if there's an error
func wrapE(err error) {
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	}
}

func Execute() {
	var (
		conf           cfg.Config
		ShowManual     bool
		ShowVersion    bool
		ShowCompletion string
		modeflag       cfg.Modeflag
		sortmode       cfg.Sortmode
		headers        string
	)

	var rootCmd = &cobra.Command{
		Use:   "tablizer [regex] [file, ...]",
		Short: "[Re-]tabularize tabular data",
		Long:  `Manipulate tabular output of other programs`,

		Run: func(cmd *cobra.Command, args []string) {
			if ShowVersion {
				fmt.Println(cfg.Getversion())

				return
			}

			if ShowManual {
				lib.Pager("tablizer manual page", manpage)

				return
			}

			if len(ShowCompletion) > 0 {
				wrapE(completion(cmd, ShowCompletion))

				return
			}

			// Setup
			wrapE(conf.ParseConfigfile())

			conf.CheckEnv()
			conf.PrepareModeFlags(modeflag)
			conf.PrepareSortFlags(sortmode)
			conf.PrepareCustomHeaders(headers)

			wrapE(conf.PrepareFilters())

			conf.DetermineColormode()
			conf.ApplyDefaults()

			// actual execution starts here
			wrapE(lib.ProcessFiles(&conf, args))
		},
	}

	// options
	rootCmd.PersistentFlags().BoolVarP(&conf.Debug, "debug", "d", false,
		"Enable debugging")
	rootCmd.PersistentFlags().BoolVarP(&conf.Numbering, "numbering", "n", false,
		"Disable header numbering")
	rootCmd.PersistentFlags().BoolVarP(&conf.NoHeaders, "no-headers", "H", false,
		"Disable header display")
	rootCmd.PersistentFlags().BoolVarP(&conf.NoColor, "no-color", "N", false,
		"Disable pattern highlighting")
	rootCmd.PersistentFlags().BoolVarP(&ShowVersion, "version", "V", false,
		"Print program version")
	rootCmd.PersistentFlags().BoolVarP(&conf.InvertMatch, "invert-match", "v", false,
		"select non-matching rows")
	rootCmd.PersistentFlags().BoolVarP(&ShowManual, "man", "m", false,
		"Display manual page")
	rootCmd.PersistentFlags().BoolVarP(&conf.UseFuzzySearch, "fuzzy", "z", false,
		"Use fuzzy searching")
	rootCmd.PersistentFlags().BoolVarP(&conf.UseHighlight, "highlight-lines", "L", false,
		"Use alternating background colors")
	rootCmd.PersistentFlags().StringVarP(&ShowCompletion, "completion", "", "",
		"Display completion code")
	rootCmd.PersistentFlags().StringVarP(&conf.Separator, "separator", "s", cfg.SeparatorTemplates[":default:"],
		"Custom field separator")
	rootCmd.PersistentFlags().StringVarP(&conf.Columns, "columns", "c", "",
		"Only show the speficied columns (separated by ,)")
	rootCmd.PersistentFlags().StringVarP(&conf.YankColumns, "yank-columns", "y", "",
		"Yank the speficied columns (separated by ,) to the clipboard")
	rootCmd.PersistentFlags().StringVarP(&conf.TransposeColumns, "transpose-columns", "T", "",
		"Transpose the speficied columns (separated by ,)")
	rootCmd.PersistentFlags().BoolVarP(&conf.Interactive, "interactive", "I", false,
		"interactive mode")
	rootCmd.PersistentFlags().StringVarP(&conf.OFS, "ofs", "o", "",
		"Output field separator (' ' for ascii table, ',' for CSV)")
	rootCmd.PersistentFlags().BoolVarP(&conf.InputJSON, "json", "j", false,
		"JSON input mode")
	rootCmd.PersistentFlags().BoolVarP(&conf.AutoHeaders, "auto-headers", "g", false,
		"Generate headers automatically")
	rootCmd.PersistentFlags().StringVarP(&headers, "custom-headers", "x", "",
		"Custom headers")

	// sort options
	rootCmd.PersistentFlags().StringVarP(&conf.SortByColumn, "sort-by", "k", "",
		"Sort by column (default: 1)")

	// sort mode, only 1 allowed
	rootCmd.PersistentFlags().BoolVarP(&conf.SortDescending, "sort-desc", "D", false,
		"Sort in descending order (default: ascending)")
	rootCmd.PersistentFlags().BoolVarP(&sortmode.Numeric, "sort-numeric", "i", false,
		"sort according to string numerical value")
	rootCmd.PersistentFlags().BoolVarP(&sortmode.Time, "sort-time", "t", false,
		"sort according to time string")
	rootCmd.PersistentFlags().BoolVarP(&sortmode.Age, "sort-age", "a", false,
		"sort according to age (duration) string")
	rootCmd.MarkFlagsMutuallyExclusive("sort-numeric", "sort-time",
		"sort-age")

	// output flags, only 1 allowed
	rootCmd.PersistentFlags().BoolVarP(&modeflag.X, "extended", "X", false,
		"Enable extended output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.M, "markdown", "M", false,
		"Enable markdown table output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.O, "orgtbl", "O", false,
		"Enable org-mode table output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.S, "shell", "S", false,
		"Enable shell mode output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.Y, "yaml", "Y", false,
		"Enable yaml output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.J, "jsonout", "J", false,
		"Enable json output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.C, "csv", "C", false,
		"Enable CSV output")
	rootCmd.PersistentFlags().BoolVarP(&modeflag.A, "ascii", "A", false,
		"Enable ASCII output (default)")
	rootCmd.MarkFlagsMutuallyExclusive("extended", "markdown", "orgtbl",
		"shell", "yaml", "csv")

	// config file
	rootCmd.PersistentFlags().StringVarP(&conf.Configfile, "config", "f", cfg.DefaultConfigfile,
		"config file (default: ~/.config/tablizer/config)")

	// filters
	rootCmd.PersistentFlags().StringArrayVarP(&conf.Rawfilters,
		"filter", "F", nil, "Filter by field (field=regexp || field!=regexp)")
	rootCmd.PersistentFlags().StringArrayVarP(&conf.Transposers,
		"regex-transposer", "R", nil, "apply /search/replace/ regexp to fields given in -T")

	// input
	rootCmd.PersistentFlags().StringVarP(&conf.InputFile, "read-file", "r", "",
		"Read input data from file")

	rootCmd.SetUsageTemplate(strings.TrimSpace(usage) + "\n")

	if slices.Contains(os.Args, "-h") {
		fmt.Println(shortusage)
		os.Exit(0)
	}

	err := rootCmd.Execute()
	if err != nil {
		os.Exit(1)
	}
}