Skip to content

feat(git hooks): introduce husky #1018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbrand merged 1 commit into from
Apr 22, 2025
Merged

feat(git hooks): introduce husky #1018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ If there is any impact on existing users (compatibility, degradation, breaking c

## Checklist

- [ ] Executed `npm run lint`
- [ ] Modified relevant documentation
- [ ] Verified operation in local environment
- [ ] Executed `npm run cdk:test` and if there are snapshot differences, execute `npm run cdk:test:update-snapshot` to update snapshots
Expand Down
1 change: 1 addition & 0 deletions .husky/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx lint-staged
16 changes: 14 additions & 2 deletions docs/en/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,22 @@ If executed successfully, it will start at http://localhost:5173, so please try

## When Submitting a Pull Request

We welcome Pull Requests for bug fixes and feature improvements. Before committing, please run the lint tool:
We welcome Pull Requests for bug fixes and feature improvements :tada:

When `git commit` is executed, `npm run lint` is executed. But if it fails, the commit causes an error like the following:

```bash
⚠ Running tasks for staged files...
❯ package.json — 1 file
❯ **/* — 1 file
✖ sh -c 'npm run lint' [FAILED]
...
```

If you want to ignore this error and create a Draft PR, add the `--no-verify` option as shown below.

```bash
npm run lint
git commit -m "xxx" --no-verify
```

Also, if there are changes to the CDK, check the snapshots with the following command and update them:
Expand Down
18 changes: 15 additions & 3 deletions docs/ja/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,25 @@ npm run web:dev

## Pull Request を出す場合

バグ修正や機能改善などの Pull Request は歓迎しております。コミットする前に、lint ツールを実行してください。
バグ修正や機能改善などの Pull Request は歓迎しております :tada:

`git commit`が実行された際、`npm run lint`が実行されます。しかし、失敗すると、以下のようなエラーが発生します。

```bash
⚠ Running tasks for staged files...
❯ package.json — 1 file
❯ **/* — 1 file
✖ sh -c 'npm run lint' [FAILED]
...
```

もし、このエラーを無視してDraft PR を作成したい場合は、以下のように `--no-verify` オプションを付けてください。

```bash
npm run lint
git commit -m "xxx" --no-verify
```

また、CDK に変更があれば以下のコマンドでスナップショットの確認を行いスナップショットを更新してください。
もしCDK に変更があれば以下のコマンドでスナップショットの確認を行いスナップショットを更新してください。

```bash
# 差分を確認
Expand Down
Loading