แปลง kebab-case เป็น SCREAMING_SNAKE_CASE!

ข้อความตัวอักษร
ผลลัพธ์

แปลง kebab-case เป็น SCREAMING_SNAKE_CASE!

การตั้งชื่อตัวแปรในโค้ดที่คัดลอกจากที่อื่นไม่ตรงกับโค้ดของคุณใช่ไหม? ไม่ต้องกังวล! แปลงตัวแปรให้เป็นรูปแบบที่ต้องการ!

เปลี่ยนชื่อแบบ kebab-case เป็น SCREAMING_SNAKE_CASE: listen-port → LISTEN_PORT, max-body-size → MAX_BODY_SIZE นี่คือขั้นจากแฟล็ก CLI หรือคีย์ YAML ไปเป็น environment variable ที่ใช้ override ค่านั้น ซึ่งเป็นรูปแบบเบื้องหลังเครื่องมือที่รับทั้ง --log-format และ LOG_FORMAT

วางคีย์ของไฟล์คอนฟิกหรือแฟล็กจากผลลัพธ์ --help เพื่อให้ได้ชื่อตัวแปรที่ตรงกันสำหรับไฟล์ .env, Dockerfile และการตั้งค่า CI

วิธีใช้

  1. เลือก kebab-case ด้านซ้ายและ SCREAMING_SNAKE_CASE ด้านขวา
  2. วางคีย์ YAML ชื่อแฟล็ก หรือข้อความบางส่วนจาก --help ลงใน ข้อความตัวอักษร
  3. คัดลอกผลลัพธ์ และเติม prefix ของแอป (เช่น MYAPP_) ถ้าเครื่องมือของคุณต้องการ

ตัวอย่าง

อินพุต (kebab-case)
listen-port: 8080
log-format: json
max-body-size: 1mb
เอาต์พุต (SCREAMING_SNAKE_CASE)
LISTEN_PORT: 8080
LOG_FORMAT: json
MAX_BODY_SIZE: 1mb

คีย์ YAML แต่ละตัวกลายเป็นชื่อ environment variable ตัวพิมพ์ใหญ่ ส่วนค่าอย่าง json และ 1mb ไม่ใช่ kebab-case จึงคงเดิม

ฟีเจอร์ที่รองรับ

  • เปลี่ยนขีดกลางทุกตัวเป็นขีดล่างและเปลี่ยนชื่อเป็นตัวพิมพ์ใหญ่: log-format → LOG_FORMAT, retry-2-times → RETRY_2_TIMES
  • ตัวอักษรรอบชื่อ รวมถึง -- ข้างหน้า ถูกปล่อยไว้ที่เดิม
  • คำที่ไม่มีขีดกลางไม่ถูกจับ ค่าธรรมดาจึงยังเป็นตัวพิมพ์เล็ก

กรณีการใช้งาน

เขียนเอกสาร env override ของ CLI

ถ้า CLI ที่เขียนด้วย Go หรือ Rust ผูกแฟล็กกับ environment variable (อย่างที่ viper หรือ feature env ของ clap ทำได้) การแปลงรายการแฟล็กจะได้ชื่อตัวแปรไว้ใส่ในเอกสาร

Docker และ CI จากคอนฟิก YAML

เมื่อเซอร์วิสอ่าน listen-port จาก config.yaml แต่ก็ยอมให้ override ด้วย environment ชื่อที่แปลงแล้วคือสิ่งที่ใส่ลงใน docker-compose.yml หรือการตั้งค่า secret ของ CI

ข้อควรระวังและข้อจำกัด

  • ถ้าวางแฟล็กพร้อม -- ขีดจะยังอยู่: --log-level → --LOG_LEVEL ให้วางชื่อโดยไม่มี prefix
  • นิพจน์สั้น ๆ อย่าง x-1 ก็ดูเหมือน kebab-case และกลายเป็น X_1 จึงไม่ควรใส่นิพจน์คำนวณในอินพุต

คำถามที่พบบ่อย

เติม prefix อย่าง APP_ ให้ไหม?

ไม่ ให้เติมในเอดิเตอร์ภายหลัง หรือใส่ไว้ในอินพุตเป็น app-listen-port

คีย์อย่าง http2-enabled ล่ะ?

แปลงได้เรียบร้อยเป็น HTTP2_ENABLED เพราะตัวเลขเป็นส่วนหนึ่งของช่วงแรก