Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 0
📖 [Docs]: README pages now use the standard module landing-page format#7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Marius Storhaug (MariusStorhaug)
wants to merge
5
commits into
mainChoose a base branch
from
docs/standardize-readme
base:main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Uh oh!
There was an error while loading. Please reload this page.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7d51ee3
Standardize README landing page
MariusStorhaug eca0cc4
Address Copilot README review
MariusStorhaug c0935b8
Address Copilot README review
MariusStorhaug 43e7efb
📖 [Docs]: Restore Hcl landing page with real usage examples
MariusStorhaug 9a4f6e7
📖 [Docs]: Show help discovery for both Hcl commands
MariusStorhaug File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,12 @@ | ||
| # Hcl | ||
| A PowerShell module for working with [HashiCorp Configuration Language (HCL)](https://github.com/hashicorp/hcl), as used in [Terraform](https://www.terraform.io/), [OpenTofu](https://opentofu.org/), and other infrastructure-as-code tools. Supports parsing `.tf` configuration files, `.tfvars` variable files, `locals {}` blocks, and converting PowerShell objects back to HCL format. | ||
| ## Prerequisites | ||
| This uses the following external resources: | ||
| - The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. | ||
| A PowerShell module for working with [HashiCorp Configuration Language (HCL)](https://github.com/hashicorp/hcl), as used in | ||
| [Terraform](https://www.terraform.io/), [OpenTofu](https://opentofu.org/), and other infrastructure-as-code tools. It parses `.tf` | ||
| configuration files, `.tfvars` variable files, and `locals {}` blocks into PowerShell objects, and converts PowerShell objects back to HCL. | ||
| ## Installation | ||
| To install the module from the PowerShell Gallery, you can use the following command: | ||
| Install the module from the PowerShell Gallery: | ||
| ```powershell | ||
| Install-PSResource -Name Hcl | ||
| @@ -18,9 +15,7 @@ Import-Module -Name Hcl | ||
| ## Usage | ||
| Here is a list of examples that are typical use cases for the module. | ||
| ### Example 1: Parse a Terraform locals block | ||
| ### Example: Parse a Terraform locals block | ||
| ```powershell | ||
| $hcl = @' | ||
| @@ -38,15 +33,15 @@ $result.locals.environment # production | ||
| $result.locals.tags.project # myapp | ||
| ``` | ||
| ### Example 2: Parse a .tfvars file | ||
| ### Example: Parse a .tfvars file | ||
| ```powershell | ||
| $tfvars = Get-Content -Path 'terraform.tfvars' -Raw | ||
| $variables = ConvertFrom-Hcl -InputObject $tfvars | ||
| $variables.region # us-east-1 | ||
| ``` | ||
| ### Example 3: Convert a PowerShell object to HCL | ||
| ### Example: Convert a PowerShell object to HCL | ||
| ```powershell | ||
| $config = [ordered]@{ | ||
| @@ -62,30 +57,14 @@ $config = [ordered]@{ | ||
| ConvertTo-Hcl -InputObject $config | ||
| ``` | ||
| ### Find more examples | ||
| To find more examples of how to use the module, please refer to the [examples](examples) folder. | ||
| Alternatively, you can use `Get-Command -Module 'Hcl'` to find commands available in the module. | ||
| To find examples of each command, use `Get-Help -Examples 'CommandName'`. | ||
| ## Documentation | ||
| For detailed documentation on each function, use the built-in help system: | ||
| Documentation is published at [psmodule.io/Hcl](https://psmodule.io/Hcl/). | ||
| To discover the commands and their examples from your session: | ||
| ```powershell | ||
| Get-Help ConvertFrom-Hcl -Full | ||
| Get-Help ConvertTo-Hcl -Full | ||
| Get-Command -Module Hcl | ||
| Get-Help -Name ConvertFrom-Hcl -Examples | ||
MariusStorhaug marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. MariusStorhaug marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| Get-Help -Name ConvertTo-Hcl -Examples | ||
| ``` | ||
| ## Contributing | ||
| Coder or not, you can contribute to the project! We welcome all contributions. | ||
| ### For users | ||
| If you don't code, you still sit on valuable information that can make this project even better. If you experience that the product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. Please see the issues tab on this project and submit a new issue that matches your needs. | ||
| ### For developers | ||
| If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.