Biome npm-scripts 설정

Biome을 프로젝트에 도입할 때 거의 필수적으로 설정하는 npm-scripts 패턴이다. lint와 format을 모두 biome check 명령어로 통일하여 다룬다.

기본 설정

{
  "scripts": {
    "lint": "biome check .",
    "format": "biome check . --write"
  }
}

접두사로 그룹화

npm-scripts가 많은 프로젝트에서는 접두사로 그룹화하면 정리하기 쉽다.

{
  "scripts": {
    "code:lint": "biome check .",
    "code:format": "biome check . --write"
  }
}

명령어 차이점

명령어	동작
biome check .	문제를 감지하여 보고하고, 오류 시 종료 코드는 비영
biome check . —write	자동 수정 가능한 문제를 수정
biome format .	포맷팅만 실행
biome lint .	린트만 실행

check는 lint와 format을 모두 실행한다. CI에서는 check .를, 개발 시에는 —write를 사용하는 것이 일반적이다.

CI에서의 사용 예시

GitHub Actions에서의 설정 예시:

- name: Check code
  run: npm run lint

- name: Check formatting
  run: npx biome format . --check

또는 check —changed로 변경된 파일만 검증:

{
  "scripts": {
    "lint:changed": "biome check --changed ."
  }
}

이를 통해 차이만을 대상으로 하여 처리 시간을 단축할 수 있다.

설정 파일과의 관계

biome.json에서 상세한 설정을 수행:

{
  "formatter": {
    "indentStyle": "space",
    "indentWidth": 2
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}

npm-scripts는 엔트리 포인트로서 간단하게 유지하고, 상세한 설정은 설정 파일에 위임하는 것이 좋다.