-
Notifications
You must be signed in to change notification settings - Fork 535
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move plugin-sdk to in-tree in core repository
Moving terraform-docs/plugin-sdk standalone module to in-tree, because
maintaining both of them, specifically if anything needs to be added to
Config, or terraform will required dual effort on both repository. As
such now everything is consolidated under one repository. Example usage
for plugin developer after this move is as follow:
```go
package main
import (
_ "embed" //nolint
"github.com/terraform-docs/terraform-docs/plugin"
"github.com/terraform-docs/terraform-docs/print"
"github.com/terraform-docs/terraform-docs/template"
"github.com/terraform-docs/terraform-docs/terraform"
)
func main() {
plugin.Serve(&plugin.ServeOpts{
Name: "template",
Version: "0.1.0",
Printer: printer,
})
}
//go:embed sections.tmpl
var tplCustom []byte
// Print the custom format template. You have all the flexibility to generate
// the output however you choose to.
func printer(config *print.Config, module *terraform.Module) (string, error) {
tpl := template.New(config,
&template.Item{Name: "custom", Text: string(tplCustom)},
)
rendered, err := tpl.Render("custom", module)
if err != nil {
return "", err
}
return rendered, nil
}
```
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>- Loading branch information
Showing
21 changed files
with
450 additions
and
168 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
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,84 @@ | ||
| /* | ||
| Copyright 2021 The terraform-docs Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package plugin | ||
|
|
||
| import ( | ||
| "net/rpc" | ||
| "os" | ||
| "os/exec" | ||
|
|
||
| "github.com/hashicorp/go-hclog" | ||
| goplugin "github.com/hashicorp/go-plugin" | ||
|
|
||
| "github.com/terraform-docs/terraform-docs/print" | ||
| "github.com/terraform-docs/terraform-docs/terraform" | ||
| ) | ||
|
|
||
| // Client is an RPC Client for the host. | ||
| type Client struct { | ||
| rpcClient *rpc.Client | ||
| broker *goplugin.MuxBroker | ||
| } | ||
|
|
||
| // ClientOpts is an option for initializing a Client. | ||
| type ClientOpts struct { | ||
| Cmd *exec.Cmd | ||
| } | ||
|
|
||
| // ExecuteArgs is the collection of arguments being sent by terraform-docs | ||
| // core while executing the plugin command. | ||
| type ExecuteArgs struct { | ||
| Module *terraform.Module | ||
| Config *print.Config | ||
| } | ||
|
|
||
| // NewClient is a wrapper of plugin.NewClient. | ||
| func NewClient(opts *ClientOpts) *goplugin.Client { | ||
| return goplugin.NewClient(&goplugin.ClientConfig{ | ||
| HandshakeConfig: handshakeConfig, | ||
| Plugins: map[string]goplugin.Plugin{ | ||
| "formatter": &formatter{}, | ||
| }, | ||
| Cmd: opts.Cmd, | ||
| Logger: hclog.New(&hclog.LoggerOptions{ | ||
| Name: "plugin", | ||
| Output: os.Stderr, | ||
| Level: hclog.LevelFromString(os.Getenv("TFDOCS_LOG")), | ||
| }), | ||
| }) | ||
| } | ||
|
|
||
| // Name calls the server-side Name method and returns its version. | ||
| func (c *Client) Name() (string, error) { | ||
| var resp string | ||
| err := c.rpcClient.Call("Plugin.Name", new(interface{}), &resp) | ||
| return resp, err | ||
| } | ||
|
|
||
| // Version calls the server-side Version method and returns its version. | ||
| func (c *Client) Version() (string, error) { | ||
| var resp string | ||
| err := c.rpcClient.Call("Plugin.Version", new(interface{}), &resp) | ||
| return resp, err | ||
| } | ||
|
|
||
| // Execute calls the server-side Execute method and returns generated output. | ||
| func (c *Client) Execute(args *ExecuteArgs) (string, error) { | ||
| var resp string | ||
| err := c.rpcClient.Call("Plugin.Execute", args, &resp) | ||
| return resp, err | ||
| } |
Oops, something went wrong.