Struct FmtCommand 

pub struct FmtCommand { /* private fields */ }

Command for formatting Terraform configuration files.

By default, rewrites files in-place. Use .check() to only verify formatting without modifying files, or .diff() to display differences.

use terraform_wrapper::{Terraform, TerraformCommand};
use terraform_wrapper::commands::fmt::FmtCommand;

let tf = Terraform::builder().working_dir("/tmp/infra").build()?;

// Check formatting without modifying files
let output = FmtCommand::new().check().execute(&tf).await?;

Implementations

impl FmtCommand

pub fn new() -> Self

Create a new fmt command with default options.

pub fn check(self) -> Self

Check if files are formatted without modifying them (-check).

Returns exit code 0 if all files are formatted, exit code 3 if not.

pub fn diff(self) -> Self

Display diffs of formatting changes (-diff).

pub fn recursive(self) -> Self

Process files in subdirectories recursively (-recursive).

pub fn write(self, enabled: bool) -> Self

Control whether to write changes to files (-write).

pub fn arg(self, arg: impl Into<String>) -> Self

Add a raw argument (escape hatch for unsupported options).

Trait Implementations

impl Clone for FmtCommand

fn clone(&self) -> FmtCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FmtCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FmtCommand

fn default() -> FmtCommand

Returns the “default value” for a type.

impl TerraformCommand for FmtCommand

type Output = CommandOutput

The output type produced by this command.

fn args(&self) -> Vec<String>

Build the argument list for this command.

async fn execute(&self, tf: &Terraform) -> Result<CommandOutput>

Execute this command against the given Terraform client.