หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

yamlfmt

yamlfmt เป็นเครื่องมือบรรทัดคำสั่งหรือไลบรารีที่ขยายได้เพื่อจัดรูปแบบไฟล์ yaml

เป้าหมาย

  • สร้างเครื่องมือจัดรูปแบบบรรทัดคำสั่ง yaml ที่ง่ายต่อการแจกจ่าย (ไบนารีเดี่ยว)
  • ทำให้การขยายเป็นเรื่องง่ายด้วยฟอร์แมตเตอร์แบบกำหนดเองใหม่
  • เปิดใช้งานทางเลือกอื่นเป็นห้องสมุด ซึ่งเป็นรากฐานสำหรับผู้ใช้ในการสร้างเครื่องมือที่ตรงกับความต้องการเฉพาะ

ผู้ดูแล

Google ยังไม่รองรับเครื่องมือนี้อย่างเป็นทางการ ขณะนี้ได้รับการดูแลโดย @braydonk แต่เพียงผู้เดียว และเว้นแต่จะมีการเปลี่ยนแปลงใดๆ ในช่วงเวลาว่างเป็นหลัก

บล็อก

ฉันจะใช้ลิงก์เหล่านี้ไปยัง GitHub Discussions เป็นบล็อก จนกว่าฉันจะสามารถตั้งค่าบางอย่างที่เหมาะสมกว่านี้ได้:

  • การพัฒนาช้าล่าสุดของ yamlfmt #149
  • ปัญหาที่เกี่ยวข้องกับไลบรารี yaml.v3 #148

การติดตั้ง

หากต้องการดาวน์โหลดคำสั่ง yamlfmt คุณสามารถดาวน์โหลดไบนารีที่ต้องการจากรีลีสหรือติดตั้งโมดูลโดยตรง: 

 go install github.com/google/yamlfmt/cmd/yamlfmt@latest

ขณะนี้ต้องใช้ Go เวอร์ชัน 1.18 หรือสูงกว่า

หมายเหตุ: การตั้งค่าที่แนะนำหากนี่เป็นครั้งแรกที่คุณติดตั้ง Go จะอยู่ในโพสต์บล็อก DigitalOcean นี้

คุณยังสามารถดาวน์โหลดไบนารี่ที่คุณต้องการจากรีลีสต่างๆ ได้ ไบนารี่สามารถพึ่งพาตนเองได้โดยไม่มีการพึ่งพา และสามารถวางไว้ที่ไหนสักแห่งบน PATH ของคุณและรันด้วยคำสั่ง yamlfmt อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบความถูกต้องของอาร์ติแฟกต์ที่เผยแพร่ที่นี่

คุณยังสามารถติดตั้งคำสั่งเป็น hook ที่คอมมิตล่วงหน้าได้ ดูเอกสาร hook ก่อนคอมมิตสำหรับคำแนะนำ

การใช้งานขั้นพื้นฐาน

ดูการใช้คำสั่งสำหรับข้อมูลเชิงลึกและแฟล็กที่มี

หากต้องการรันเครื่องมือด้วยการตั้งค่าเริ่มต้นทั้งหมด ให้รันคำสั่งด้วยอาร์กิวเมนต์พาธ: 

yamlfmt x.yaml y.yaml < ... >

คุณสามารถระบุเส้นทางได้มากเท่าที่คุณต้องการ คุณยังสามารถระบุไดเร็กทอรีที่จะค้นหาไฟล์ใดๆ ที่มีนามสกุล .yaml หรือ .yml แบบวนซ้ำได้ 

yamlfmt .

คุณยังสามารถใช้โหมดทางเลือกที่จะค้นหาเส้นทางด้วย doublestar globs โดยระบุแฟล็ก -dstar 

yamlfmt -dstar ** / * .{yaml,yml}

ดูแพ็คเกจ doublestar สำหรับข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบนี้

ไฟล์การกำหนดค่า

คำสั่ง yamlfmt สามารถกำหนดค่าผ่านไฟล์ yaml ชื่อ . .yamlfmt ไฟล์นี้สามารถอยู่ในไดเร็กทอรีการทำงานของคุณ เส้นทางที่ระบุผ่านแฟล็ก CLI หรือในเส้นทางการกำหนดค่าส่วนกลางมาตรฐานบนระบบของคุณ (ดูเอกสารสำหรับข้อมูลเฉพาะ) สำหรับเอกสารการกำหนดค่าเชิงลึก โปรดดูที่การกำหนดค่า

การตรวจสอบอาร์ติแฟกต์การเผยแพร่

หมายเหตุ: รองรับการตรวจสอบด้วย cosign ตั้งแต่ v0.14.0 เป็นต้นไป

ในกรณีที่คุณได้รับไบนารี yamlfmt โดยตรงจากรุ่น คุณอาจต้องการตรวจสอบความถูกต้อง เช็คซัมจะถูกนำไปใช้กับอาร์ติแฟกต์ที่รีลีสทั้งหมด และไฟล์เช็คซัมที่เป็นผลลัพธ์จะถูกเซ็นชื่อโดยใช้ cosign

ขั้นตอนในการตรวจสอบ (แทนที่ ABC ในคำสั่งด้านล่างด้วยเวอร์ชันที่คุณต้องการ):

  1. ดาวน์โหลดไฟล์ต่อไปนี้จากรุ่น: 

     curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.pem
curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/checksums.txt.sig

  2. ตรวจสอบลายเซ็น: 

     cosign verify-blob checksums.txt 
    --certificate checksums.txt.pem 
    --signature checksums.txt.sig 
    --certificate-identity-regexp ' https://github.com/google/yamlfmt/.github/workflows/.+ ' 
    --certificate-oidc-issuer " https://token.actions.githubusercontent.com "

  3. ดาวน์โหลดไฟล์เก็บถาวรที่บีบอัดที่คุณต้องการ และตรวจสอบความถูกต้องของไฟล์: 

    curl -sfLO https://github.com/google/yamlfmt/releases/download/vA.B.C/yamlfmt_A.B.C_Linux_x86_64.tar.gz
sha256sum --ignore-missing -c checksums.txt

  4. หากผ่านการตรวจสอบความถูกต้องแล้ว ให้คลายการบีบอัดไฟล์เก็บถาวร: 

    tar -xzf yamlfmt_A.B.C_Linux_x86_64.tar.gz
./yamlfmt
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด