Rozpoczęcie pracy

Biome najlepiej zainstalować jako zależność deweloperską w swoich projektach, ale jest również dostępny jako samodzielny plik wykonywalny, który nie wymaga Node.js.

1
npm i -D -E @biomejs/biome

1
pnpm add -D -E @biomejs/biome

1
bun add -D -E @biomejs/biome

1
deno add -D npm:@biomejs/biome

1
yarn add -D -E @biomejs/biome

Konfiguracja

Chociaż Biome może działać bez konfiguracji, prawdopodobnie będziesz chciał dostosować niektóre ustawienia do potrzeb swojego projektu, w takim przypadku możesz uruchomić następującą komendę, aby wygenerować plik konfiguracyjny biome.json.

1
npx @biomejs/biome init

1
pnpm exec biome init

1
bunx --bun biome init

1
deno run -A npm:@biomejs/biome init

1
yarn exec biome init

Użycie

Przyjrzyjmy się szybkiemu przeglądowi, jak używać Biome w swoim projekcie.

Interfejs wiersza poleceń

Biome zapewnia interfejs wiersza poleceń do formatowania, lintowania i sprawdzania kodu.

1
# Formatuj wszystkie pliki
2
npx @biomejs/biome format --write
3

4
# Formatuj określone pliki
5
npx @biomejs/biome format --write <files>
6

7
# Lintuj pliki i zastosuj bezpieczne poprawki do wszystkich plików
8
npx @biomejs/biome lint --write
9

10
# Lintuj pliki i zastosuj bezpieczne poprawki do określonych plików
11
npx @biomejs/biome lint --write <files>
12

13
# Formatuj, lintuj i organizuj importy wszystkich plików
14
npx @biomejs/biome check --write
15

16
# Formatuj, lintuj i organizuj importy określonych plików
17
npx @biomejs/biome check --write <files>

1
# Formatuj wszystkie pliki
2
pnpm exec biome format --write
3

4
# Formatuj określone pliki
5
pnpm exec biome format --write <files>
6

7
# Lintuj i zastosuj bezpieczne poprawki do wszystkich plików
8
pnpm exec biome lint --write
9

10
# Lintuj pliki i zastosuj bezpieczne poprawki do określonych plików
11
pnpm exec biome lint --write <files>
12

13
# Formatuj, lintuj i organizuj importy wszystkich plików
14
pnpm exec biome check --write
15

16
# Formatuj, lintuj i organizuj importy określonych plików
17
pnpm exec biome check --write <files>

1
# Formatuj wszystkie pliki
2
bunx biome format --write
3

4
# Formatuj określone pliki
5
bunx biome format --write <files>
6

7
# Lintuj i zastosuj bezpieczne poprawki do wszystkich plików
8
bunx biome lint --write
9

10
# Lintuj pliki i zastosuj bezpieczne poprawki do określonych plików
11
bunx biome lint --write <files>
12

13
# Formatuj, lintuj i organizuj importy wszystkich plików
14
bunx biome check --write
15

16
# Formatuj, lintuj i organizuj importy określonych plików
17
bunx biome check --write <files>

1
# Formatuj określone pliki
2
deno run -A npm:@biomejs/biome format --write <files>
3

4
# Formatuj wszystkie pliki
5
deno run -A npm:@biomejs/biome format --write
6

7
# Lintuj pliki i zastosuj bezpieczne poprawki do wszystkich plików
8
deno run -A npm:@biomejs/biome lint --write
9

10
# Lintuj pliki i zastosuj bezpieczne poprawki do określonych plików
11
deno run -A npm:@biomejs/biome lint --write <files>
12

13
# Formatuj, lintuj i organizuj importy wszystkich plików
14
deno run -A npm:@biomejs/biome check --write
15

16
# Formatuj, lintuj i organizuj importy określonych plików
17
deno run -A npm:@biomejs/biome check --write <files>

1
# Formatuj wszystkie pliki
2
yarn exec biome format --write
3

4
# Formatuj określone pliki
5
yarn exec biome format --write <files>
6

7
# Lintuj pliki i zastosuj bezpieczne poprawki do wszystkich plików
8
yarn exec biome lint --write
9

10
# Lintuj pliki i zastosuj bezpieczne poprawki do określonych plików
11
yarn exec biome lint --write <files>
12

13
# Formatuj, lintuj i organizuj importy wszystkich plików
14
yarn exec biome check --write
15

16
# Formatuj, lintuj i organizuj importy określonych plików
17
yarn exec biome check --write <files>

Integracje z edytorami

Biome jest dostępny jako oficjalne rozszerzenie w Twoich ulubionych edytorach.

Dostępne są również rozszerzenia społeczności dla innych edytorów, takich jak Vim, Neovim i Sublime Text, żeby wymienić tylko kilka.

Ciągła integracja

Uruchom biome ci jako część swojego pipeline CI, aby wymuszać jakość kodu i spójność w całym zespole. Działa tak samo jak polecenie biome check, ale jest zoptymalizowane dla środowisk CI.

Zobacz przepisy Ciągła integracja po więcej przykładów.

Następne kroki

Sukces! Jesteś teraz gotowy do używania Biome. 🥳

Migruj z ESLint i Prettier
Dowiedz się więcej o tym, jak skonfigurować Biome
Dowiedz się więcej o tym, jak używać i konfigurować formater
Dowiedz się więcej o tym, jak używać i konfigurować linter
Zapoznaj się z poleceniami i opcjami CLI
Zapoznaj się z opcjami konfiguracji
Dołącz do naszej społeczności na Discordzie