Skip to content
Open
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
25 changes: 25 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,30 @@ export default defineConfig({
],
},
},
jp: {
label: "日本語",
lang: "ja-JP",
description: "Git フックを簡単に",
link: "/jp/",
themeConfig: {
sidebar: [
{ text: "はじめに", link: "/jp/" },
{ text: "始めましょう", link: "/jp/get-started" },
{ text: "方法", link: "/jp/how-to" },
{ text: "トラブルシュート", link: "/jp/troubleshoot" },
{ text: "v4からの移行", link: "/jp/migrate-from-v4" },
],
docFooter: {
prev: "前のページ",
next: "次のページ",
},
outline: {
label: "ページナビゲーション",
},
nav: [
{ text: "スポンサー", link: "https://github.com/sponsors/typicode" },
],
},
},
},
});
80 changes: 80 additions & 0 deletions docs/jp/get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# 始めましょう

## インストール

::: code-group

```shell [npm]
npm install --save-dev husky
```

```shell [pnpm]
pnpm add --save-dev husky
```

```shell [yarn]
yarn add --dev husky
# パッケージが private でない場合のみ、 pinst を追加してください
yarn add --dev pinst
```

```shell [bun]
bun add --dev husky
```

:::

## `husky init` (推奨)

`init` コマンドは、プロジェクトでの husky のセットアップを簡単にします。 `.husky/` に `pre-commit` スクリプトを作成し、 `package.json` の `prepare` スクリプトを更新します。ワークフローに合わせて後で修正することもできます。

::: code-group

```shell [npm]
npx husky init
```

```shell [pnpm]
pnpm exec husky init
```

```shell [yarn]
# 特定の注意事項や他のパッケージ・マネージャーとの違いがあるため、
# 方法セクションを参照してください
```

```shell [bun]
bunx husky init
```

:::


## 試してみる

おめでとうございます! たったひとつのコマンドで、最初の Git フックを設定することができました🎉。テストしてみましょう:

```shell
git commit -m "Keep calm and commit"
# コミットする度にテストスクリプトが実行されます
```

## ひと言...

### スクリプティング

ほとんどの場合、 `npm run` または `npx` コマンドをフックで実行するだけですが、 POSIX Shell を使ってスクリプト化し、カスタムワークフローを作成することもできます。

例えば、たった2行の Shell コードと外部依存なしで、コミット毎にステージファイルを lint する方法はこちらです:

```shell
# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again
```

_これは基本的な、しかし実用的な例です。更に必要であれば、 [lint-staged](https://github.com/lint-staged/lint-staged) をチェックしてください。_

### フックを無効にする

Husky は Git フックを強制しません。必要に応じて、グローバルに無効にすること(`HUSKY=0`)やオプトインすることもできます。手動での設定や詳細については、[方法](./how-to.md)セクションを参照してください。
Loading