위키득계정 ↗
기술

Codespell

Codespell기술
주요 대상
소스 코드와 텍스트 파일
검사 기준
흔한 오타 목록
주요 기능
탐지와 선택적 수정
설정 방식
설정 파일과 명령행 옵션
Codespell은 텍스트 파일과 소스 코드에서 흔한 철자 오류를 찾는 검사 도구다. 모든 낱말의 사전 등재 여부를 판단하기보다 알려진 오타와 교정 표현을 바탕으로 검사한다.

오타 목록으로 찾기

일반 맞춤법 검사기는 모르는 단어를 의심하는 방식으로 동작하기도 한다. Codespell은 알려진 흔한 철자 오류를 찾는 접근이다. 사전에 없는 전문 용어를 모두 오류로 취급하지 않는 대신, 목록에 없는 임의의 잘못된 문자열까지 빠짐없이 탐지하지는 않는다.

탐지와 수정의 구분

대상 파일이나 디렉터리를 지정해 검사할 수 있다. 기본 실행은 변경 없이 결과를 보여주며 쓰기 옵션으로 실제 수정을 적용할 수 있다. 대화형 확인도 제공하므로 제안된 표현이 해당 문맥에 맞는지 검토하는 흐름을 구성할 수 있다.

프로젝트에 맞게 예외 관리

의도적으로 사용하는 이름이나 표기를 허용 목록으로 관리하고 특정 파일과 줄을 검사에서 제외할 수 있다. 설정 파일에 제외 경로와 검사 옵션을 저장하면 개발자가 같은 기준을 공유하기 쉽다. 커밋 전 검사에 연결하는 방식도 지원하지만 철자 검사가 문서의 사실성과 코드 동작을 판단하는 것은 아니다.

관련 문서

Typos / Vale 문서 검사기 / Markdownlint / Semgrep / EditorConfig