Skip to content
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.

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

chore: Add pre-commit hook script #94

Merged
merged 1 commit into from
Jul 7, 2022
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
8 changes: 8 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ linters-settings:
disabled-checks:
- singleCaseSwitch

issues:
exclude-rules:
- path: '(.+)_test\.go'
linters:
- gocognit
- gocyclo
- dupl

linters:
enable:
- asciicheck
Expand Down
32 changes: 32 additions & 0 deletions hack/pre-commit.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env bash

#
# Copyright 2022 The Furiko Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

set -euo pipefail

## Sample pre-commit Git hook that will format, lint and test changes.
## Reduce back-and-forth from fixing CI errors by running the CI locally.
##
## To enable this, run the following:
## ln -s `pwd`/hack/pre-commit.sh .git/hooks/pre-commit

# Format the repo.
make fmt

# Run preflight checks.
make lint
make test