-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools/docgen: implement plugin documentation generator
- Loading branch information
Showing
6 changed files
with
203 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| _ "embed" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/hashicorp/hcl/v2/hcldec" | ||
| "github.com/spf13/pflag" | ||
|
|
||
| "github.com/blackstork-io/fabric/internal/builtin" | ||
| "github.com/blackstork-io/fabric/internal/elasticsearch" | ||
| "github.com/blackstork-io/fabric/internal/github" | ||
| "github.com/blackstork-io/fabric/internal/graphql" | ||
| "github.com/blackstork-io/fabric/internal/openai" | ||
| "github.com/blackstork-io/fabric/internal/postgresql" | ||
| "github.com/blackstork-io/fabric/internal/sqlite" | ||
| "github.com/blackstork-io/fabric/internal/terraform" | ||
| "github.com/blackstork-io/fabric/plugin" | ||
| ) | ||
|
|
||
| var ( | ||
| version string | ||
| outputDir string | ||
| ) | ||
|
|
||
| //go:embed markdown.gotempl | ||
| var markdownTempl string | ||
|
|
||
| var templ *template.Template | ||
|
|
||
| func main() { | ||
| // parse flags | ||
| flags := pflag.NewFlagSet("docgen", pflag.ExitOnError) | ||
| flags.StringVar(&version, "version", "v0.0.0-dev", "version of the build") | ||
| flags.StringVar(&outputDir, "output", "./dist/docs", "output directory") | ||
| flags.Parse(os.Args[1:]) | ||
| // ensure output directory exists | ||
| if err := os.MkdirAll(outputDir, 0o755); err != nil { | ||
| panic(err) | ||
| } | ||
| // load all plugins | ||
| plugins := []*plugin.Schema{ | ||
| builtin.Plugin(version), | ||
| elasticsearch.Plugin(version), | ||
| github.Plugin(version, nil), | ||
| graphql.Plugin(version), | ||
| openai.Plugin(version, nil), | ||
| postgresql.Plugin(version), | ||
| sqlite.Plugin(version), | ||
| terraform.Plugin(version), | ||
| } | ||
| // generate markdown for each plugin | ||
| for _, p := range plugins { | ||
| fp := filepath.Join(outputDir, fmt.Sprintf("%s.md", shortname(p.Name))) | ||
| fmt.Printf("Generating '%s': '%s'\n", p.Name, fp) | ||
| if err := generate(p, fp); err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func generate(schema *plugin.Schema, fp string) error { | ||
| f, err := os.Create(fp) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer f.Close() | ||
| return templ.Execute(f, schema) | ||
| } | ||
|
|
||
| func shortname(name string) string { | ||
| parts := strings.SplitN(name, "/", 2) | ||
| if len(parts) == 2 { | ||
| return parts[1] | ||
| } | ||
| return name | ||
| } | ||
|
|
||
| func init() { | ||
| templ = template.Must(template.New("markdown").Funcs(template.FuncMap{ | ||
| "shortname": shortname, | ||
| "attrType": func(val hcldec.Spec) string { | ||
| switch v := val.(type) { | ||
| case *hcldec.AttrSpec: | ||
| return v.Type.FriendlyName() | ||
| default: | ||
| return "unknown" | ||
| } | ||
| }, | ||
| }).Parse(markdownTempl)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| {{- if eq .Name "blackstork/builtin" -}} | ||
| # Fabric built-in plugins | ||
| {{- else -}} | ||
| # Fabric `{{ .Name | shortname }}` plugin | ||
| {{- end }} | ||
|
|
||
| This document describes the `{{ .Name | shortname }}` plugin for the Fabric CLI tool. | ||
|
|
||
| ## Installation | ||
|
|
||
| {{ if eq .Name "blackstork/builtin" -}} | ||
| The built-in plugins are available by default. | ||
| {{ else -}} | ||
| To install the plugin, add the following to your global fabric configuration: | ||
|
|
||
| ```hcl | ||
| fabric { | ||
| plugin_versions = { | ||
| "{{ .Name }}" = "=> {{ .Version }}" | ||
| } | ||
| } | ||
| ``` | ||
| {{ end }} | ||
|
|
||
| {{ with .DataSources -}} | ||
|
|
||
| ## Data sources | ||
|
|
||
| {{ if eq .Name "blackstork/builtin" -}} | ||
| The following data sources are available by default: | ||
| {{ else -}} | ||
| This plugin has the following data sources available: | ||
| {{ end }} | ||
| {{ range $name, $ds := . -}} | ||
| ### `{{ $name }}` | ||
|
|
||
| {{with $ds.Config -}} | ||
| #### Configuration | ||
|
|
||
| ```hcl | ||
| config data {{ $name }} { | ||
| {{- range $key, $value := . }} | ||
| {{ $key }} = {{ $value | attrType }} // {{if $value.Required}}required{{else}}optional{{end}} | ||
| {{- end }} | ||
| } | ||
| ``` | ||
| {{ end }} | ||
|
|
||
| {{with $ds.Args -}} | ||
| #### Usage | ||
|
|
||
| ```hcl | ||
| data {{ $name }} { | ||
| {{- range $key, $value := . }} | ||
| {{ $key }} = {{ $value | attrType }} // {{if $value.Required}}required{{else}}optional{{end}} | ||
| {{- end }} | ||
| } | ||
| ``` | ||
| {{ end }} | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
|
|
||
| {{ with .ContentProviders -}} | ||
|
|
||
| ## Content providers | ||
|
|
||
| {{ if eq .Name "blackstork/builtin" -}} | ||
| The following content providers are available by default: | ||
| {{ else -}} | ||
| This plugin has the following content providers available: | ||
| {{ end }} | ||
| {{ range $name, $provider := . -}} | ||
| ### `{{ $name }}` | ||
|
|
||
| {{with $provider.Config -}} | ||
| #### Configuration | ||
|
|
||
| ```hcl | ||
| config content {{ $name }} { | ||
| {{- range $key, $value := . }} | ||
| {{ $key }} = {{ $value | attrType }} // {{if $value.Required}}required{{else}}optional{{end}} | ||
| {{- end }} | ||
| } | ||
| ``` | ||
| {{ end }} | ||
|
|
||
| {{with $provider.Args -}} | ||
| #### Usage | ||
|
|
||
| ```hcl | ||
| content {{ $name }} { | ||
| {{- range $key, $value := . }} | ||
| {{ $key }} = {{ $value | attrType }} // {{if $value.Required}}required{{else}}optional{{end}} | ||
| {{- end }} | ||
| } | ||
| ``` | ||
| {{ end }} | ||
| {{ end }} | ||
| {{ end }} | ||
|
|