코드 오타 방지 위원회 : Code Spell Checker 플러그인 사용하기. (VSCode)

작성 : 2023-07-31수정 : 2023-07-31

목차 펼치기

머리말

코드를 개발하면서 종종 오타라고 인지가 잘 되지 않는 단어들이 있다. 예를 들면 다음과 같다.

  • process vs prosess

  • speech vs speach

  • success vs sucess

  • waiting vs wating

  • inventory vs invetory

  • recommend vs recomend

  • referer vs referrer

    • 특히 이 케이스는 오타가 정규 스펙에 등재되어 버린 놀라운 사례다.


교체 오류, 누락 오류, 삽입 오류, 이동 오류 등의 이런 오타들은 기능상 문제가 되지 않더라도 코드의 퀄리티 하락을 야기할 수 있다. 개인적으로 코드도 일종의 글쓰기라고 생각하고 더 잘 쓰기 위한 방법을 고민하는 사람으로서 맞춤법은 매우 중요한 요소다. 특히 IDE Intellisense, 복사, 붙여넣기로 코딩을 계속 하다 보면 이런 오타에 잠식될 수도 있다.


소개

이를 미연에 방지해주기 위한 플러그인으로 VSCode의

Code Spell Checker

가 있다. 오탈자에 밑줄을 생성해서 알려주고, 일부 단어들은 검사 예외 처리 되도록 설정할 수 있다. 예외 처리는 프로젝트 도메인 상에서 사용되는 단어들을 미리 설정해두면 좋을 것 같다.


  • 카멜 케이스, 스네이크 케이스는 각각의 대소문자로 분리한다.

  • 대소문자 구분 없이 영어만 지원 가능하다

  • 길이가 3자 초과인 단어만 검사한다.

  • 모든 기호와 구두점은 무시된다.


설치 및 사용




VSCode 플러그인 설치

  1. Extension 탭으로 이동한다. (Cmd + Shift + X)

  2. Code Spell Checker를 검색 후 설치한다.


커스텀 단어 설정

VSCode의

settings.json

이나,

cspell.json

파일을 통해 설정할 수 있다.

아래의 내용은 프로젝트에서 올바른 단어로 등록하는 설정이다. 추가적인 설정 방법은

공식 문서

를 참조하자.

단순히 밑줄을 지우기 위해서는

ignore

, 올바른 단어로 취급해서 단어 추천 목록에도 나타나게 하기 위해서는

words

키워드를 사용한다.


  • /.vscode/settings.json

    파일의 설정을 변경한다

    bash
    1{
    2	...
    3	// Words to add to dictionary for a workspace.
    4  "cSpell.words": ["weezip", "treefeely", "ethan"]
    5}

  • cspell.json
    bash
    1{
    2	// Version of the setting file.  Always 0.2
    3  "version": "0.2",
    4  // language - current active spelling language
    5  "language": "en",
    6  // words - list of words to be always considered correct
    7  "words": [
    8      "weezip",
    9      "treefeely",
    10      "ethan",
    11  ],
    12  // flagWords - list of words to be always considered incorrect
    13  // This is useful for offensive words and common spelling errors.
    14  // For example "hte" should be "the"
    15  "flagWords": [
    16      "hte"
    17  ]
    18}


오탈자 한 번에 수정하기

  1. VScode에서 Cmd + Shift + H 를 눌러 Search 탭의 일괄변경 기능을 연다.

  2. 전체 단어를 바꿔주기 전에 변경 후에 이슈는 없는 지 확인 후 변경한다.


Contact Me

All Icons byiconiFy