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

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

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

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

แปลงชื่อสไตล์ environment variable เป็น kebab-case: LOG_LEVEL → log-level, WORKER_COUNT → worker-count สองสไตล์นี้มักอธิบายการตั้งค่าเดียวกันในที่ต่างกัน ฝั่งหนึ่งเป็น env var อีกฝั่งเป็นแฟล็ก --log-level บนบรรทัดคำสั่ง ค่าใน Helm หรือคีย์ใน ConfigMap ของ Kubernetes

วางไฟล์ .env หรือรายการตัวแปรเพื่อให้ได้ชื่อตัวพิมพ์เล็กที่มีขีดกลาง ซึ่ง CLI และเครื่องมือที่อิง YAML จำนวนมากใช้

วิธีใช้

  1. เลือก SCREAMING_SNAKE_CASE → kebab-case
  2. วางตัวแปรลงใน ข้อความตัวอักษร จะมีค่าติดมาด้วยหรือไม่ก็ได้
  3. คัดลอก ผลลัพธ์ แล้วเติม -- ข้างหน้าถ้าต้องการไวยากรณ์ของแฟล็ก

ตัวอย่าง

อินพุต (SCREAMING_SNAKE_CASE)
LOG_LEVEL=debug
CACHE_DIR=/tmp/app-cache
WORKER_COUNT=4
เอาต์พุต (kebab-case)
log-level=debug
cache-dir=/tmp/app-cache
worker-count=4

ชื่อหน้า = ถูกแปลง ส่วน path /tmp/app-cache ใช้ขีดกลางและตัวพิมพ์เล็กอยู่แล้ว จึงไม่ถูกรู้จักว่าเป็น SCREAMING_SNAKE_CASE และคงเดิม

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

  • เปลี่ยนชื่อเป็นตัวพิมพ์เล็กและแทนขีดล่างทุกตัวระหว่างช่วงด้วยขีดกลาง: CACHE_DIR → cache-dir
  • ค่าและ path ในบรรทัดเดียวกันถูกปล่อยไว้
  • ขีดล่างนำหน้าของชื่อสไตล์ private ถูกตัดออก: _INTERNAL_FLAG → internal-flag

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

เปิดการตั้งค่าจาก env ให้เป็นแฟล็ก CLI

เครื่องมือหลายตัวรับ option เดียวกันเป็น MYAPP_LOG_LEVEL หรือ --log-level การแปลงรายการ env var ช่วยเขียนนิยามแฟล็กและข้อความ help

คีย์คอนฟิกของ Helm และ Kubernetes

Helm chart และ ConfigMap มักใช้คีย์แบบมีขีดกลางหรือ camelCase ขณะที่คอนเทนเนอร์อ่านตัวแปรแบบ SCREAMING_SNAKE_CASE การแปลงจะได้ชื่อคีย์สำหรับฝั่ง chart ของการจับคู่นั้น

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

  • ช่วงที่เป็นตัวเลขได้ขีดกลางเหมือนส่วนอื่น: HTTP_2_ENABLED → http-2-enabled
  • ตัวแปรคำเดียวอย่าง PORT ไม่ถูกแปลง

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

ใช้ผลลัพธ์เป็นชื่อ environment variable ได้ไหม?

ใช้ข้ามระบบไม่ได้ shell ส่วนใหญ่ไม่ยอมให้ชื่อตัวแปรมีขีดกลาง ให้ใช้ SCREAMING_SNAKE_CASE กับตัวแปรเอง และใช้ kebab-case กับแฟล็กและคีย์คอนฟิก

เติม prefix -- ให้ไหม?

ไม่ เปลี่ยนแค่ชื่อ ถ้าอินพุตมี -- อยู่แล้ว จะถูกเก็บไว้