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

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

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

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

แทนขีดล่างในชื่อแบบ snake_case ด้วยขีดกลาง: output_dir → output-dir ชื่อตัวพิมพ์เล็กที่มีขีดกลางเป็นมาตรฐานของ option แบบยาวบนบรรทัดคำสั่ง path ของ URL ชื่อ resource ใน Kubernetes ชื่อแพ็กเกจ npm และคลาส CSS ซึ่งไม่มีอันไหนใช้ขีดล่างตามธรรมเนียม

กรณีที่พบบ่อยคือสคริปต์ Python ที่ option ของ argparse หรือคีย์คอนฟิกเขียนด้วยขีดล่าง แล้วตอนนี้ต้องใช้รูปแบบ --flag-name ตามธรรมเนียม หรือ identifier ในฐานข้อมูลที่ต้องไปปรากฏใน URL

วิธีใช้

  1. ตั้งคู่เป็น snake_case → kebab-case
  2. วางแฟล็ก คีย์ หรือช่วงของ path ลงใน ข้อความตัวอักษร บรรทัดละหนึ่งรายการหรือในบรรทัดเดียวก็ได้
  3. คัดลอกข้อความใน ผลลัพธ์

ตัวอย่าง

อินพุต (snake_case)
--dry_run
--output_dir dist
--max_workers 4
เอาต์พุต (kebab-case)
--dry-run
--output-dir dist
--max-workers 4

ชื่อ option แต่ละตัวได้ขีดกลาง และ -- ข้างหน้ากับค่า dist และ 4 ถูกเก็บไว้ ใน argparse --dry-run ยังถูกอ่านเป็น args.dry_run ฝั่ง Python จึงไม่เปลี่ยน

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

  • ขีดล่างทุกตัวภายในชื่อกลายเป็นขีดกลาง: max_workers → max-workers, address_line_2 → address-line-2
  • ข้อความรอบชื่ออย่าง --, / หรือ ?page= ถูกเก็บไว้
  • ขีดล่างนำหน้าหนึ่งตัวถูกลบ: _internal_id → internal-id

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

จัดระเบียบ option ของ CLI

argparse และ click รับ --output_dir ได้ แต่ผู้ใช้คาดหวัง --output-dir การแปลงรายการ option แล้วแก้การเรียก add_argument ทำให้ชื่อ attribute (output_dir) ยังเหมือนเดิม

slug ของ URL จากคีย์ในฐานข้อมูล

รหัสหมวดหมู่อย่าง gift_cards หรือ order_history ที่เก็บในตารางเปลี่ยนเป็น path /gift-cards และ /order-history ได้ ซึ่งเป็นสไตล์ที่พบบ่อยกว่าสำหรับ URL สาธารณะ

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

  • ชื่อที่ขึ้นต้นด้วยขีดล่างคู่อย่าง __version__ ไม่ถูกจับและยังคงขีดล่างไว้
  • เมื่อวางโค้ด Python ทั้งบรรทัด ชื่อฟังก์ชันอย่าง add_argument และคีย์เวิร์ดอย่าง store_true ก็ถูกแปลงด้วย ทำให้โค้ดพัง ให้วางเฉพาะชื่อ

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

ชื่อที่มีขีดกลางเป็น identifier ที่ถูกต้องของ Python ไหม?

ไม่ kebab-case ใช้กับสตริงอย่าง option, URL, ชื่อไฟล์ และชื่อ resource ตัวแปรของ Python ให้คงเป็น snake_case

Kubernetes รับผลลัพธ์เป็นชื่อ resource ได้ไหม?

ชื่อใน Kubernetes ยอมให้มีตัวพิมพ์เล็ก ตัวเลข และขีดกลาง ซึ่งตรงกับสิ่งที่ได้จากอินพุต snake_case ปกติพอดี รวมถึงช่วงที่เป็นตัวเลข