Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions src/content/docs/ja/guides/editors/create-an-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,82 @@ Biomeは新しい出力(変更がない場合は元の出力)を[標準出

バイナリ名は `biome` または `biome.exe` で、ライブラリのルートディレクトリに配置されています。例:`@biomejs/cli-darwin-arm64/biome`、`@biomejs/cli-win32-x64/biome.exe`

### 拡張機能の設定

Biomeの言語サーバは以下の設定を公開しており、拡張機能はこれらをユーザーに公開できます。

:::note
以下の設定は**拡張機能開発者向け**であり、ユーザー向けではありません。
拡張機能は、異なる名前や異なる形式で設定をユーザーに公開することができます。

例えば、Zed拡張機能は[`require_configuration`](#require-configuration)設定を、JSONCファイルで定義される`require_config_file`設定としてマッピングしています。
:::

#### `require_configuration`

> 型: `boolean`
> デフォルト: `false`

Biomeの言語サーバが設定ファイルを必要とするかどうか。`true`に設定すると、プロジェクトのルートに`biome.json`ファイルがあるまで、(パース以外の)ファイルの解析を行いません。

```json
{
"require_configuration": true
}
```

#### `configuration_path`

> 型: `string`
> デフォルト: `null`

カスタム設定ファイルへのパス。パスは `biome.json` / `biome.jsonc` があるフォルダ、またはファイルへのパスを指定できます。

パスは相対パスまたは絶対パスで指定できます。Biomeの言語サーバは、この設定が指定された場合にのみ読み取ります。設定が *プロジェクトのサブフォルダにある* 場合にこの設定を使用してください。

```json
{
"configuration_path": "./frontend/biome.json"
}
```

#### `inline_config`

> 型: `object`
> デフォルト: `null`

Biome設定のインラインバージョン。この設定のオプションは、ディスクから読み取られた `biome.json` ファイル(またはデフォルト値)のオプションを上書きします。

例えば、プロジェクトで `noConsole` ルールを `error` の重大度で有効にしているとします:

```json title="biome.json"
{
"linter": {
"rules": {
"suspicious": {
"noConsole": "error"
}
}
}
}
```

しかし、ローカル開発中は、このルールが便利で赤い波線を見たくないため、このルールを無効にしたいとします。`inline_config`には、次のように記述します:

```json
{
"inline_config": {
"linter": {
"rules": {
"suspicious": {
"noConsole": "off"
}
}
}
}
}
```

### バイナリとデーモンを使用する

CLIを介してバイナリを使用するのは非常に効率的ですが、[ログ](#デーモンログ)をユーザーに提供することはできません。CLIを使用するとデーモンを起動し、デーモン経由でCLIコマンドを使用できます。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Biome IntelliJプラグインをインストールするには、[公式プラ
**ディスクから:**

1. バージョンタブから拡張機能の .zipをダウンロードします。
2. `⌘Cmd,`を押してIDE設定を開き、プラグインを選択します。
2. <kbd title="Cmd">⌘</kbd>+<kbd title="Comma">,</kbd>(macOS)または <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>S</kbd>(Windows/Linux)を押してIDE設定を開き、プラグインを選択します。
3. 拡張機能ページで設定ボタンをクリックし、"ディスクからプラグインをインストール ..."を選択します。

### Zed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ description: サードパーティの拡張機能の設定方法
- [`coc-biome`](https://github.com/fannheyward/coc-biome): [`coc.nvim`](https://github.com/neoclide/coc.nvim) 用のBiome拡張機能。
- [`sublime text`](https://www.sublimetext.com/): [`LSP-biome`](https://github.com/sublimelsp/LSP-biome) のインストール手順に従ってください。
- [`Emacs`](https://www.gnu.org/software/emacs/): [`lsp-mode`](https://github.com/emacs-lsp/lsp-mode) をインストールし、[`lsp-biome`](https://github.com/cxa/lsp-biome) のインストール手順に従って `lsp-mode` でBiomeサポートを有効にします。
- [`Nova`](https://nova.app): [`Biome`](https://extensions.panic.com/extensions/besya/besya.biome/) 拡張機能をインストールし、指示に従ってください。

:::note
ここに記載されていないエディタ用の拡張機能がありますか?ぜひPRを送ってください。リストに追加します。
Expand Down
191 changes: 139 additions & 52 deletions src/content/docs/ja/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,95 +3,182 @@ title: はじめる
description: Biomeと共に新しいプロジェクトを立ち上げる方法
---

import DefaultConfiguration from "@/components/generated/DefaultConfiguration.mdx";
import { Code, TabItem, Tabs } from "@astrojs/starlight/components";
import PackageManagerBiomeCommand from "@/components/PackageManagerBiomeCommand.astro";
import PackageManagerCommand from "@/components/PackageManagerCommand.astro";

## インストール方法
Biomeはプロジェクトの開発依存としてインストールするのが最適ですが、Node.jsを必要としない[スタンドアロン実行形式]としても利用可能です。

Biomeをインストールする最も速い方法は、 `npm` またはお好みのパッケージマネージャーを使用することです。
これにはNode.js v14.18以降が必要です。

Node.jsをインストールせずにBiomeを使用したい場合は、[スタンドアロン実行形式](/ja/guides/manual-installation)としてCLIを利用できます。

Biomeをインストールするには、 `package.json` ファイルが含まれるディレクトリで次のコマンドを実行します。
[スタンドアロン実行形式]: /ja/guides/manual-installation

<PackageManagerCommand
npm="install --save-dev --save-exact @biomejs/biome"
pnpm="add --save-dev --save-exact @biomejs/biome"
yarn="add --dev --exact @biomejs/biome"
bun="add --dev --exact @biomejs/biome"
deno="add --dev npm:@biomejs/biome"
npm="i -D -E @biomejs/biome"
pnpm="add -D -E @biomejs/biome"
yarn="add -D -E @biomejs/biome"
bun="add -D -E @biomejs/biome"
deno="add -D npm:@biomejs/biome"
/>

:::note
Biomeの正確なバージョンを固定するように、パッケージマネージャへ指示しています。
これにより、プロジェクトに関わる全員が全く同じバージョンのBiomeを利用することを保証します。
パッチリリースであっても、わずかに異なる動作を起こすことがあります。
詳しくは、[バージョニング ページ](/ja/internals/versioning/)をご覧ください。
:::note[バージョンの固定]
`-E` はパッケージマネージャがBiomeのバージョンを固定することを保証します。
[バージョンの固定が重要な理由]についての詳細は、[バージョニングのページ](/ja/internals/versioning)をご覧ください。
:::

## 設定
[バージョンの固定が重要な理由]: /ja/internals/versioning#バージョンの固定が重要な理由

プロジェクトごとに `biome.json` または `biome.jsonc`(設定ファイル)を作成することを推奨します。
これにより、コマンドを実行するたびにCLIのオプションを繰り返し指定する必要がなくなり、エディタ上で同じ設定を適用できるようになります。
もしBiomeのデフォルト設定に満足している場合は、新たに設定ファイルを作成する必要はありません。
## 設定

`biome.json` ファイルを作成するには、プロジェクトのルートディレクトリで `init` コマンドを実行します:
Biomeは設定なしでも動作しますが、プロジェクトのニーズに合わせていくつかの設定を調整したい場合は、次のコマンドを実行して `biome.json` 設定ファイルを生成できます。

<PackageManagerBiomeCommand command="init"/>

`--jsonc` オプションを渡すことで、 `biome.jsonc` ファイルを代わりに生成します。
## 使い方

`init` コマンドを実行すると、そのディレクトリに `biome.json` ファイルが新規作成されます:
プロジェクトでBiomeを使用する方法の概要を説明します。

<DefaultConfiguration/>
### コマンドラインインターフェース

`linter.enabled: true` はリンタを有効にし、 `rules.recommended: true` は[推奨ルール](/linter/rules/)を有効にします。
これはデフォルトの設定と対応しています。
Biomeは、コードのフォーマット、リント、チェックを行うための[コマンドラインインターフェース]を提供します。

この設定では、`formatter.enabled: false` で明示的にフォーマットを[無効化](/ja/reference/configuration/#formatterenabled)していないため、フォーマットは有効になっています。
[コマンドラインインターフェース]: /reference/cli

## 使い方
{/* <!-- textlint-disable --> */}
<Tabs syncKey="command">
<TabItem label="npm" icon="seti:npm">
<Code frame="none" code={`
# すべてのファイルをフォーマット
npx @biomejs/biome format --write

# 特定のファイルをフォーマット
npx @biomejs/biome format --write <files>

# すべてのファイルをリントし、安全な修正を適用
npx @biomejs/biome lint --write

# 特定のファイルをリントし、安全な修正を適用
npx @biomejs/biome lint --write <files>

# すべてのファイルをフォーマット、リント、インポート整理
npx @biomejs/biome check --write

# 特定のファイルをフォーマット、リント、インポート整理
npx @biomejs/biome check --write <files>
`} lang="bash" />
</TabItem>
<TabItem label="pnpm" icon="pnpm">
<Code frame="none" code={`
# すべてのファイルをフォーマット
pnpm exec biome format --write

# 特定のファイルをフォーマット
pnpm exec biome format --write <files>

# すべてのファイルをリントし、安全な修正を適用
pnpm exec biome lint --write

# 特定のファイルをリントし、安全な修正を適用
pnpm exec biome lint --write <files>

# すべてのファイルをフォーマット、リント、インポート整理
pnpm exec biome check --write

# 特定のファイルをフォーマット、リント、インポート整理
pnpm exec biome check --write <files>
`} lang="bash" />
</TabItem>
<TabItem label="bun" icon="bun">
<Code frame="none" code={`
# すべてのファイルをフォーマット
bunx biome format --write

# 特定のファイルをフォーマット
bunx biome format --write <files>

# すべてのファイルをリントし、安全な修正を適用
bunx biome lint --write

# 特定のファイルをリントし、安全な修正を適用
bunx biome lint --write <files>

# すべてのファイルをフォーマット、リント、インポート整理
bunx biome check --write

# 特定のファイルをフォーマット、リント、インポート整理
bunx biome check --write <files>
`} lang="bash" />
</TabItem>
<TabItem label="deno" icon="deno">
<Code frame="none" code={`
# 特定のファイルをフォーマット
deno run -A npm:@biomejs/biome format --write <files>

# すべてのファイルをフォーマット
deno run -A npm:@biomejs/biome format --write

# すべてのファイルをリントし、安全な修正を適用
deno run -A npm:@biomejs/biome lint --write

# 特定のファイルをリントし、安全な修正を適用
deno run -A npm:@biomejs/biome lint --write <files>

# すべてのファイルをフォーマット、リント、インポート整理
deno run -A npm:@biomejs/biome check --write

# 特定のファイルをフォーマット、リント、インポート整理
deno run -A npm:@biomejs/biome check --write <files>
`} lang="bash" />
</TabItem>
<TabItem label="yarn" icon="seti:yarn">
<Code frame="none" code={`
# すべてのファイルをフォーマット
yarn exec biome format --write

Biome CLIには多くのコマンドとオプションが用意されているので、あなたが必要なものだけを使用できます。
# 特定のファイルをフォーマット
yarn exec biome format --write <files>

[`format`](/reference/cli#biome-format) コマンドを `--write` オプションを指定し実行することで、ファイルやディレクトリをフォーマットできます。
# すべてのファイルをリントし、安全な修正を適用
yarn exec biome lint --write

<PackageManagerBiomeCommand command="format --write <files>"/>
# 特定のファイルをリントし、安全な修正を適用
yarn exec biome lint --write <files>

[`lint`](/reference/cli#biome-lint) コマンドを `--write` オプションを指定し実行することで、ファイルやディレクトリに対してLintを実行し、[安全な修正](/ja/linter#安全な修正safe-fixes)を適用できます。
# すべてのファイルをフォーマット、リント、インポート整理
yarn exec biome check --write

<PackageManagerBiomeCommand command="lint --write <files>"/>
# 特定のファイルをフォーマット、リント、インポート整理
yarn exec biome check --write <files>
`} lang="bash" />
</TabItem>
</Tabs>
{/* <!-- textlint-enable --> */}

[`check`](/reference/cli#biome-check) コマンドを実行することで、それら**両方**のコマンドを実行できます。
### エディタ統合

<PackageManagerBiomeCommand command="check --write <files>"/>
Biomeはお気に入りのエディタでファーストパーティの拡張機能として利用可能です。

`check` コマンドは複数のツールを一度に実行するためのコマンドです。現在は以下のことを行います。
- [VS Code](/ja/guides/editors/first-party-extensions#vs-code)
- [IntelliJ](/ja/guides/editors/first-party-extensions#intellij)
- [Zed](/ja/guides/editors/first-party-extensions#zed)

- ファイルのフォーマット
- ファイルのリント
- インポートの整理
**Vim**、**Neovim**、**Sublime Text**などの他のエディタ向けの[コミュニティ拡張機能](/ja/guides/editors/third-party-extensions)もあります。

## エディタプラグインのインストール
### 継続的インテグレーション

Biomeの機能を最大限活用するために、エディタプラグインをインストールすることを推奨しています。[エディタのページ](/ja/guides/editors/first-party-extensions)を参照して、どのエディタがBiomeをサポートしているかを確認してください
チーム全体でコード品質と一貫性を保つために、CIパイプラインの一部として `biome ci` を実行します。これは `biome check` コマンドと同様に動作しますが、CI環境向けに最適化されています

## CIのセットアップ
- [GitHub Actions](/ja/recipes/continuous-integration#github-actions)
- [GitLab CI](/ja/recipes/continuous-integration#gitlab-ci)

Node.jsを使用している場合、BiomeをCIで実行するには、[お気に入りのパッケージマネージャ](/ja/guides/getting-started#インストール方法)を使用することが推奨されます。
このようにすることで、CIパイプラインがエディタ上やローカルでCLIコマンドを実行するときと同じバージョンのBiomeを使用することを保証できます。
代わりに、専用の[CIアクション](/recipes/continuous-integration)を利用することもできます。
その他の例については、[継続的インテグレーション](/ja/recipes/continuous-integration)のレシピをご覧ください。

## 次のステップ

成功です!これでBiomeを使う準備が整いました。🥳

- [ESLintとPrettierと移行する](/guides/migrate-eslint-prettier)
- [Biomeの設定](/guides/configure-biome)について詳しく知る
- [Formatter](/ja/formatter)の使い方と設定方法について詳しく知る
- [Linter](/ja/linter)の使い方と設定方法について詳しく知る
- [CLIオプション](/reference/cli)を使いこなす
- [ESLintとPrettierから移行する](/ja/guides/migrate-eslint-prettier)
- [Biomeの設定方法](/ja/guides/configure-biome)について詳しく知る
- [フォーマッタ](/ja/formatter)の使い方と設定方法について詳しく知る
- [リンタ](/ja/linter)の使い方と設定方法について詳しく知る
- [CLIコマンドとオプション](/reference/cli)を使いこなす
- [設定オプション](/ja/reference/configuration)を使いこなす
- [Discordのコミュニティ](https://biomejs.dev/chat)に参加する
3 changes: 1 addition & 2 deletions src/content/docs/ja/guides/integrate-in-vcs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ VCS (バージョン管理システム)の統合は、**追加の**機能を

### 無視するファイルを設定する

`vcs.useIgnoreFile` を有効にすることで、VCSのignoreファイルに列挙されたすべてのファイルとディレクトリをBiomeが無視するようになります。
現時点では、**作業ディレクトリのignoreファイルのみを取り込みます**。
`vcs.useIgnoreFile` を有効にすることで、プロジェクトにあるVCSのignoreファイルと `.ignore` ファイルに列挙されたすべてのファイルとディレクトリをBiomeが無視するようになります。

```json title="biome.json" ins={5}
{
Expand Down
Loading
Loading