autoformat.md

Format HCL code

org.openrewrite.hcl.format.AutoFormat

Format HCL code using a standard comprehensive set of HCL formatting recipes.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-hcl
• version: 8.1.3

Example

{% tabs %} {% tab title="hcl" %}

Before

{% code %}

locals {
  object = {
         string_attr = "value1"
         int_attr    = 2
  }
}

{% endcode %}

After

{% code %}

locals {
  object = {
    string_attr = "value1"
    int_attr    = 2
  }
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -3,2 +3,2 @@
locals {
  object = {
-        string_attr = "value1"
-        int_attr    = 2
+   string_attr = "value1"
+   int_attr    = 2
  }

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies. {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.hcl.format.AutoFormat")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.hcl.format.AutoFormat</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} You will need to have Maven installed on your machine before you can run the following command. {% code title="shell" %}

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.activeRecipes=org.openrewrite.hcl.format.AutoFormat

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• traceyyoshima

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.