gcodesharp's Introduction

GCodeSharp

GCodeSharp is a CLI library for Go language code review applications. This application is a tool to generate the report to quickly review the golang code.

Install

go get -u github.com/ysqi/gcodesharp

TODO

Get Help

you need run application with args -h(-help) to get help.

Usage:
  gcodesharp [flags]

Flags:
  -h, --help               help for gcodesharp
  -j, --junit string       save report as junit xml file
  -t, --tool stringArray   specify which tool to exec (default [gtest,gfmt,glint])

you can add issue to ask me.

Easy Start

run check for current and each child dictionary, and save reporter to junit.xml file.

gcodesharp -j=junit.xml  ./...

Get Junit Report

gcodesharp support more one golang project package path . default is current dir if not set.

gcodesharp --junit=$HOME/tmp/myjunit.xml github.com/ysqi/gcodesharp github.com/ysqi/com

this command will run go test for current dir and all child dir. Is actually equivalent to the following command:

go test -cover -timeout 30s -v github.com/ysqi/gcodesharp... github.com/ysqi/com...
gofmt -d -e  [all go files of $GOPATH/src/github.com/ysqi/gcodesharp]

github.com/ysqi/gcodesharp... mean contains import path prefixed with github.com/ysqi/gcodesharp.

Note: gofmt result as a part of go test. and the result will write to junit file as a testsuite, such like this:

<testsuite tests="226" failures="0" errors="0" time="2.4243922" name="/usr/local/go/bin/gofmt" timestamp="2017-10-08T23:39:45">
	<properties>
		<property name="go.version" value="go1.8"></property>
		<property name="os" value="darwin"></property>
		<property name="arch" value="amd64"></property>
	</properties>
	<testcase classname="gofmt" name="gfmt/gfmt.go" time="0"></testcase>
	...
<testsuite>

Recommend Projects