가이드

chki18n은 i18n 번역 파일이 있는 폴더를 읽어, 모든 언어를 하나의 기준 언어와 비교하고 어긋나는 부분을 보고합니다. 이 섹션에서는 설치와 실행 방법, 인식하는 파일 구조, 수행하는 검사, 그리고 이를 제어하는 옵션을 다룹니다.

이 섹션의 문서

• 시작하기 — 패키지를 고르고 설치해서 커맨드라인이나 코드에서 첫 리포트를 받아봅니다.
• 커맨드라인 — 모든 플래그, 종료 코드, CI나 pre-commit 훅에 연결하는 방법.
• CI에 붙이기 — GitHub Actions와 Bitbucket Pipelines에 그대로 붙여 넣는 작업.
• 파일 구조 — 로케일당 파일 하나, 로케일당 폴더 하나, 또는 모든 로케일을 담은 파일 하나. 그리고 비교를 위해 파일을 어떻게 그룹으로 묶는지.
• 검사 항목 — 25가지 검사 각각의 의미와, 특정 검사를 끄거나 심각도를 바꾸는 방법.
• 옵션 — CLI와 API가 공유하는 전체 옵션.

동작 방식

하나의 언어가 기준(target) 이 됩니다. 가장 먼저 작성하고 거기서부터 번역해 나가는 언어입니다. 나머지 언어는 모두 이 기준 언어와 키 단위로 비교됩니다. 기준 언어에는 있는데 번역에는 없는 키는 오류이고, 기준 언어와 값이 똑같다면 실제로 번역되지 않았다는 경고입니다. 경로와 기준 언어 외에 설정할 것은 없습니다. 작성해야 할 설정 파일도, 조립해야 할 규칙 세트도 없습니다.

하나의 라이브러리, 세 언어

chki18n은 JavaScript, Dart, Python으로 배포되지만 셋은 하나의 라이브러리입니다. 검사도 순서도 옵션 이름도 같고, 어느 패키지가 출력했든 리포트는 열 위치까지 일치합니다. 이 사이트의 모든 페이지가 세 언어를 한 번에 설명하므로, 사이드바 위쪽의 전환 버튼에서 쓰는 언어를 고르면 예제 코드가 따라 바뀝니다.

하지 않는 일

번역을 대신 해 주지 않으며, 파일을 수정하지도 않습니다. 모든 진입점은 읽고 보고하기만 하고, 고쳐 쓰는 일은 사용자의 몫입니다. 일부 검사의 자동 수정은 계획에 있지만 아직 제공하지 않습니다.