콘텐츠로 이동

처음 시작하기

Biome를 가장 빠르게 다운로드하는 방법은 npm과 같은 패키지 매니저를 사용하는 것입니다.
이 작업에는 Node.js v14.18 이상이 필요합니다.
Node.js를 설치하지 않고도 사용할 수 있도록, CLI는 독립 실행형 실행 파일 형태로도 제공됩니다.

프로젝트 폴더에 package.json 파일이 포함된 디렉터리에서 다음 명령어를 실행하여 Biome를 설치하세요.

npm install --save-dev --save-exact @biomejs/biome

각 프로젝트마다 biome.json 또는 biome.jsonc 설정 파일을 생성하는 것이 좋습니다.
이렇게 하면 커맨드라인 옵션을 반복해서 입력할 필요가 없으며, 에디터에서도 동일한 설정을 사용하게 됩니다.
일부 옵션은 설정 파일에서만 사용할 수 있습니다.
Biome의 기본 설정에 만족한다면, 별도의 설정 파일을 만들지 않아도 됩니다.
biome.json 파일을 생성하려면, 프로젝트 루트 폴더에서 init 명령어를 실행하세요:

npx @biomejs/biome init

--jsonc 옵션을 전달하면 대신 biome.jsonc 파일을 생성합니다.

init 명령어를 실행한 후, 프로젝트 디렉터리에 새로운 biome.json 파일이 생성됩니다:

biome.json
{
"$schema": "https://biomejs.dev/schemas/2.4.4/schema.json",
"vcs": {
"enabled": false,
"clientKind": "git",
"useIgnoreFile": false
},
"files": { "ignoreUnknown": false },
"formatter": { "enabled": true, "indentStyle": "tab" },
"linter": {
"enabled": true,
"rules": { "recommended": true }
},
"javascript": { "formatter": { "quoteStyle": "double" } },
"assist": {
"enabled": true,
"actions": { "source": { "organizeImports": "on" } }
}
}

linter.enabled: true는 린터를 활성화하고, rules.recommended: true권장 규칙을 활성화합니다.
이는 기본 설정과 일치합니다.

포맷팅은 기본적으로 활성화되어 있으며, formatter.enabled: false를 명시적으로 설정함으로써 비활성화할 수 있습니다.

Biome CLI는 필요한 기능만 사용할 수 있도록 다양한 명령어와 옵션을 제공합니다.

--write 옵션을 사용한 format 명령어로 파일과 디렉터리를 포맷팅할 수 있습니다:

npx @biomejs/biome format --write <files>

--write 옵션을 사용한 lint 명령어로 파일과 디렉터리에 대해 분석하고 안전한 수정을 적용할 수 있습니다:

npx @biomejs/biome lint --write <files>

둘 다 활용하려면 check 명령어를 사용하세요:

npx @biomejs/biome check --write <files>

check 명령어는 여러 도구를 동시에 실행합니다.
포맷팅, 오류 검사, 그리고 임포트 정렬을 수행합니다.

최대한의 효율을 위해 에디터 플러그인을 설치하는 것을 추천합니다.
지원되는 에디터 목록은 에디터 페이지를 확인하세요.

Node.js를 사용하는 경우, CI에서 Biome를 실행하는 가장 권장되는 방법은 선호하는 패키지 매니저를 사용하는 것입니다.
이는 편집기 내부에서 또는 로컬로 CLI 명령어를 실행할 때와 동일한 버전의 Biome를 사용하도록 보장합니다.
또는 특정 CI 작업을 사용할 수도 있습니다.

축하합니다! 이제 바로 Biome를 사용할 수 있습니다. 🥳