Merge pull request #1 from TLINDEN/development

Dev => main

.circleci/config.yml

@@ -0,0 +1,38 @@
+---
+version: 2.1
+
+jobs:
+  compile:
+    docker:
+    - image: cimg/go:1.18
+    steps:
+    - checkout
+    - run: make
+
+  test:
+    parameters:
+      go_version:
+        type: string
+      run_test:
+        type: boolean
+        default: true
+    docker:
+    - image: cimg/go:<< parameters.go_version >>
+    steps:
+    - checkout
+    - run: make test
+
+workflows:
+  version: 2
+  unit-test:
+    jobs:
+    - compile
+    - test:
+        name: testing
+        matrix:
+          parameters:
+            go_version:
+            - "1.16"
+            - "1.17"
+            - "1.18"
+            - "1.19"

Makefile

@@ -18,16 +18,16 @@
 #
 # no need to modify anything below
 tool    = tablizer
-version = $(shell egrep "^var version = " cmd/root.go | cut -d'=' -f2 | cut -d'"' -f 2)
+version = $(shell egrep "^var Version = " lib/common.go | cut -d'=' -f2 | cut -d'"' -f 2)
 archs   = android darwin freebsd linux netbsd openbsd windows
 PREFIX = /usr/local
 UID    = root
 GID    = 0
 
-all: buildlocal man
+all: buildlocal $(tool).1
 
-man:
-	pod2man -c "User Commands" -r 1 -s 1 $(tool).pod > $(tool).1
+%.1: %.pod
+	pod2man -c "User Commands" -r 1 -s 1 $*.pod > $*.1
 
 buildlocal:
 	go build
@@ -43,4 +43,7 @@ install: buildlocal
 	install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/
 
 clean:
-	rm -f $(tool) $(tool).1
+	rm -rf $(tool) $(tool).1 releases
+
+test:
+	go test -v ./...

README.md

@@ -1,3 +1,5 @@
+[![<ORG_NAME>](https://circleci.com/gh/TLINDEN/tablizer.svg?style=svg)](https://app.circleci.com/pipelines/github/TLINDEN/tablizer)
+
 ## tablizer - Manipulate tabular output of other programs
 
 Tablizer  can   be  used   to  re-format   tabular  output   of  other

TODO

@@ -3,4 +3,3 @@ Add a mode like FreeBSD stat(1):
 stat -s dead.letter 
 st_dev=170671546954750497 st_ino=159667 st_mode=0100644 st_nlink=1 st_uid=1001 st_gid=1001 st_rdev=18446744073709551615 st_size=573 st_atime=1661994007 st_mtime=1661961878 st_ctime=1661961878 st_birthtime=1658394900 st_blksize=4096 st_blocks=3 st_flags=2048
 
-mv UseColumns processing out of process()

cmd/root.go

@@ -17,35 +17,36 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 package cmd
 
 import (
+	"daemon.de/tablizer/lib"
 	"fmt"
 	"github.com/spf13/cobra"
 	"os"
 )
 
-var version = "v1.0.1"
-
 var rootCmd = &cobra.Command{
 	Use:   "tablizer [regex] [file, ...]",
 	Short: "[Re-]tabularize tabular data",
 	Long:  `Manipulate tabular output of other programs`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		if Version {
-			fmt.Printf("This is tablizer version %s\n", version)
+		if lib.ShowVersion {
+			fmt.Printf("This is tablizer version %s\n", lib.Version)
 			return nil
 		}
 
-		return process(args)
+		err := lib.PrepareColumns()
+		if err != nil {
+			return err
+		}
+
+		err = lib.PrepareModeFlags()
+		if err != nil {
+			return err
+		}
+
+		return lib.ProcessFiles(args)
 	},
 }
 
-var Debug bool
-var XtendedOut bool
-var NoNumbering bool
-var Version bool
-var Columns string
-var UseColumns []int
-var Separator string
-
 func Execute() {
 	err := rootCmd.Execute()
 	if err != nil {
@@ -54,10 +55,21 @@ func Execute() {
 }
 
 func init() {
-	rootCmd.PersistentFlags().BoolVarP(&Debug, "debug", "d", false, "Enable debugging")
-	rootCmd.PersistentFlags().BoolVarP(&XtendedOut, "extended", "x", false, "Enable extended output")
-	rootCmd.PersistentFlags().BoolVarP(&NoNumbering, "no-numbering", "n", false, "Disable header numbering")
-	rootCmd.PersistentFlags().BoolVarP(&Version, "version", "v", false, "Print program version")
-	rootCmd.PersistentFlags().StringVarP(&Separator, "separator", "s", "", "Custom field separator")
-	rootCmd.PersistentFlags().StringVarP(&Columns, "columns", "c", "", "Only show the speficied columns (separated by ,)")
+	rootCmd.PersistentFlags().BoolVarP(&lib.Debug, "debug", "d", false, "Enable debugging")
+	rootCmd.PersistentFlags().BoolVarP(&lib.NoNumbering, "no-numbering", "n", false, "Disable header numbering")
+	rootCmd.PersistentFlags().BoolVarP(&lib.ShowVersion, "version", "v", false, "Print program version")
+	rootCmd.PersistentFlags().StringVarP(&lib.Separator, "separator", "s", "", "Custom field separator")
+	rootCmd.PersistentFlags().StringVarP(&lib.Columns, "columns", "c", "", "Only show the speficied columns (separated by ,)")
+
+	// output flags, only 1 allowed, hidden, since just short cuts
+	rootCmd.PersistentFlags().BoolVarP(&lib.OutflagExtended, "extended", "X", false, "Enable extended output")
+	rootCmd.PersistentFlags().BoolVarP(&lib.OutflagMarkdown, "markdown", "M", false, "Enable markdown table output")
+	rootCmd.PersistentFlags().BoolVarP(&lib.OutflagOrgtable, "orgtbl", "O", false, "Enable org-mode table output")
+	rootCmd.MarkFlagsMutuallyExclusive("extended", "markdown", "orgtbl")
+	rootCmd.Flags().MarkHidden("extended")
+	rootCmd.Flags().MarkHidden("orgtbl")
+	rootCmd.Flags().MarkHidden("markdown")
+
+	// same thing but more common, takes precedence over above group
+	rootCmd.PersistentFlags().StringVarP(&lib.OutputMode, "output", "o", "", "Output mode - one of: orgtbl, markdown, extended, ascii(default)")
 }

go.mod

@@ -2,11 +2,15 @@ module daemon.de/tablizer
 
 go 1.18
 
-require github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897
+require (
+	github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897
+	github.com/olekukonko/tablewriter v0.0.5
+	github.com/spf13/cobra v1.5.0
+)
 
 require (
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/spf13/cobra v1.5.0 // indirect
+	github.com/mattn/go-runewidth v0.0.9 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/stretchr/testify v1.8.0 // indirect
 )

go.sum

@@ -6,6 +6,10 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
+github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
+github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=

lib/common.go

@@ -0,0 +1,34 @@
+/*
+Copyright © 2022 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 lib
+
+// command line flags
+var Debug bool
+var XtendedOut bool
+var NoNumbering bool
+var ShowVersion bool
+var Columns string
+var UseColumns []int
+var Separator string
+var OutflagExtended bool
+var OutflagMarkdown bool
+var OutflagOrgtable bool
+var OutputMode string
+
+var Version = "v1.0.2"
+var validOutputmodes = "(orgtbl|markdown|extended|ascii)"