husky, lint-staged 셋업

2024. 8. 2.·⚙️ 개발 팁 & 노하우/프론트엔드

📍설치

yarn add -D husky lint-staged

 

📍husky 초기화

npx husky init

- 그러면 .husky 폴더가 만들어지고, 그 안에 pre-commit 파일이 생긴다

- pre-commit 파일에 pre commit hook을 작성할 수 있다

- 그리고 설치한 내용을 반영하기 위해 커밋을 한번 해준다

 

📍husky 테스트

- 일단 .husky/pre-commit 파일에 테스트 명령어를 입력해서 pre commit hook이 잘 동작하는지 테스트해본다

echo "pre commit hook test"

- 빈 커밋 날려보기 (VS Code에서 소스 컨트롤(GUI)로 커밋을 하면 husky 적용이 안되므로 터미널에 입력해야 함)

git commit --allow-empty -m "test commit"

- 터미널에 pre commit hook test 가 출력되면 정상이다

- 이제 pre-commit 훅에 기존 내용을 지우고 lint-staged가 실행되게 수정한다

 

📍lint-staged config 파일 작성

- package.json에 lint-staged 프로퍼티에 config를 작성할 수 있다

- 아래는 Nuxt3 프로젝트 기준으로 작성한 lint-staged config 

  "lint-staged": {
    "*.{mjs,cjs,js,ts,md,html,css}": "prettier --write",
    "app/**/*.{ts,vue}": [
      "eslint --fix",
      "prettier --write"
    ],
    "server/**/*.ts": [
      "eslint --fix",
      "prettier --write"
    ]
  },

 

📍lint-staged 테스트

- 변경사항을 만들고 커밋을 날려본다

- 이 때, 변경 사항이 공백일 경우, git commit 시 --allow-empty 옵션을 추가해야 한다

git add .
git commit -m "test commit"

 

터미널에 아래 내용이 출력되고, 변경 사항에 lint가 이루어지면 성공이다

'⚙️ 개발 팁 & 노하우/프론트엔드' 카테고리의 다른 글
  • [Tanstack Query] 계정이 바뀌면 캐시된 기존 데이터 지우기
  • [Next.js] 프로젝트만들고 ESLint, Prettier 설치하기
  • Nuxt3 프로젝트에 ESLint, Prettier 적용하기
  • Chrome DevTools의 각 탭 살펴보기
지식물원
지식물원
지식이 자라는 식물원!
  • 지식물원
    지식물원
    지식물원
  • 전체
    오늘
    어제
    • 분류 전체보기 (510)
      • 🎨 프론트엔드 공부 (247)
        • JS & TS (86)
        • HTML & CSS (22)
        • React & Next (49)
        • Vue & Nuxt (22)
        • 기타 (68)
      • 🤓 기술 학습 & 공부 기록 (116)
        • Node.js (0)
        • Python (37)
        • 백엔드 (0)
        • 딥러닝 (1)
        • 컴퓨터 일반 (72)
        • 개발 인프라 (6)
      • 👨‍💻 프로젝트 경험 (6)
        • Work (0)
        • Toy (6)
      • ⚙️ 개발 팁 & 노하우 (21)
        • 프론트엔드 (6)
        • 기타 (15)
      • ☕️ 커리어 & 인터뷰 준비 (88)
        • 코딩 테스트 (88)
      • 📰 기술 트렌드 & 생각 정리 (4)
      • 📚 기타 (25)
        • 마케팅 (15)
        • 비개발서적 (10)
  • 블로그 메뉴

    • 태그
  • 링크

  • 공지사항

    • 모바일 접속 시 코드 하이라이팅 깨질 때
  • 인기 글

  • hELLO· Designed By정상우.v4.10.3
지식물원
husky, lint-staged 셋업
상단으로

티스토리툴바