Merge pull request #267 from mesg-foundation/258-generate-service-doc…

…umentation

Task to generate a default documentation for service

.codacy.yml

@@ -3,6 +3,7 @@ exclude_patterns:
   - "**/*_test.go"
   - "**/*.d.ts"
   - "**/*.pb.go"
-  - "**/service/schema.go"
+  - "**/service/assets/*.go"
+  - "**/cmd/service/assets/*.go"
   - "**/Dockerfile"
 

.codeclimate.yml

@@ -2,7 +2,8 @@ exclude_patterns:
   - "**/*_test.go"
   - "**/*.d.ts"
   - "**/*.pb.go"
-  - "**/service/schema.go"
+  - "**/service/assets/*.go"
+  - "**/cmd/service/assets/*.go"
 plugins:
   gofmt:
     enabled: true

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 #### Changed
 #### Added
+
+- (#267) Add Command `service gen-doc` that generate a `README.md` in the service based on the informations of the `mesg.yml`
+
 #### Removed
 #### Fixed
 

cmd/service.go

@@ -25,6 +25,7 @@ func init() {
 	Service.AddCommand(service.Init)
 	Service.AddCommand(service.Delete)
 	Service.AddCommand(service.Logs)
+	Service.AddCommand(service.Docs)
 
 	RootCmd.AddCommand(Service)
 }

cmd/service/assets/readmeTemplate.md

@@ -0,0 +1,51 @@
+# {{.Name}}
+
+{{.Description}}
+{{if .Repository}}
+```bash
+mesg-core service deploy {{.Repository}}
+```
+{{end}}
+{{if .Events}}# Events
+{{range $key, $event := .Events}}
+## {{$key}}
+
+Event key: `{{$key}}`
+
+{{$event.Description}}
+
+{{if $event.Data}}| **Key** | **Type** | **Description** |
+| --- | --- | --- |
+{{range $dataKey, $data := $event.Data}}| **{{$dataKey}}** | `{{$data.Type}}` | {{$data.Description}} |
+{{end}}{{end}}{{end}}{{end}}
+{{if .Tasks}}
+# Tasks
+{{range $key, $task := .Tasks}}
+## {{$key}}
+
+Task key: `{{$key}}`
+
+{{$task.Description}}
+
+{{if $task.Inputs}}### Inputs
+
+| **Key** | **Type** | **Description** |
+| --- | --- | --- |
+{{range $inputKey, $input := $task.Inputs}}| **{{$inputKey}}** | `{{$input.Type}}` | {{$input.Description}} |
+{{end}}{{end}}
+
+{{if $task.Outputs}}### Outputs
+
+{{range $outputKey, $output := $task.Outputs}}##### {{$outputKey}}
+
+Output key: `{{$outputKey}}`
+
+{{$output.Description}}
+
+| **Key** | **Type** | **Description** |
+| --- | --- | --- |
+{{range $outputKey, $output := $output.Data}}| **{{$outputKey}}** | `{{$output.Type}}` | {{$output.Description}} |
+{{end}}
+{{end}}{{end}}
+
+{{end}}{{end}}

cmd/service/docs.go

@@ -0,0 +1,55 @@
+package service
+
+import (
+	"fmt"
+	"html/template"
+	"os"
+	"path/filepath"
+
+	"github.com/logrusorgru/aurora"
+	"github.com/mesg-foundation/core/cmd/service/assets"
+	"github.com/mesg-foundation/core/cmd/utils"
+	s "github.com/mesg-foundation/core/service"
+	"github.com/spf13/cobra"
+	survey "gopkg.in/AlecAivazis/survey.v1"
+)
+
+// Docs a service to the marketplace
+var Docs = &cobra.Command{
+	Use:   "gen-doc",
+	Short: "Generate the documentation for the service in a README.md file",
+	Example: `mesg-core service gen-doc
+mesg-core service gen-doc ./PATH_TO_SERVICE`,
+	Run:               genDocHandler,
+	DisableAutoGenTag: true,
+}
+
+func genDocHandler(cmd *cobra.Command, args []string) {
+	path := defaultPath(args)
+	readmePath := filepath.Join(path, "README.md")
+	if _, err := os.Stat(readmePath); err == nil {
+		var value bool
+		if survey.AskOne(&survey.Confirm{Message: "The file README.md already exists. Do you want to overwrite it?"}, &value, nil) != nil {
+			return
+		}
+		if !value {
+			return
+		}
+	}
+
+	service, err := s.ImportFromPath(path)
+	utils.HandleError(err)
+
+	f, err := os.OpenFile(readmePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, os.ModePerm)
+	defer f.Close()
+
+	readmeTemplate, err := assets.Asset("cmd/service/assets/readmeTemplate.md")
+	utils.HandleError(err)
+
+	tmpl, err := template.New("doc").Parse(string(readmeTemplate))
+	utils.HandleError(err)
+	err = tmpl.Execute(f, service)
+	utils.HandleError(err)
+
+	fmt.Println(aurora.Green("File README.md generated with success"))
+}