github.com/opentofu/opentofu@v1.7.1/internal/configs/doc.go (about)

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