NetAlertX은(는) 무엇을 하나요?
NetAlertX 설정(config.json)을 생성하고 유지 관리하기 위한 모범 사례 제공. UI, 검증, 현지화, 런타임 동작 및 구현 일관성 포함.
개요
이 스킬은 NetAlertX 플랫폼에서 config.json 파일을 효과적으로 다루는 방법을 설명합니다. 설정 파일은 애플리케이션의 동작을 제어하는 핵심 요소입니다.
주요 기능
- UI 구성: 설정 값에 대한 사용자 인터페이스 요소 정의
- 검증: 입력 값의 타입, 범위, 필수 여부 검사
- 현지화: 다국어 지원을 위한 레이블 및 설명 제공
- 런타임 동작: 설정 변경 시 실시간 반영 여부 및 동작 방식 정의
- 일관성: 전체 설정 구조의 일관된 패턴 유지
사용 방법
config.json파일을 프로젝트 루트에 생성합니다.- 아래 예시와 같이 설정 항목을 정의합니다.
{
"settings": {
"logLevel": {
"type": "string",
"default": "info",
"enum": ["debug", "info", "warn", "error"],
"label": {
"en": "Log Level",
"ko": "로그 수준"
},
"description": {
"en": "Sets the verbosity of logging.",
"ko": "로깅의 상세 수준을 설정합니다."
},
"validation": {
"required": true
},
"runtime": {
"reload": true
}
}
}
}
검증 규칙
설정 값에 적용할 수 있는 검증 규칙은 다음과 같습니다:
| 규칙 | 설명 | 예시 |
|---|---|---|
type | 값의 데이터 타입 | string, number, boolean |
required | 필수 여부 | true 또는 false |
minimum | 최소값 | 0 |
maximum | 최대값 | 100 |
pattern | 정규식 패턴 | "^[a-zA-Z]+$" |
현지화 모범 사례
- 모든 사용자 대상 문자열은
label및description필드에 다국어로 제공합니다. - 언어 코드는 ISO 639-1 표준을 따릅니다.
- 기본 언어는 영어(
en)로 설정합니다.
런타임 동작
runtime.reload:true로 설정하면 설정 변경 시 애플리케이션이 자동으로 리로드됩니다.runtime.restart:true로 설정하면 설정 변경 시 애플리케이션 재시작이 필요합니다.
구현 일관성 유지하기
- 모든 설정 항목에는
type,default,label,description필드가 포함되어야 합니다. enum필드는 값이 제한된 선택지일 때 사용합니다.- 검증 규칙은 가능한 한 구체적으로 정의하여 사용자 오류를 방지합니다.
참고 자료
- NetAlertX 공식 문서
config.json스키마 정의 파일- 예제 설정 파일