forked from caixw/apidoc
/
main.go
186 lines (160 loc) · 4.49 KB
/
main.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
// Copyright 2015 by caixw, All rights reserved.
// Use of this source code is governed by a MIT
// license that can be found in the LICENSE file.
// apidoc 是一个 RESTful API 文档生成工具。
package main
import (
"bytes"
"flag"
"io/ioutil"
"log"
"os"
"path/filepath"
"runtime"
"runtime/pprof"
"strings"
"github.com/issue9/logs/writers"
"github.com/issue9/term/colors"
"github.com/issue9/version"
yaml "gopkg.in/yaml.v2"
"github.com/tanxiaolong/apidoc/input"
"github.com/tanxiaolong/apidoc/locale"
"github.com/tanxiaolong/apidoc/output"
"github.com/tanxiaolong/apidoc/vars"
"fmt"
)
// 日志信息输出
var (
info = newLog(os.Stdout, vars.InfoColor, "[INFO] ")
warn = newLog(os.Stderr, vars.WarnColor, "[WARN] ")
erro = newLog(os.Stderr, vars.ErroColor, "[ERRO] ")
)
// 确保第一时间初始化本地化信息
func init() {
if err := locale.Init(); err != nil {
warn.Println(err)
return
}
info.SetPrefix(locale.Sprintf(locale.InfoPrefix))
warn.SetPrefix(locale.Sprintf(locale.WarnPrefix))
erro.SetPrefix(locale.Sprintf(locale.ErrorPrefix))
}
func main() {
h := flag.Bool("h", false, locale.Sprintf(locale.FlagHUsage))
v := flag.Bool("v", false, locale.Sprintf(locale.FlagVUsage))
g := flag.Bool("g", false, locale.Sprintf(locale.FlagGUsage))
wd := flag.String("wd", "./", locale.Sprintf(locale.FlagWDUsage))
languages := flag.Bool("languages", false, locale.Sprintf(locale.FlagLanguagesUsage))
encodings := flag.Bool("encodings", false, locale.Sprintf(locale.FlagEncodingsUsage))
pprofType := flag.String("pprof", "", locale.Sprintf(locale.FlagPprofUsage, vars.PprofCPU, vars.PprofMem))
flag.Usage = usage
flag.Parse()
switch {
case *h:
flag.Usage()
return
case *v:
printVersion()
return
case *languages:
locale.Printf(locale.FlagSupportedLanguages, input.Languages())
return
case *encodings:
locale.Printf(locale.FlagSupportedEncodings, input.Encodings())
return
case *g:
genConfigFile(*wd)
return
}
if len(*pprofType) > 0 {
buf := new(bytes.Buffer)
defer func() { // 在程序结束时,将内容写入到文件
profile := filepath.Join(*wd, *pprofType+".prof")
if err := ioutil.WriteFile(profile, buf.Bytes(), os.ModePerm); err != nil {
erro.Println(err)
}
}()
switch strings.ToLower(*pprofType) {
case vars.PprofMem:
defer func() {
if err := pprof.Lookup("heap").WriteTo(buf, 1); err != nil {
erro.Println(err)
}
}()
case vars.PprofCPU:
if err := pprof.StartCPUProfile(buf); err != nil {
erro.Println(err)
}
defer pprof.StopCPUProfile()
default:
erro.Println(locale.Sprintf(locale.FlagInvalidPprrof))
return
}
}
run(*wd)
}
// 真正的程序入口,main 主要是作参数的处理。
func run(wd string) {
cfg, err := loadConfig(filepath.Join(wd, vars.ConfigFilename))
if err != nil {
erro.Println(err)
return
}
// 比较版本号兼容问题
compatible, err := version.SemVerCompatible(vars.Version(), cfg.Version)
if err != nil {
erro.Println(err)
return
}
if !compatible {
erro.Println(locale.Sprintf(locale.VersionInCompatible))
return
}
docs, elapsed := input.Parse(cfg.Inputs...)
fmt.Printf("%+v\n",docs)
cfg.Output.Elapsed = elapsed
if err := output.Render(docs, cfg.Output); err != nil {
erro.Println(err)
return
}
info.Println(locale.Sprintf(locale.Complete, cfg.Output.Dir, elapsed))
}
func usage() {
buf := new(bytes.Buffer)
flag.CommandLine.SetOutput(buf)
flag.PrintDefaults()
locale.Printf(locale.FlagUsage, vars.Name, buf.String(), vars.RepoURL, vars.OfficialURL)
}
// 根据 wd 所在目录的内容生成一个配置文件,并写入到 wd 目录下的 .apidoc.yaml 中
func genConfigFile(wd string) {
o, err := input.Detect(wd, true)
if err != nil {
erro.Println(err)
return
}
cfg := &config{
Version: vars.Version(),
Inputs: []*input.Options{o},
Output: &output.Options{
Dir: filepath.Join(o.Dir, "doc"),
},
}
data, err := yaml.Marshal(cfg)
if err != nil {
erro.Println(err)
return
}
path := filepath.Join(wd, vars.ConfigFilename)
if err = ioutil.WriteFile(path, data, os.ModePerm); err != nil {
erro.Println(err)
return
}
info.Println(locale.Sprintf(locale.FlagConfigWritedSuccess, path))
}
func printVersion() {
locale.Printf(locale.FlagVersionBuildWith, vars.Name, vars.Version(), runtime.Version())
locale.Printf(locale.FlagVersionCommitHash, vars.CommitHash())
}
func newLog(out *os.File, color colors.Color, prefix string) *log.Logger {
return log.New(writers.NewConsole(out, color, colors.Default), prefix, 0)
}