Tukarkan kebab-case kepada SCREAMING_SNAKE_CASE!

Rangkaian teks
Keputusan

Tukarkan kebab-case kepada SCREAMING_SNAKE_CASE!

Adakah nama pemboleh ubah kod yang disalin dari tempat lain tidak konsisten dengan kod anda? Jangan risau! Tukarkan pemboleh ubah kepada format yang dikehendaki!

Menukar nama kebab-case kepada SCREAMING_SNAKE_CASE: listen-port → LISTEN_PORT, max-body-size → MAX_BODY_SIZE. Inilah langkah daripada flag CLI atau kunci YAML kepada environment variable yang menggantikannya, corak di sebalik alat yang menerima kedua-dua --log-format dan LOG_FORMAT.

Tampal kunci fail config atau flag daripada output --help untuk mendapatkan nama pemboleh ubah yang sepadan bagi fail .env, Dockerfile dan tetapan CI.

Cara menggunakan

  1. Pilih kebab-case di kiri dan SCREAMING_SNAKE_CASE di kanan.
  2. Tampal kunci YAML, nama flag atau petikan --help ke dalam Rangkaian teks.
  3. Salin hasilnya; tambah awalan aplikasi anda (contohnya MYAPP_) jika alat anda memerlukannya.

Contoh

Input (kebab-case)
listen-port: 8080
log-format: json
max-body-size: 1mb
Output (SCREAMING_SNAKE_CASE)
LISTEN_PORT: 8080
LOG_FORMAT: json
MAX_BODY_SIZE: 1mb

Setiap kunci YAML menjadi nama environment variable berhuruf besar; nilai seperti json dan 1mb bukan kebab-case, jadi ia dikekalkan.

Ciri yang disokong

  • Menukar setiap tanda sempang kepada garis bawah dan menjadikan nama berhuruf besar: log-format → LOG_FORMAT, retry-2-times → RETRY_2_TIMES.
  • Aksara di sekeliling nama, termasuk -- di hadapan, dibiarkan di tempatnya.
  • Perkataan tanpa tanda sempang tidak dipadankan, jadi nilai biasa kekal huruf kecil.

Kes penggunaan

Mendokumenkan env override untuk CLI

Jika CLI Go atau Rust mengikat flag kepada environment variable (seperti yang boleh dilakukan oleh viper atau ciri env dalam clap), menukar senarai flag memberikan nama pemboleh ubah untuk didokumenkan.

Docker dan CI daripada config YAML

Apabila sesuatu service membaca listen-port daripada config.yaml tetapi turut membenarkan override melalui environment, nama yang ditukar itulah yang dimasukkan ke dalam docker-compose.yml atau tetapan secret CI.

Nota dan had

  • Jika anda menampal flag beserta --, sempang itu kekal: --log-level → --LOG_LEVEL. Tampal nama tanpa awalan.
  • Ungkapan pendek seperti x-1 juga kelihatan seperti kebab-case dan menjadi X_1, jadi jauhkan aritmetik daripada input.

Soalan lazim

Adakah ia menambah awalan seperti APP_?

Tidak. Tambahkannya dalam editor anda selepas itu, atau sertakan dalam input sebagai app-listen-port.

Bagaimana dengan kunci seperti http2-enabled?

Ia ditukar dengan kemas kepada HTTP2_ENABLED, kerana digit itu sebahagian daripada segmen pertama.