https://github.com/boltops-tools/hcl_parser
HCL Parser
https://github.com/boltops-tools/hcl_parser
Last synced: about 1 year ago
JSON representation
HCL Parser
- Host: GitHub
- URL: https://github.com/boltops-tools/hcl_parser
- Owner: boltops-tools
- License: apache-2.0
- Created: 2020-05-26T14:44:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-26T16:53:30.000Z (almost 4 years ago)
- Last Synced: 2024-10-31T12:56:28.655Z (over 1 year ago)
- Language: Ruby
- Size: 28.3 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# HclParser
Parse HCL files. The scope of this library is to only handle `variables.tf` and `backend.tf` files, as that's what's needed for Terraspace currently.
## Usage
```ruby
require "hcl_parser"
code =<
#
# {"variable"=>
# {"project"=>
# {"description"=>"The name of project",
# "default"=>"test",
# "type"=>"string"},
# "name_prefix"=>{"type"=>"string"}}}
```
## Installation
```ruby
gem 'hcl_parser'
```
## Notes
* Tried a few different Ruby HCL parsers: [hcl-checker](https://github.com/mfcastellani/hcl-checker), [hcl-rb](https://github.com/Ruin0x11/hcl-rb), [rhcl](https://github.com/winebarrel/rhcl), [ruby-hcl](https://github.com/sikula/ruby-hcl). They all seem to have one issue or another.
* This library preprocesses the text fed to the parser to workaround the parser issues. It's a workaround.
* Able to handle simple variable types and most complex types.
* Not able to handle multi-line complex variable types. There's a spec to document this.
* Will have to fix one of these parsers or write a new one.
* Open to PRs to help.