# HCL styleguide

HashiCorp Configuration Language \(HCL\) is the syntax we use for writing Terraform configurations. This HCL style guide follows: [terraform syntax](https://www.terraform.io/docs/configuration/syntax.html). Unless mentioned otherwise, this applies to any HCL configuration that is written at The Orchard. We DO NOT use JSON when writing Terraform configurations, although that is available for Terraform.

Please also reference [Terraform Workflow Patterns Tech Design](https://docs.google.com/document/d/1JBZNukSZblLthy5_enNvJH2L4ib0yyYSZiwL0W9519A/edit#)

**Table of Content**

1. [Readability](hcl.md#readability)
   * [Indentation](hcl.md#indentation)
   * [Documentation](hcl.md#documentation)

## Readability

### Indentation

We use 2-space hanging indent, no indent on the first line.

### Documentation

Single line comments start with `#`. Multi-line comments are wrapped with `/*` and `*/`