diff --git a/.golangci.yml b/.golangci.yml index 10f6733..c097b9e 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -7,6 +7,14 @@ linters-settings: disabled-checks: - singleCaseSwitch +issues: + exclude-rules: + - path: '(.+)_test\.go' + linters: + - gocognit + - gocyclo + - dupl + linters: enable: - asciicheck diff --git a/hack/pre-commit.sh b/hack/pre-commit.sh new file mode 100755 index 0000000..6d91a07 --- /dev/null +++ b/hack/pre-commit.sh @@ -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