chore: update setup

This commit is contained in:
Kevin Franklin Kim 2024-04-27 19:58:26 +02:00
parent 981b697e0f
commit c5616dfedf
No known key found for this signature in database
9 changed files with 393 additions and 163 deletions

15
.editorconfig Normal file
View File

@ -0,0 +1,15 @@
# EditorConfig is awesome: https://EditorConfig.org
# top-most EditorConfig file
root = true
[*]
charset = utf-8
indent_size = 2
indent_style = tab
insert_final_newline = true
trim_trailing_whitespace = true
end_of_line = lf
[*.{yaml,yml,md,hcl}]
indent_style = space

37
.github/workflows/pr.yml vendored Normal file
View File

@ -0,0 +1,37 @@
name: checks
on:
push:
branches: [ master ]
pull_request:
merge_group:
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: 'go.mod'
- uses: gotesttools/gotestfmt-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: golangci/golangci-lint-action@v4
with:
version: latest
- name: Run tests
run: make test
- uses: coverallsapp/github-action@v2
with:
file: coverage.out

View File

@ -1,37 +0,0 @@
name: goreleaser
on:
push:
tags:
- v*.*.*
jobs:
goreleaser:
runs-on: ubuntu-latest
env:
GOFLAGS: -mod=readonly
GOPROXY: https://proxy.golang.org
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Unshallow
run: git fetch --prune --unshallow
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.16
# TODO enable
#- name: golangci-lint
# uses: golangci/golangci-lint-action@v2
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v2
with:
distribution: goreleaser
version: latest
args: release --rm-dist
env:
GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}

37
.github/workflows/tag.yml vendored Normal file
View File

@ -0,0 +1,37 @@
name: Release Tag
on:
push:
tags:
- v*.*.*
workflow_dispatch:
permissions:
contents: write
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Unshallow
run: git fetch --prune --unshallow
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
- id: app_token
uses: tibdex/github-app-token@v2
with:
app_id: ${{ secrets.TOKEN_APP_ID }}
private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
- uses: goreleaser/goreleaser-action@v5
with:
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ steps.app_token.outputs.token }}

30
.gitignore vendored
View File

