VSCode에 TODO Hightlight extension 이용하기

VSCode exension 중 TODO Hightlight 에 대한 적용방법을 기록합니다.

TODO Hightlight 기본 사용법

우선 extension에서 TODO hightlight를 설치합니다.

아래와 같이 주석에 TODO, FIXME라는 것을 입력하면 됩니다.

여기에 “:”을 꼭 붙여주셔서 하이라이트가 된다는 점을 알아주셔야 합니다.

# TODO: 해야 하는 업무인데 바빠서 아직 못함

커맨트 팔렛트(ctrl+shift+p)에서 TODO를 입력하면 관련 기능이 나옵니다.

TODO-Highlight: Listh highlighted annotation은 현재 작업 공간에서 TODO 표시한 목록들을 모두 보여줍니다.

TODO-Highlight: Toggle highlight 는 하이라이트 기능을 키고/끄고 할 수 있는 명령입니다.

List highlighted annotations을 클릭하면 모든 키워드를 찾아볼지, 특정 키워드만 찾아볼지 선택할 수 있습니다.

ALL을 클릭하면 하이라이트로 설정한 모든 키워드에 대해서 찾아서 정리해줍니다.

TODO Hightlight 적용 안될시 (feat. 파이썬 사용자)

파이썬 사용자의 경우 설치 후 바로 적용이 되지 않습니다.

몇 가지 설정을 해줘야 합니다.

ctrl+, 로 user settings 창을 띄웁니다.

검색 창에서 json을 입력하여 edit in settings.json 을 찾아서 클릭합니다.

여기서 파이썬 파일들의 TODO를 찾을 수 있게 "todohighlight.include":["**/*.py"] 설정을 추가해줘야 합니다.

TODO, FIXME외에 키워드들도 하잍라이트 해주고 싶다면 아래와 같이 설정을 추가해줍니다.

  "todohighlight.include": ["**/*.py"],
  "todohighlight.exclude": ["**/.venv/**"],
  "todohighlight.keywords": [
    {
      "text": "TODO:",
      "color": "#f1f1f1",
      "backgroundColor": "#5E0B15",
      "overviewRulerColor": "grey"
    },
    "DEBUG:",
    {
      "text": "REVIEW:",
      "color": "#f1f1f1",
      "backgroundColor": "#90323D",
      "overviewRulerColor": "grey"
    },
    {
      "text": "NOTE:",
      "color": "#f1f1f1",
      "backgroundColor": "#8C7A6B",
      "overviewRulerColor": "grey"
    }
  ],

  "todohighlight.include": ["**/*.py"],
  "todohighlight.exclude": ["**/.venv/**"],
  "todohighlight.keywords": [
    {
      "text": "TODO:",
      "color": "#f1f1f1",
      "backgroundColor": "#5E0B15",
      "overviewRulerColor": "grey"
    },
    "DEBUG:",
    {
      "text": "REVIEW:",
      "color": "#f1f1f1",
      "backgroundColor": "#90323D",
      "overviewRulerColor": "grey"
    },
    {
      "text": "NOTE:",
      "color": "#f1f1f1",
      "backgroundColor": "#8C7A6B",
      "overviewRulerColor": "grey"
    }
  ],

이제 다른 키워드들도 하이라이트가 되는 것을 볼 수 있으며, 리스트로 한번에 이들을 확인 할 수 있게 되었습니다.

참고하면 좋은 글

VScode에서 Git 시작하기

… Git은 버전 관리 시스템(VCS, Version Control System) 중 하나로, 소스 코드 및 파일의 변경 이력을 관리하고 추적하는 도구입니다. … Read more

autopep8 설치 및 설정 (VScode) : 자동으로 코딩 컨벤션 따르기

python에서는 pep8 코드 컨벤션에 맞게 코드를 자동으로 서식을 맞춰주는 “autopep8″이라는 자동 formatter가 존재합니다. 이번 포스트에서는 autopep8 설치, 사용법, 또 필요에 따라 설정을 변경하는 법을 정리해보았습니다…. Read more

Python(파이썬): 패키지 관리를 위한 가상 환경

파이썬으로 개발을 하고 배포하다 보면 패키지 관리의 필요성이 절실해지게 됩니다. 이번 포스팅에서는 “가상 환경 설정이 왜 필요하고 어떻게 해야 하는지”에 대해 작성하였습니다…. Read more