Chuyển đổi kebab-case thành SCREAMING_SNAKE_CASE!

Chuỗi văn bản
Kết quả

Chuyển đổi kebab-case thành SCREAMING_SNAKE_CASE!

Các biến mã từ nơi khác sao chép có tên không nhất quán với mã của bạn? Đừng lo lắng! Chuyển đổi biến thành định dạng mong muốn!

Biến tên kebab-case thành SCREAMING_SNAKE_CASE: listen-port → LISTEN_PORT, max-body-size → MAX_BODY_SIZE. Đây là bước từ một flag CLI hay key YAML sang biến môi trường ghi đè nó, mô hình đứng sau những công cụ nhận cả --log-format lẫn LOG_FORMAT.

Dán key của file cấu hình hoặc các flag từ output --help để có tên biến tương ứng cho file .env, Dockerfile và cài đặt CI.

Cách sử dụng

  1. Chọn kebab-case bên trái và SCREAMING_SNAKE_CASE bên phải.
  2. Dán key YAML, tên flag hoặc một đoạn trích --help vào ô Chuỗi văn bản.
  3. Sao chép kết quả; thêm tiền tố của ứng dụng (ví dụ MYAPP_) nếu công cụ của bạn yêu cầu.

Ví dụ

Đầu vào (kebab-case)
listen-port: 8080
log-format: json
max-body-size: 1mb
Đầu ra (SCREAMING_SNAKE_CASE)
LISTEN_PORT: 8080
LOG_FORMAT: json
MAX_BODY_SIZE: 1mb

Mỗi key YAML thành tên biến môi trường viết hoa; các giá trị như json và 1mb không phải kebab-case nên được giữ lại.

Tính năng hỗ trợ

  • Đổi mọi dấu gạch nối thành gạch dưới và viết hoa tên: log-format → LOG_FORMAT, retry-2-times → RETRY_2_TIMES.
  • Ký tự quanh tên, kể cả -- ở đầu, được để nguyên chỗ.
  • Từ không có gạch nối thì không khớp, nên giá trị thông thường vẫn giữ chữ thường.

Trường hợp sử dụng

Ghi tài liệu biến môi trường ghi đè cho CLI

Nếu một CLI viết bằng Go hay Rust gắn flag với biến môi trường (như viper hoặc tính năng env của clap làm được), chuyển danh sách flag sẽ cho ra tên biến cần ghi vào tài liệu.

Docker và CI từ config YAML

Khi một service đọc listen-port từ config.yaml nhưng cũng cho phép ghi đè bằng biến môi trường, tên đã chuyển chính là thứ cần đưa vào docker-compose.yml hoặc phần cài đặt secret của CI.

Lưu ý và giới hạn

  • Nếu bạn dán flag có --, dấu gạch vẫn còn: --log-level → --LOG_LEVEL. Hãy dán tên không kèm tiền tố.
  • Biểu thức ngắn như x-1 cũng trông giống kebab-case và thành X_1, nên đừng để phép tính lẫn vào đầu vào.

Câu hỏi thường gặp

Có thêm tiền tố như APP_ không?

Không. Hãy thêm nó trong editor sau đó, hoặc đưa luôn vào đầu vào dưới dạng app-listen-port.

Còn key như http2-enabled thì sao?

Chúng được chuyển gọn gàng thành HTTP2_ENABLED, vì chữ số là một phần của đoạn đầu tiên.