@ -1,20 +1,12 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
# Test binary, built with `go test -c`
*.test
# Output of the go coverage tool, specifically when used with LiteIDE
.*
*.log
*.out
bin
.history*
*.idea
/.vscode/*
/untracked_*.go
cover.html
cover.out
!.github/
!.husky/
!.editorconfig
!.gitignore
!.golangci.yml
!.goreleaser.yml
!.husky.yaml
/bin/
/tmp/

View File

@ -1,85 +1,237 @@
run:
timeout: 5m
issues:
exclude-dirs:
- 'bin'
- 'tmp'
- 'vendor'
exclude-rules:
- path: _test\.go
linters:
- forcetypeassert
- gocheckcompilerdirectives
linters-settings:
gci:
local-prefixes: github.com/foomo/gocontentful
golint:
min-confidence: 0
goimports:
local-prefixes: github.com/foomo/gocontentful
# https://golangci-lint.run/usage/linters/#misspell
misspell:
mode: restricted
# https://golangci-lint.run/usage/linters/#asasalint
asasalint:
ignore-test: true
# https://golangci-lint.run/usage/linters/#exhaustive
exhaustive:
default-signifies-exhaustive: true
# https://golangci-lint.run/usage/linters/#gocritic
gocritic:
enabled-tags:
- diagnostic
- style
disabled-tags:
- performance
- experimental
- opinionated
lll:
line-length: 150
disabled-checks:
- captLocal
- assignOp
- ifElseChain
- singleCaseSwitch
# https://golangci-lint.run/usage/linters/#testifylint
testifylint:
disable:
- float-compare
# https://golangci-lint.run/usage/linters/#gosec
gosec:
confidence: medium
excludes:
- G306
# https://golangci-lint.run/usage/linters/#revive
revive:
enable-all-rules: true
ignore-generated-header: true
rules:
- name: line-length-limit
disabled: true
#- name: if-return
# disabled: true
- name: bare-return
disabled: true
- name: deep-exit
disabled: true
- name: cognitive-complexity
disabled: true
- name: unused-parameter
disabled: true
- name: add-constant
disabled: true
- name: indent-error-flow
disabled: true
- name: cyclomatic
disabled: true
- name: function-length
disabled: true
- name: early-return
disabled: true
#- name: nested-structs
# disabled: true
#- name: var-naming
# disabled: true
- name: use-any
disabled: true
- name: max-public-structs
disabled: true
#- name: function-result-limit
# disabled: true
- name: flag-parameter
disabled: true
- name: unused-receiver
disabled: true
- name: argument-limit
disabled: true
- name: empty-lines
disabled: true
- name: confusing-naming
disabled: true
#- name: import-alias-naming
# disabled: true
- name: empty-block
disabled: true
#- name: import-shadowing
# disabled: true
- name: unhandled-error
arguments:
- "fmt.Printf"
- "fmt.Println"
#- name: max-control-nesting
# disabled: true
- name: exported
disabled: true
- name: unchecked-type-assertion
disabled: true
- name: unnecessary-stmt
disabled: true
#- name: get-return
# disabled: true
#- name: context-keys-type
# disabled: true
#- name: comment-spacings
# disabled: true
#- name: struct-tag
# disabled: true
#- name: confusing-results
# disabled: true
- name: superfluous-else
disabled: true
- name: unexported-return
disabled: true
#- name: error-return
# disabled: true
#- name: redefines-builtin-id
# disabled: true
- name: unexported-naming
disabled: true
linters:
disable-all: true
enable:
- bodyclose
- deadcode
- dogsled
- dupl
- exhaustive
- exportloopref
- gci
- goconst
- gofmt
- gofumpt
- goimports
- revive
- goprintffuncname
- govet
- ineffassign
- misspell
- nakedret
- noctx
- nolintlint
- prealloc
- rowserrcheck
- sqlclosecheck
- staticcheck
- structcheck
- stylecheck
- typecheck
- unconvert
- unparam
- unused
- varcheck
- whitespace
- errcheck
- gocritic
- gosimple
# Enabled by default linters:
- errcheck # errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false]
- gosimple # (megacheck) Linter for Go source code that specializes in simplifying code [fast: false, auto-fix: false]
- govet # (vet, vetshadow) Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [fast: false, auto-fix: false]
- ineffassign # Detects when assignments to existing variables are not used [fast: true, auto-fix: false]
- staticcheck # (megacheck) It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [fast: false, auto-fix: false]
- unused # (megacheck) Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]
- gocyclo
- gosec
- lll
- exportloopref
# unused
# - godot
# - gocognit
# - nlreturn
# - gochecknoglobals
# - gochecknoinits
# - depguard
# - goheader
# - gomodguard
# don't enable:
# - asciicheck
# - funlen
# - godox
# - goerr113
# - gomnd
# - interfacer
# - maligned
# - nestif
# - testpackage
# - wsl
# Disabled by your configuration linters:
- asasalint # check for pass []any as any in variadic func(...any) [fast: false, auto-fix: false]
- asciicheck # checks that all code identifiers does not have non-ASCII symbols in the name [fast: true, auto-fix: false]
- bidichk # Checks for dangerous unicode character sequences [fast: true, auto-fix: false]
- bodyclose # checks whether HTTP response body is closed successfully [fast: false, auto-fix: false]
#- containedctx # containedctx is a linter that detects struct contained context.Context field [fast: false, auto-fix: false]
- contextcheck # check whether the function uses a non-inherited context [fast: false, auto-fix: false]
#- copyloopvar # (go >= 1.22) copyloopvar is a linter detects places where loop variables are copied [fast: true, auto-fix: false]
#- cyclop # checks function and package cyclomatic complexity [fast: false, auto-fix: false]
- decorder # check declaration order and count of types, constants, variables and functions [fast: true, auto-fix: false]
#- depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false]
#- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false]
#- dupl # Tool for code clone detection [fast: true, auto-fix: false]
#- dupword # checks for duplicate words in the source code [fast: true, auto-fix: false]
- durationcheck # check for two durations multiplied together [fast: false, auto-fix: false]
- errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and reports occations, where the check for the returned error can be omitted. [fast: false, auto-fix: false]
#- errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`. [fast: false, auto-fix: false]
#- errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false]
- execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds [fast: false, auto-fix: false]
#- exhaustive # check exhaustiveness of enum switch statements [fast: false, auto-fix: false]
#- exhaustruct # Checks if all structure fields are initialized [fast: false, auto-fix: false]
- exportloopref # checks for pointers to enclosing loop variables [fast: false, auto-fix: false]
#- forbidigo # Forbids identifiers [fast: false, auto-fix: false]
#- forcetypeassert # finds forced type assertions [fast: true, auto-fix: false]
#- funlen # Tool for detection of long functions [fast: true, auto-fix: false]
#- gci # Gci controls Go package import order and makes it always deterministic. [fast: true, auto-fix: true]
#- ginkgolinter # enforces standards of using ginkgo and gomega [fast: false, auto-fix: false]
- gocheckcompilerdirectives # Checks that go compiler directive comments (//go:) are valid. [fast: true, auto-fix: false]
#- gochecknoglobals # Check that no global variables exist. [fast: false, auto-fix: false]
#- gochecknoinits # Checks that no init functions are present in Go code [fast: true, auto-fix: false]
- gochecksumtype # Run exhaustiveness checks on Go "sum types" [fast: false, auto-fix: false]
#- gocognit # Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false]
#- goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false]
- gocritic # Provides diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: true]
#- gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false]
#- godot # Check if comments end in a period [fast: true, auto-fix: true]
#- godox # Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false]
#- goerr113 # Go linter to check the errors handling expressions [fast: false, auto-fix: false]
- gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true]
#- gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true]
- goheader # Checks is file header matches to pattern [fast: true, auto-fix: true]
- goimports # Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode. [fast: true, auto-fix: true]
#- gomnd # An analyzer to detect magic numbers. [fast: true, auto-fix: false]
- gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false]
- gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false]
- goprintffuncname # Checks that printf-like functions are named with `f` at the end. [fast: true, auto-fix: false]
- gosec # (gas) Inspects source code for security problems [fast: false, auto-fix: false]
#- gosmopolitan # Report certain i18n/l10n anti-patterns in your Go codebase [fast: false, auto-fix: false]
- grouper # Analyze expression groups. [fast: true, auto-fix: false]
- importas # Enforces consistent import aliases [fast: false, auto-fix: false]
#- inamedparam # reports interfaces with unnamed method parameters [fast: true, auto-fix: false]
#- interfacebloat # A linter that checks the number of methods inside an interface. [fast: true, auto-fix: false]
#- intrange # (go >= 1.22) intrange is a linter to find places where for loops could make use of an integer range. [fast: true, auto-fix: false]
#- ireturn # Accept Interfaces, Return Concrete Types [fast: false, auto-fix: false]
#- lll # Reports long lines [fast: true, auto-fix: false]
#- loggercheck # (logrlint) Checks key value pairs for common logger libraries (kitlog,klog,logr,zap). [fast: false, auto-fix: false]
#- maintidx # maintidx measures the maintainability index of each function. [fast: true, auto-fix: false]
- makezero # Finds slice declarations with non-zero initial length [fast: false, auto-fix: false]
- misspell # Finds commonly misspelled English words [fast: true, auto-fix: true]
- mirror # reports wrong mirror patterns of bytes/strings usage [fast: false, auto-fix: true]
- musttag # enforce field tags in (un)marshaled structs [fast: false, auto-fix: false]
#- nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero). [fast: true, auto-fix: false]
#- nestif # Reports deeply nested if statements [fast: true, auto-fix: false]
- nilerr # Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false]
- nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value. [fast: false, auto-fix: false]
#- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false]
- noctx # Finds sending http request without context.Context [fast: false, auto-fix: false]
- nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: true]
#- nonamedreturns # Reports all named returns [fast: false, auto-fix: false]
- nosprintfhostport # Checks for misuse of Sprintf to construct a host with port in a URL. [fast: true, auto-fix: false]
#- paralleltest # Detects missing usage of t.Parallel() method in your Go test [fast: false, auto-fix: false]
#- perfsprint # Checks that fmt.Sprintf can be replaced with a faster alternative. [fast: false, auto-fix: false]
#- prealloc # Finds slice declarations that could potentially be pre-allocated [fast: true, auto-fix: false]
- predeclared # find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false]
- promlinter # Check Prometheus metrics naming via promlint [fast: true, auto-fix: false]
#- protogetter # Reports direct reads from proto message fields when getters should be used [fast: false, auto-fix: true]
- reassign # Checks that package variables are not reassigned [fast: false, auto-fix: false]
- revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false]
#- rowserrcheck # checks whether Rows.Err of rows is checked successfully [fast: false, auto-fix: false]
#- sloglint # ensure consistent code style when using log/slog [fast: false, auto-fix: false]
#- spancheck # Checks for mistakes with OpenTelemetry/Census spans. [fast: false, auto-fix: false]
#- sqlclosecheck # Checks that sql.Rows, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed. [fast: false, auto-fix: false]
- stylecheck # Stylecheck is a replacement for golint [fast: false, auto-fix: false]
#- tagalign # check that struct tags are well aligned [fast: true, auto-fix: true]
#- tagliatelle # Checks the struct tags. [fast: true, auto-fix: false]
- tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [fast: false, auto-fix: false]
#- testableexamples # linter checks if examples are testable (have an expected output) [fast: true, auto-fix: false]
#- testifylint # Checks usage of github.com/stretchr/testify. [fast: false, auto-fix: false]
#- testpackage # linter that makes you use a separate _test package [fast: true, auto-fix: false]
- thelper # thelper detects tests helpers which is not start with t.Helper() method. [fast: false, auto-fix: false]
#- tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes. [fast: false, auto-fix: false]
- unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false]
#- unparam # Reports unused function parameters [fast: false, auto-fix: false]
- usestdlibvars # A linter that detect the possibility to use variables/constants from the Go standard library. [fast: true, auto-fix: false]
#- varnamelen # checks that the length of a variable's name matches its scope [fast: false, auto-fix: false]
- wastedassign # Finds wasted assignment statements [fast: false, auto-fix: false]
#- whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc. [fast: true, auto-fix: true]
#- wrapcheck # Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false]
#- wsl # add or remove empty lines [fast: true, auto-fix: false]
#- zerologlint # Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg` [fast: false, auto-fix: false]

View File

@ -1,12 +1,13 @@
# .goreleaser.yml
# Build customization
project_name: gocontentful
release:
github:
owner: foomo
name: gocontentful
prerelease: auto
builds:
- binary: gocontentful
main: ./main.go
env:
- CGO_ENABLED=0
ldflags:
- -s -w -X main.VERSION={{.Version}}
goos:
- windows
- darwin
@ -14,22 +15,34 @@ builds:
goarch:
- amd64
- arm64
ignore:
- goos: windows
goarch: arm64
goarm:
- '7'
env:
- CGO_ENABLED=0
main: ./main.go
flags:
- -trimpath
ldflags:
- -s -w -X main.VERSION={{.Version}}
# .goreleaser.yml
archives:
- format: tar.gz
format_overrides:
- goos: windows
format: zip
files:
- LICENSE
- README.md
changelog:
use: github-native
brews:
# Reporitory to push the tap to.
- tap:
- repository:
owner: foomo
name: homebrew-gocontentful
name: homebrew-tap
caveats: "gocontentful -h"
homepage: "https://github.com/foomo/gocontentful"
description: "An Contentful Entry-Reference Mapper for Go"
test: |
system "#{bin}/gocontentful --version"

View File

@ -1,43 +1,64 @@
.DEFAULT_GOAL:=help
-include .makerc
# --- Targets -----------------------------------------------------------------
# This allows us to accept extra arguments
%:
@:
## === Tasks ===
.PHONY: doc
## Run tests
doc:
@open "http://localhost:6060/pkg/github.com/foomo/contentful/"
@godoc -http=localhost:6060 -play
.PHONY: install
## Install binary
install:
go build -o ${GOPATH}/bin/gocontenful main.go
go build -o ${GOPATH}/bin/gocontentful main.go
.PHONY: build
## Build binary
build:
mkdir -p bin
go build -o bin/gocontenful main.go
@mkdir -p bin
@go build -o bin/gocontenful main.go
.PHONY: test
## Run tests
test:
go run ./main.go -exportfile ./test/test-space-export.json ./test/testapi
go test -count=1 ./...
test: testapi
@go test -p 1 -coverprofile=coverage.out -race -json ./... | gotestfmt
race:
go run ./main.go -exportfile ./test/test-space-export.json ./test/testapi
go test -race -count=1 ./...
.PHONY: test
## Run tests
testapi:
@go run ./main.go -exportfile ./test/test-space-export.json ./test/testapi
cover:
rm cover.out cover.html
go run ./main.go -exportfile ./test/test-space-export.json ./test/testapi
go test -cover -coverprofile cover.out -coverpkg=./test/testapi ./...
go tool cover -html=cover.out -o cover.html; open cover.html
## Test & view coverage
cover: test
@go tool cover -html=coverage.out -o coverage.html; open coverage.html
.PHONY: lint
## Run linter
lint:
golangci-lint run
lint: testapi
@golangci-lint run
.PHONY: lint.fix
## Fix lint violations
lint.fix:
golangci-lint run --fix
@golangci-lint run --fix
.PHONY: tidy
## Run go mod tidy
tidy:
@go mod tidy
.PHONY: outdated
## Show outdated direct dependencies
outdated:
@go list -u -m -json all | go-mod-outdated -update -direct
## === Utils ===