package
0.0.0-20210728164355-9c1f178932fa
Repository: https://github.com/terraform-docs/terraform-config-inspect.git
Documentation: pkg.go.dev

# Functions

IsModuleDir checks if the given path contains terraform configuration files.
IsModuleDirOnFilesystem checks if the given path in the given FS contains Terraform configuration files.
LoadModule reads the directory at the given path and attempts to interpret it as a Terraform module.
LoadModuleFromFile reads given file, interprets it and stores in given Module This is useful for any caller which does tokenization/parsing on its own e.g.
LoadModuleFromFilesystem reads the directory at the given path in the given FS and attempts to interpret it as a Terraform module.
NewModule creates new Module representing Terraform module at the given path.
NewOsFs provides a basic implementation of FS for an OS filesystem.
No description provided by the author

# Constants

No description provided by the author
DiagError indicates a problem that prevented proper processing of the configuration.
DiagWarning indicates a problem that the user may wish to consider but that did not prevent proper processing of the configuration.
No description provided by the author
No description provided by the author

# Structs

Diagnostic describes a problem (error or warning) encountered during configuration loading.
Module is the top-level type representing a parsed and processed Terraform module.
ModuleCall represents a "module" block within a module.
Output represents a single output from a Terraform module.
ProviderConfig represents a provider block in the configuration.
ProviderRef is a reference to a provider configuration within a module.
No description provided by the author
Resource represents a single "resource" or "data" block within a module.
SourcePos is a pointer to a particular location in a source file.
Variable represents a single variable from a Terraform module.

# Interfaces

File represents an open file in FS See io/fs.File in http://golang.org/s/draft-iofs-design.
FS represents a minimal filesystem implementation See io/fs.FS in http://golang.org/s/draft-iofs-design.

# Type aliases

Diagnostics represents a sequence of diagnostics.
DiagSeverity describes the severity of a Diagnostic.
ResourceMode represents the "mode" of a resource, which is used to distinguish between managed resources ("resource" blocks in config) and data resources ("data" blocks in config).