Merge pull request #20 from vincenthou/feat-text-format

feat(format): support text format in console with color

.gitignore

@@ -22,3 +22,4 @@ _testmain.go
 *.exe
 *.test
 *.prof
+*.json

README.md

@@ -82,7 +82,7 @@ $ goreporter -p [projectRelativePath] -r [reportPath] -e [exceptPackagesName] -f
 - -p Must be a valid Golang project path.
 - -r Save the path to the report.
 - -e Exceptional packages (multiple separated by commas, for example: "linters/aligncheck,linters/cyclo" ).
-- -f report format json OR html.
+- -f report format json, html OR text.
 - -t Template path,if not specified, the default template will be used.
 
 By default, the default template is used to generate reports in html format.

engine/config.go

@@ -18,7 +18,7 @@ type Summary struct {
 }
 
 // Metric as template of report and will save all linters result
-// data.But may have some diffreence in diffrent linter.
+// data.But may have some difference in different linter.
 type Metric struct {
 	Name        string             `json:"name"`
 	Description string             `json:"description"`

engine/engine.go

@@ -33,7 +33,7 @@ func (w *WaitGroupWrapper) Wrap(cb func()) {
 }
 
 // NewReporter will return Reporter.
-func NewReporter(templateHtml string) *Reporter {
+func NewReporter() *Reporter {
 	return &Reporter{
 		Metrics: make(map[string]Metric, 0),
 		syncRW:  new(sync.RWMutex),

engine/engine_test.go

@@ -5,6 +5,6 @@ import (
 )
 
 func Test_Engine(t *testing.T) {
-	report := NewReporter("")
+	report := NewReporter()
 	report.Engine("../../logcool", "")
 }

linters/countcode/countcode_test.go

@@ -4,6 +4,6 @@ import (
 	"testing"
 )
 
-func Test_CountLines(t *testing.T) {
-	CountLines("../../../goreporter")
+func Test_CountCode(t *testing.T) {
+	CountCode("../../../goreporter")
 }

main.go

@@ -67,16 +67,20 @@ func main() {
 	}
 
 	startTime := strconv.FormatInt(time.Now().Unix(), 10)
-	reporter := engine.NewReporter(templateHtml)
+	reporter := engine.NewReporter()
 	reporter.Engine(*project, *except)
-	htmlData, err := tools.Json2Html(reporter.FormateReport2Json())
-	if err != nil {
-		glog.Errorln("Json2Html error")
-		return
-	}
+	jsonData := reporter.FormateReport2Json()
+
 	if *formate == "json" {
-		tools.SaveAsJson(reporter.FormateReport2Json(), *project, *report, startTime)
+		tools.SaveAsJson(jsonData, *project, *report, startTime)
+	} else if *formate == "text" {
+		tools.DisplayAsText(jsonData)
 	} else {
+		htmlData, err := tools.Json2Html(jsonData)
+		if err != nil {
+			glog.Errorln("Json2Html error")
+			return
+		}
 		tools.SaveAsHtml(htmlData, *project, *report, startTime, templateHtml)
 	}
 }

tools/report2html_test.go

@@ -1029,3 +1029,7 @@ func Test_SaveAsJson(t *testing.T) {
 func Test_SaveAsJson_NoPath(t *testing.T) {
 	SaveAsJson([]byte(structJson), `github.com/wgliang/logcool`, "/Users/xxxxxx/Documents/xxx/src/github.com/wgliang/logcool", "221242124214")
 }
+
+func Test_DisplayAsText(t *testing.T) {
+    DisplayAsText([]byte(structJson))
+}

tools/report2text.go

@@ -0,0 +1,65 @@
+package tools
+
+import (
+	"os"
+	"encoding/json"
+
+	"github.com/fatih/color"
+	"github.com/wgliang/goreporter/engine"
+)
+
+const (
+	headerTpl = `
+		                                                                                                        
+                                                                            _/                          
+     _/_/_/    _/_/    _/  _/_/    _/_/    _/_/_/      _/_/    _/  _/_/  _/_/_/_/    _/_/    _/  _/_/   
+  _/    _/  _/    _/  _/_/      _/_/_/_/  _/    _/  _/    _/  _/_/        _/      _/_/_/_/  _/_/        
+ _/    _/  _/    _/  _/        _/        _/    _/  _/    _/  _/          _/      _/        _/           
+  _/_/_/    _/_/    _/          _/_/_/  _/_/_/      _/_/    _/            _/_/    _/_/_/  _/            
+     _/                                _/                                                               
+_/_/                                  _/                                                                
+		
+	Project: %s 
+	Score: %d
+	Grade: %d
+	Time: %s
+	Issues: %d
+
+	`
+	metricsHeaderTpl = `>> %s Linter %s find:`
+	summaryHeaderTpl = ` %s: %s`
+	errorInfoTpl = `  %s at line %d`
+)
+
+// DisplayAsText will display the json data to console
+func DisplayAsText(jsonData []byte) {
+	var structData engine.Reporter
+	json.Unmarshal(jsonData, &structData)
+
+	color.Magenta(
+		headerTpl, 
+		structData.Project, 
+		structData.Score, 
+		structData.Grade, 
+		structData.TimeStamp, 
+		structData.Issues,
+	)
+	for _, metric := range structData.Metrics {
+		if metric.Name == "DependGraph" || 0 == len(metric.Summaries) {
+			continue
+		}
+		color.Cyan(metricsHeaderTpl, metric.Name, metric.Description)
+		for _, summary := range metric.Summaries {
+			color.Blue(summaryHeaderTpl, summary.Name, summary.Description)
+			for _, errorInfo := range summary.Errors {
+				color.Red(errorInfoTpl, errorInfo.ErrorString, errorInfo.LineNumber)
+			}
+		}
+	}
+
+	if structData.Issues > 0 {
+		os.Exit(1)
+	} else {
+		os.Exit(0)
+	}
+}