공유/기타

Dead Code 찾기, 사용하지 않는 파일, 변수 찾기

구하천포 2024. 7. 10. 13:17

Dead Code 찾기, 사용하지 않는 파일, 변수 찾기

JavaScript Dead Code 찾기
JavaScript 사용하지 않는 파일 찾기
JavaScript 사용하지 않는 변수 찾기
JavaScript 사용하지 않는 export 찾기

Dead Code 란

Dead Code 이름 그대로 죽은 코드입니다.
즉, 실행되지 않는 코드를 의미합니다.

해당 코드를 계속 두는 것은 좋은 개발환경이라고 볼 수 없습니다.

  • 용량 차지
  • 빌드 속도 우려
  • import 시 불편함
  • 파일, 코드 찾을 때 불편함
  • 코드 읽을 때 불편함

등이 있을 수 있습니다.

knip

knip 패키지를 사용하면 dead code를 빠르게 찾아줍니다.
knip을 활용하여 어떻게 dead code삭제하는 지 알아보도록 하겠습니다.

knip 설치

npm init @knip/config
pnpm create @knip/config
yarn create @knip/config

사용하는 패키지 매니저에 맞게 설치하시면 됩니다.
자세한 설정이나 설명은 아래 참고문헌에 있는 knip 링크를 확인해보세요.

knip 사용하기

프로젝트 경로에서 아래 명령어를 이용하시면 됩니다.
저는 제 프로젝트에서 실행해보도록 하겠습니다.

npx knip

위에 보시면 사용하지 않는 파일, 변수들에 대한 정보들이 나와있습니다.
잘못 되었을 수도 있으니 직접 확인하신 후 지우시는 것을 추천 드립니다.

저 같은 경우 사용하지 않는 파일은 command 명령어로 다 지웠습니다.
나머지는 직접 파일 하나 하나 확인하면서 삭제하였습니다.

잘 되었는지 확인하기 위해 마지막에 tsc로 한번 더 확인하였습니다.

위 결과 이미지를 보면 약 14,000줄을 삭제한 것을 확인할 수 있습니다.
삭제하면서 쓰레기를 정리하는 기분이 들어 재미있게 지웠습니다.

주의점

knip을 100% 신뢰할 수는 없는 것 같습니다.
script 에서 사용하는 것일 수도 있고 잘못된 결과를 출력할 수도 있기 때문입니다.
그리고 삭제하면서 다른 사이드 이펙트가 생길 확률이 있습니다.

꼭 직접 확인하시면서 지우는 것을 추천 드립니다.

코드를 구현하다보면 사용하지 않는 코드나 파일이 생깁니다.
즉시 지우면 좋겠지만 나도 모르게 남겨두는 경우가 많이 있습니다.
knip을 사용하여 편하고 빠르게 지우시길 바랍니다.

참고문헌

• knip

반응형