mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-28 01:41:48 -06:00
c5f5340b15
There's quite a lot in this package, so hopefully this additional paragraph will help readers get oriented.
20 lines
1.0 KiB
Go
20 lines
1.0 KiB
Go
// Package configs contains types that represent Terraform configurations and
|
|
// the different elements thereof.
|
|
//
|
|
// The functionality in this package can be used for some static analyses of
|
|
// Terraform configurations, but this package generally exposes representations
|
|
// of the configuration source code rather than the result of evaluating these
|
|
// objects. The sibling package "lang" deals with evaluation of structures
|
|
// and expressions in the configuration.
|
|
//
|
|
// Due to its close relationship with HCL, this package makes frequent use
|
|
// of types from the HCL API, including raw HCL diagnostic messages. Such
|
|
// diagnostics can be converted into Terraform-flavored diagnostics, if needed,
|
|
// using functions in the sibling package tfdiags.
|
|
//
|
|
// The Parser type is the main entry-point into this package. The LoadConfigDir
|
|
// method can be used to load a single module directory, and then a full
|
|
// configuration (including any descendent modules) can be produced using
|
|
// the top-level BuildConfig method.
|
|
package configs
|