fix: update travis step and file organization (swaggo#59)

* file organization

* create Makefile(lint, build, test, deps)

* update travis step

* fix lint error

* update readme

.gitignore

@@ -1,6 +1,13 @@
+swag
+example/simple/docs
+
 # Test binary, build with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-.idea
+.idea
+.vscode
+
+# Etc
+.DS_Store

.golint_exclude

@@ -0,0 +1 @@
+^example

.travis.yml

@@ -6,10 +6,13 @@ go:
   - 1.10.x
 
 before_install:
-  - go get -t -v ./...
+  - make deps
 
 script:
+  - make lint
+  - make build
+  - make test
   - go test -race -coverprofile=coverage.txt -covermode=atomic
 
 after_success:
-  - bash <(curl -s https://codecov.io/bash)
+  - bash <(curl -s https://codecov.io/bash)

Makefile

@@ -0,0 +1,38 @@
+#! /usr/bin/make
+GOCMD=$(shell which go)
+GOLINT=$(shell which golint)
+GOIMPORT=$(shell which goimports)
+GOBUILD=$(GOCMD) build
+GOCLEAN=$(GOCMD) clean
+GOTEST=$(GOCMD) test
+GOGET=$(GOCMD) get
+GOLIST=$(GOCMD) list
+BINARY_NAME=swag
+
+all: test build
+
+build:
+	$(GOBUILD) -o $(BINARY_NAME) -v ./cmd/...
+
+test:
+	$(GOTEST) -v ./...
+
+clean:
+	$(GOCLEAN)
+	rm -f $(BINARY_NAME)
+
+DIRS=$(shell $(GOLIST) -f {{.Dir}} ./...)
+lint:
+	@for d in $(DIRS) ; do \
+		if [ "`$(GOIMPORT) -l $$d/*.go | tee /dev/stderr`" ]; then \
+			echo "^ - Repo contains improperly formatted go files" && echo && exit 1; \
+		fi \
+	done
+	@if [ "`$(GOLINT) ./... | grep -vf .golint_exclude | tee /dev/stderr`" ]; then \
+		echo "^ - Lint errors!" && echo && exit 1; \
+	fi
+
+deps:
+	$(GOGET) -v ./...
+	$(GOGET) github.com/stretchr/testify/assert
+	$(GOGET) github.com/golang/lint/golint

README.md

@@ -165,8 +165,10 @@ type Pet3 struct {
 ```
 
 ## Supported Web Framework
-- [gin-swagger](http://github.com/swaggo/gin-swagger)
-- [echo-swagger](http://github.com/swaggo/echo-swagger)
+- [gin](http://github.com/swaggo/gin-swagger)
+- [echo](http://github.com/swaggo/echo-swagger)
+- [net/http](https://github.com/swaggo/http-swagger)
+- revel
 
 ## Limitation
 - Not supported for array of structs

cmd/swag/main.go

@@ -19,8 +19,8 @@ func main() {
 			Usage:   "create docs.go",
 			Action: func(c *cli.Context) error {
 				searchDir := "./"
-				mainApiFile := "./main.go"
-				gen.New().Build(searchDir, mainApiFile)
+				mainAPIFile := "./main.go"
+				gen.New().Build(searchDir, mainAPIFile)
 				return nil
 			},
 		},

gen/gen.go

@@ -20,11 +20,11 @@ func New() *Gen {
 	return &Gen{}
 }
 
-// Build builds swagger json file  for gived searchDir and mainApiFile. Returns json
-func (g *Gen) Build(searchDir, mainApiFile string) (string, error) {
+// Build builds swagger json file  for gived searchDir and mainAPIFile. Returns json
+func (g *Gen) Build(searchDir, mainAPIFile string) (string, error) {
 	log.Println("Generate swagger docs....")
 	p := swag.New()
-	p.ParseApi(searchDir, mainApiFile)
+	p.ParseAPI(searchDir, mainAPIFile)
 	swagger := p.GetSwagger()
 
 	b, _ := json.MarshalIndent(swagger, "", "    ")