Code Monkey home page Code Monkey logo

hcl-rs's Introduction

hcl-rs

Build Status License: Apache 2.0 License: MIT

This repository contains the following rust crates around the Hashicorp Configuration Language (HCL):

  • hcl-rs: HCL library with serde and expression evaluation support.
  • hcl-edit: Parse and modify HCL documents while preserving whitespace and comments.
  • hcl-primitives: Primitives used by the HCL sub-languages.

Feature parity with the go-hcl implementation

The crates in this repository try to closely follow these specifications that are part of the Hashicorp's HCL Go implementation:

At the parser level it should support all features that go-hcl does today. However, the implementations for formatting and expression evaluation in hcl-rs are relatively basic at the moment. There are plans to move formatting and expression evaluation capabilities into hcl-edit (which is used by hcl-rs under the hood and also contains the parser implementation) and to make them more powerful.

Another thing that is not included (yet), is the support for HCL schemas in order to validate that a parsed HCL document only contains an allowed set of blocks with expected attributes (e.g. to enable validation that a given terraform configuration only contains well-formed resource and data blocks etc.).

Additionally, schema support can help to make it easier to encode more complex configurations using custom types. These configurations are currently cumbersome to assemble because of limitations of the serde model.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md before creating a PR.

License

If not stated otherwise, the source code inside this repository is licensed under either of Apache License, Version 2.0 or MIT license at your option.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.