github.com/terramate-io/tf@v0.0.0-20230830114523-fce866b4dfcd/configs/doc.go (about)

     1  // Copyright (c) HashiCorp, Inc.
     2  // SPDX-License-Identifier: MPL-2.0
     3  
     4  // Package configs contains types that represent Terraform configurations and
     5  // the different elements thereof.
     6  //
     7  // The functionality in this package can be used for some static analyses of
     8  // Terraform configurations, but this package generally exposes representations
     9  // of the configuration source code rather than the result of evaluating these
    10  // objects. The sibling package "lang" deals with evaluation of structures
    11  // and expressions in the configuration.
    12  //
    13  // Due to its close relationship with HCL, this package makes frequent use
    14  // of types from the HCL API, including raw HCL diagnostic messages. Such
    15  // diagnostics can be converted into Terraform-flavored diagnostics, if needed,
    16  // using functions in the sibling package tfdiags.
    17  //
    18  // The Parser type is the main entry-point into this package. The LoadConfigDir
    19  // method can be used to load a single module directory, and then a full
    20  // configuration (including any descendent modules) can be produced using
    21  // the top-level BuildConfig method.
    22  package configs