Added new experimental 'output' module to replace formatter

Author: cmaglie

Gopkg.lock

@@ -21,6 +21,8 @@ import (
 	"io/ioutil"
 	"os"
 
+	"github.com/arduino/arduino-cli/output"
+
 	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/mattn/go-colorable"
@@ -96,6 +98,10 @@ func preRun(cmd *cobra.Command, args []string) {
 		commands.GlobalFlags.Format = "text"
 	}
 	formatter.SetFormatter(commands.GlobalFlags.Format)
+	if commands.GlobalFlags.Format != "text" {
+		output.SetOutputKind(output.JSON)
+	}
+
 	logrus.Info("Formatter set")
 	if !formatter.IsCurrentFormat("text") {
 		cmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {

commands/root/root.go

@@ -0,0 +1,53 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
+ *
+ * This software is released under the GNU General Public License version 3,
+ * which covers the main part of arduino-cli.
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to [email protected].
+ */
+
+package output
+
+import (
+	"fmt"
+
+	colorable "github.com/mattn/go-colorable"
+)
+
+var colorStdout = colorable.NewColorableStdout()
+
+type Output interface {
+	EmitTerminal() string
+	EmitJSON() string
+}
+
+type OutputKind int
+
+const (
+	Terminal OutputKind = iota
+	JSON
+)
+
+var defaultOutputKind = Terminal
+
+func SetOutputKind(kind OutputKind) {
+	defaultOutputKind = kind
+}
+
+func Emit(data Output) {
+	switch defaultOutputKind {
+	case Terminal:
+		fmt.Fprint(colorStdout, data.EmitTerminal())
+	case JSON:
+		fmt.Print(data.EmitJSON())
+	}
+}

output/output.go

@@ -0,0 +1,152 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
+ *
+ * This software is released under the GNU General Public License version 3,
+ * which covers the main part of arduino-cli.
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to [email protected].
+ */
+
+package output
+
+import (
+	"fmt"
+	"math"
+)
+
+type Table struct {
+	hasHeader        bool
+	columnsCount     int
+	columnsWidthMode []TableColumnWidthMode
+	rows             []*TableRow
+}
+
+type TableRow struct {
+	cells []TextBox
+}
+
+func NewTable() *Table {
+	return &Table{
+		rows: []*TableRow{},
+	}
+}
+
+type TableColumnWidthMode int
+
+const (
+	Minimum TableColumnWidthMode = iota
+	Average
+)
+
+func (t *Table) SetColumnWidthMode(x int, mode TableColumnWidthMode) {
+	for len(t.columnsWidthMode) <= x {
+		t.columnsWidthMode = append(t.columnsWidthMode, Minimum)
+	}
+	t.columnsWidthMode[x] = mode
+}
+
+func (t *Table) makeTableRow(columns ...interface{}) *TableRow {
+	columnsCount := len(columns)
+	if t.columnsCount < columnsCount {
+		t.columnsCount = columnsCount
+	}
+	cells := make([]TextBox, columnsCount)
+	for i, col := range columns {
+		switch text := col.(type) {
+		case TextBox:
+			cells[i] = text
+		case string:
+			cells[i] = Sprintf("%s", text)
+		case fmt.Stringer:
+			cells[i] = Sprintf("%s", text.String())
+		default:
+			panic(fmt.Sprintf("invalid column argument type: %t", col))
+		}
+	}
+	return &TableRow{cells: cells}
+}
+
+func (t *Table) SetHeader(columns ...interface{}) {
+	row := t.makeTableRow(columns...)
+	if t.hasHeader {
+		t.rows[0] = row
+	} else {
+		t.rows = append([]*TableRow{row}, t.rows...)
+		t.hasHeader = true
+	}
+}
+
+func (t *Table) AddRow(columns ...interface{}) {
+	row := t.makeTableRow(columns...)
+	t.rows = append(t.rows, row)
+}
+
+func (t *Table) Render() string {
+	// find max width for each row
+	average := make([]int, t.columnsCount)
+	widths := make([]int, t.columnsCount)
+	count := make([]int, t.columnsCount)
+	for _, row := range t.rows {
+		for x, cell := range row.cells {
+			l := cell.Len()
+			if l == 0 {
+				continue
+			}
+			count[x]++
+			average[x] += l
+			if cell.Len() > widths[x] {
+				widths[x] = l
+			}
+		}
+	}
+	for x := range average {
+		average[x] = average[x] / count[x]
+	}
+	// fmt.Println("COUNT:", count)
+	// fmt.Println("MAX  :", widths)
+	// fmt.Println("AVG  :", average)
+	variance := make([]int, t.columnsCount)
+	for _, row := range t.rows {
+		for x, cell := range row.cells {
+			l := cell.Len()
+			if l == 0 {
+				continue
+			}
+			d := l - average[x]
+			variance[x] += d * d
+		}
+	}
+	for x := range variance {
+		variance[x] = int(math.Sqrt(float64(variance[x] / count[x])))
+	}
+	// fmt.Println("VAR  :", variance)
+
+	res := ""
+	for _, row := range t.rows {
+		separator := ""
+		for x, cell := range row.cells {
+			selectedWidth := widths[x]
+			if x < len(t.columnsWidthMode) {
+				switch t.columnsWidthMode[x] {
+				case Minimum:
+					selectedWidth = widths[x]
+				case Average:
+					selectedWidth = average[x] + variance[x]*2
+				}
+			}
+			res += separator
+			res += cell.Pad(selectedWidth)
+			separator = " "
+		}
+		res += "\n"
+	}
+	return res
+}

output/table.go

@@ -0,0 +1,114 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
+ *
+ * This software is released under the GNU General Public License version 3,
+ * which covers the main part of arduino-cli.
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to [email protected].
+ */
+
+package output
+
+import (
+	"fmt"
+
+	"github.com/fatih/color"
+)
+
+var red = color.New(color.FgRed).SprintfFunc()
+var blue = color.New(color.FgBlue).SprintfFunc()
+var green = color.New(color.FgGreen).SprintfFunc()
+var yellow = color.New(color.FgYellow).SprintfFunc()
+
+func Red(in string) *Text {
+	return &Text{raw: red(in), clean: in}
+}
+
+func Blue(in string) *Text {
+	return &Text{raw: blue(in), clean: in}
+}
+
+func Green(in string) *Text {
+	return &Text{raw: green(in), clean: in}
+}
+
+func Yellow(in string) *Text {
+	return &Text{raw: yellow(in), clean: in}
+}
+
+type TextBox interface {
+	Len() int
+	Pad(availableWidth int) string
+}
+
+type Text struct {
+	clean   string
+	raw     string
+	justify int
+}
+
+func (t *Text) Len() int {
+	return len(t.clean)
+}
+
+// func (t *Text) String() string {
+// 	return t.raw
+// }
+
+func (t *Text) JustifyLeft() {
+	t.justify = 0
+}
+
+func (t *Text) JustifyCenter() {
+	t.justify = 1
+}
+
+func (t *Text) JustifyRight() {
+	t.justify = 2
+}
+
+func (t *Text) Pad(totalLen int) string {
+	delta := totalLen - t.Len()
+	switch t.justify {
+	case 0:
+		return t.raw + spaces(delta)
+	case 1:
+		return spaces(delta/2) + t.raw + spaces(delta-delta/2)
+	case 2:
+		return spaces(delta) + t.raw
+	}
+	panic(fmt.Sprintf("internal error: invalid justify %d", t.justify))
+}
+
+func spaces(n int) string {
+	res := ""
+	for n > 0 {
+		res += " "
+		n--
+	}
+	return res
+}
+
+func Sprintf(format string, args ...interface{}) TextBox {
+	cleanArgs := make([]interface{}, len(args))
+	for i, arg := range args {
+		if text, ok := arg.(*Text); ok {
+			cleanArgs[i], args[i] = text.clean, text.raw
+		} else {
+			cleanArgs[i] = args[i]
+		}
+	}
+
+	return &Text{
+		clean: fmt.Sprintf(format, cleanArgs...),
+		raw:   fmt.Sprintf(format, args...),
+	}
+}