vendor/github.com/hashicorp/terraform-config-inspect/tfconfig/doc.go

   1 // Package tfconfig is a helper library that does careful, shallow parsing of
   2 // Terraform modules to provide access to high-level metadata while
   3 // remaining broadly compatible with configurations targeting various
   4 // different Terraform versions.
   5 //
   6 // This packge focuses on describing top-level objects only, and in particular
   7 // does not attempt any sort of processing that would require access to plugins.
   8 // Currently it allows callers to extract high-level information about
   9 // variables, outputs, resource blocks, provider dependencies, and Terraform
  10 // Core dependencies.
  11 //
  12 // This package only works at the level of single modules. A full configuration
  13 // is a tree of potentially several modules, some of which may be references
  14 // to remote packages. There are some basic helpers for traversing calls to
  15 // modules at relative local paths, however.
  16 //
  17 // This package employs a "best effort" parsing strategy, producing as complete
  18 // a result as possible even though the input may not be entirely valid. The
  19 // intended use-case is high-level analysis and indexing of externally-facing
  20 // module characteristics, as opposed to validating or even applying the module.
  21 package tfconfig