Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

tffwdocs

package module

Go to main page

Versions in this module

v0

v0.2.3

Mar 31, 2026

v0.2.2

Mar 31, 2026

v0.2.1

Mar 31, 2026

v0.2.0

Mar 27, 2026

Changes in this version

type Generator

+ func (gen Generator) Lint(opt *LintOptions) error

+ type LintOptions struct

+ SkipActions map[string]bool

+ SkipDataSources map[string]bool

+ SkipEphemeralResources map[string]bool

+ SkipFunctions map[string]bool

+ SkipListResources map[string]bool

+ SkipProvider bool

+ SkipResources map[string]bool

v0.1.0

Mar 27, 2026

Changes in this version

+ type ActionRenderOption = metadata.ActionRenderOption

+ type ActionWithRenderOption interface

+ RenderOption func() ActionRenderOption

+ type DataSourceRenderOption = metadata.DataSourceRenderOption

+ type DataSourceWithRenderOption interface

+ RenderOption func() DataSourceRenderOption

+ type EphemeralResourceRenderOption = metadata.EphemeralRenderOption

+ type EphemeralResourceWithRenderOption interface

+ RenderOption func() EphemeralResourceRenderOption

+ type Example = metadata.Example

+ type FunctionRenderOption = metadata.FunctionRenderOption

+ type FunctionWithRenderOption interface

+ RenderOption func() FunctionRenderOption

+ type Generator struct

+ func NewGenerator(ctx context.Context, p provider.Provider) (*Generator, error)

+ func (gen Generator) RenderAction(ctx context.Context, w io.Writer, actionType string, ...) error

+ func (gen Generator) RenderDataSource(ctx context.Context, w io.Writer, dataSourceType string, ...) error

+ func (gen Generator) RenderEphemeralResource(ctx context.Context, w io.Writer, ephemeralResourceType string, ...) error

+ func (gen Generator) RenderFunction(ctx context.Context, w io.Writer, functionName string, ...) error

+ func (gen Generator) RenderListResource(ctx context.Context, w io.Writer, listResourceType string, ...) error

+ func (gen Generator) RenderProvider(ctx context.Context, w io.Writer, option *ProviderRenderOption) error

+ func (gen Generator) RenderResource(ctx context.Context, w io.Writer, resourceType string, ...) error

+ func (gen Generator) WriteAll(ctx context.Context, docDir string, opts *RenderOptions) error

+ type ImportId = metadata.ImportId

+ type ListResourceRenderOption = metadata.ListRenderOption

+ type ListResourceWithRenderOption interface

+ RenderOption func() ListResourceRenderOption

+ type ProviderRenderOption = metadata.ProviderRenderOption

+ type ProviderWithRenderOption interface

+ RenderOption func() ProviderRenderOption

+ type RenderOptions struct

+ Actions map[string]ActionRenderOption

+ DataSources map[string]DataSourceRenderOption

+ EphemeralResources map[string]EphemeralResourceRenderOption

+ Functions map[string]FunctionRenderOption

+ ListResources map[string]ListResourceRenderOption

+ Provider *ProviderRenderOption

+ Resources map[string]ResourceRenderOption

+ type ResourceRenderOption = metadata.ResourceRenderOption

+ type ResourceWithRenderOption interface

+ RenderOption func() ResourceRenderOption