ตัวจัดรูปแบบ Terraform HCL
จัดรูปแบบและจัดเรียงไฟล์ Terraform HCL ในเบราว์เซอร์เหมือน terraform fmt จัด indentation ของ block จัดเรียงเครื่องหมาย = รองรับ heredoc ไม่ต้อง upload
Loading tool...
ตัวจัดรูปแบบ Terraform HCL คืออะไร?
Terraform HCL Formatter คือเครื่องมือจัดรูปแบบ HCL (HashiCorp Configuration Language) ที่ทำงานในเบราว์เซอร์ รองรับไฟล์ของ Terraform, OpenTofu และ Terragrunt โดยจัด indentation ของ block จัดเรียงเครื่องหมาย = ปรับ spacing ให้สม่ำเสมอ และแจ้งเตือนวงเล็บที่ไม่สมดุล ทุกอย่างที่ terraform fmt ทำเพื่อความอ่านง่าย โดยไม่ต้องติดตั้งอะไรและไม่ต้อง upload โค้ด
ประโยชน์หลัก
- diff ที่อ่านง่ายและสม่ำเสมอ ทำให้ review เร็วขึ้น
- โค้ด infrastructure ที่ละเอียดอ่อนอยู่บนเครื่องคุณเอง ไม่มีการ upload
- จับปีกกาและวงเล็บที่ไม่สมดุลก่อน commit
- ไม่ต้องติดตั้ง Terraform CLI หรือ plugin ของ editor
- โหมด Compact สำหรับฝัง config แบบย่อในเอกสารและ log ของ CI
กรณีการใช้งาน
- •เก็บกวาดไฟล์ .tf ที่ถูกสร้างอัตโนมัติหรือเขียนอย่างรีบเร่ง
- •ปรับ indentation ให้มาตรฐานก่อนเปิด pull request
- •อ่าน config Terraform แบบบรรทัดเดียวยาว ๆ จาก tutorial ให้เป็นระเบียบ
- •จัดรูปแบบไฟล์ terragrunt.hcl และ .tofu ของ OpenTofu
- •เตรียม snippet infrastructure ที่อ่านง่ายสำหรับเอกสาร
วิธีใช้ตัวจัดรูปแบบ Terraform HCL
- วางโค้ด HCL: เปิดไฟล์ .tf (main.tf, variables.tf, outputs.tf) แล้ววางเนื้อหาลงในช่อง input หรือกดปุ่มตัวอย่างเพื่อลองเล่นก่อน
- เลือกโหมด: เลือก Format สำหรับจัด indent และ align แบบ terraform fmt หรือ Compact สำหรับ output แบบ minimal บรรทัดละคำสั่ง
- ตั้งค่า option: เลือก indent 2 หรือ 4 space และเปิด/ปิดการจัดเรียงเครื่องหมาย = ของ attribute ที่อยู่ติดกัน
- จัดรูปแบบแล้วคัดลอก: กด Format ตรวจสอบคำเตือนถ้ามี แล้ว copy ผลลัพธ์หรือดาวน์โหลดเป็น main.tf
คุณสมบัติหลัก
- จัด indentation สไตล์ terraform fmt เลือกได้ทั้ง 2 หรือ 4 space
- จัดเรียงเครื่องหมาย = ของ attribute ที่อยู่ติดกันโดยอัตโนมัติ
- เข้าใจ heredoc เก็บเนื้อหาใน block <<-EOF ไว้ครบถ้วน
- ตรวจความสมดุลของปีกกาและวงเล็บ พร้อมระบุเลขบรรทัด
- โหมด Compact ลบ comment และบรรทัดว่างทิ้ง
- Copy หรือดาวน์โหลดเป็น main.tf - ไม่ต้อง upload ไม่มี server
คำถามที่พบบ่อย
เครื่องมือนี้ upload ไฟล์ Terraform ไปที่ server ไหม?
ไม่มีการ upload ทุกอย่างตั้งแต่ parse จัดรูปแบบ จนถึงตรวจสอบ ทำงานในเบราว์เซอร์ของคุณด้วย JavaScript ล้วน ๆ โค้ด infrastructure ไม่ออกจากเครื่อง เหมาะกับ config ที่เป็นความลับหรือใช้ใน production
ผลลัพธ์เหมือน terraform fmt ทุกบรรทัดไหม?
ใกล้เคียงมากในเรื่อง indentation และ alignment แต่ terraform fmt ยังเป็นมาตรฐานหลัก เครื่องมือนี้เป็นตัวช่วยที่สะดวกในเบราว์เซอร์ ควรรัน terraform fmt ใน CI เป็นด่านสุดท้ายของโค้ดที่ commit
รองรับ heredoc และข้อความหลายบรรทัดไหม?
รองรับ heredoc ที่เปิดด้วย <<EOF หรือ <<-EOF โดยเนื้อหาภายในจะถูกเก็บไว้ตรง ๆ ทำให้ script ที่ฝังอยู่และ user-data template ไม่เพี้ยนหลังจัดรูปแบบ
ใช้กับไฟล์ Terragrunt และ OpenTofu ได้ไหม?
ได้ Terragrunt (terragrunt.hcl) และ OpenTofu (.tofu) ใช้ syntax HCL เดียวกัน ตัวจัดรูปแบบจึงทำงานกับไฟล์เหล่านี้เหมือนไฟล์ .tf ของ Terraform ปกติ