2017-04-10 09:30:23 +00:00
|
|
|
package generator
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
2018-04-28 13:12:03 +00:00
|
|
|
"gopkg.in/yaml.v2"
|
2017-04-10 09:30:23 +00:00
|
|
|
"io"
|
2017-06-13 11:56:07 +00:00
|
|
|
"io/ioutil"
|
2017-04-10 09:30:23 +00:00
|
|
|
)
|
|
|
|
|
2017-06-21 13:18:27 +00:00
|
|
|
// Documentation reads from fileToParse and builds source file from tmplPath. It complies with type File signature.
|
2017-06-13 11:56:07 +00:00
|
|
|
func Documentation(fileToParse, samplesDir, outPath, tmplPath, tmplName, commit string) error {
|
|
|
|
data, err := ioutil.ReadFile(fileToParse)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-04-10 09:30:23 +00:00
|
|
|
var regexpList []string
|
|
|
|
if err := yaml.Unmarshal(data, ®expList); err != nil {
|
2017-06-13 11:56:07 +00:00
|
|
|
return err
|
2017-04-10 09:30:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
buf := &bytes.Buffer{}
|
2017-06-13 11:56:07 +00:00
|
|
|
if err := executeDocumentationTemplate(buf, regexpList, tmplPath, tmplName, commit); err != nil {
|
|
|
|
return err
|
2017-04-10 09:30:23 +00:00
|
|
|
}
|
|
|
|
|
2017-06-13 11:56:07 +00:00
|
|
|
return formatedWrite(outPath, buf.Bytes())
|
2017-04-10 09:30:23 +00:00
|
|
|
}
|
|
|
|
|
2017-06-13 11:56:07 +00:00
|
|
|
func executeDocumentationTemplate(out io.Writer, regexpList []string, tmplPath, tmplName, commit string) error {
|
2018-04-28 13:12:03 +00:00
|
|
|
return executeTemplate(out, tmplName, tmplPath, commit, nil, regexpList)
|
2017-04-10 09:30:23 +00:00
|
|
|
}
|