codespell-project/codespell

어떤 프로젝트인가요?

핵심 기능

• 01전체 사전이 아닌 선별한 흔한 오타 목록과 대조해 파일을 검사합니다.
• 02-w 및 -i 옵션으로 제안된 수정 사항을 자동으로 적용하거나 대화형으로 검토할 수 있습니다.
• 03단어 목록, 명령줄 플래그 또는 인라인 주석을 사용해 오탐을 무시할 수 있습니다.
• 04setup.cfg, .codespellrc 또는 pyproject.toml에서 설정을 읽습니다.
• 05pre-commit hook으로 실행할 수 있으며, 수정 사항이 기록될 때 CI 실행을 실패 처리할 수 있습니다.

활용 사례

• 개발 중 소스 코드의 주석, 식별자, 문서에서 오타를 찾습니다.
• CI 파이프라인이나 pre-commit hook에서 맞춤법 검사를 실행합니다.
• 대화형 수정을 통해 기존의 대규모 코드베이스에 있는 오타를 정리합니다.

빠른 시작

1. 1

   pip으로 PyPI에서 codespell을 설치합니다

   pip install codespell
2. 2

   현재 디렉터리에서 codespell을 실행합니다

   codespell

사용 전 알아둘 점

• !카피레프트 라이선스인 GPL-2.0에 따라 파생 코드의 배포 방식이 제한될 수 있습니다.
• !사전에 있는 흔한 철자 오류만 찾아내므로 드문 오타는 발견하지 못합니다.

토픽

자주 묻는 질문

codespell은(는) 무엇인가요?

선별한 오타 사전을 사용해 소스 코드와 텍스트 파일에서 흔한 오타를 찾아 수정하는 CLI 도구입니다. codespell은 전체 사전에 있는 단어인지 확인하는 대신, 자주 발생하는 오타를 선별한 목록과 대조해 파일을 검사합니다. 따라서 코드에 드물게 쓰이는 용어가 있어도 오탐을 줄이면서 "adn"처럼 "and"를 잘못 쓴 경우를 잡아낼 수 있습니다. 주로 소스 코드를 대상으로 하며 백슬래시 이스케이프는 건너뛰지만, 모든 텍스트 파일에서 사용할 수 있습니다.

codespell은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

codespell은(는) GPL-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

codespell은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. codespell의 마지막 커밋은 2026년 11월 6일입니다.

codespell은(는) 어디에 사용할 수 있나요?

개발 중 소스 코드의 주석, 식별자, 문서에서 오타를 찾습니다. CI 파이프라인이나 pre-commit hook에서 맞춤법 검사를 실행합니다. 대화형 수정을 통해 기존의 대규모 코드베이스에 있는 오타를 정리합니다.

codespell는 어떻게 설치하나요?

pip으로 PyPI에서 codespell을 설치합니다: pip install codespell 현재 디렉터리에서 codespell을 실행합니다: codespell

codespell은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/codespell-project/codespell