Initial commit

.github/workflows/build.yaml

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2023 Steffen Vogel <[email protected]>
+# SPDX-License-Identifier: Apache-2.0
+
+# yaml-language-server: $schema=https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/github-workflow.json
+---
+name: Build
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  build:
+    name: Build
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macOS-latest, windows-latest ]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Go
+      uses: actions/setup-go@v4
+      with:
+        go-version-file: go.mod
+        check-latest: true
+
+    - name: Lint
+      # TODO: golangci-lint v1.54 is currently broken on Windows?
+      if: matrix.os != 'windows-latest'
+      uses: golangci/golangci-lint-action@v3
+      with:
+        version: v1.54.0
+
+    - name: Set up gotestfmt
+      run: go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+
+    - name: Run Go tests
+      shell: bash
+      run: |
+        set -euo pipefail
+        go test \
+          -v \
+          -json \
+          -coverpkg ./... \
+          -tags ci \
+          -coverprofile cover.profile \
+          ./... 2>&1 | \
+        tee gotest.log | \
+        gotestfmt
+
+    - name: Upload test log
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: test-log
+        path: gotest.log
+        if-no-files-found: error
+
+    - name: Report test coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        files: cover.profile

.github/workflows/reuse.yaml

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
+# SPDX-License-Identifier: CC0-1.0
+
+# yaml-language-server: $schema=https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/github-workflow.json
+---
+name: Compliance Checks
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  test:
+    name: REUSE
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v2

.golangci.yaml

@@ -0,0 +1,121 @@
+# SPDX-FileCopyrightText: 2023 Steffen Vogel <[email protected]>
+# SPDX-License-Identifier: Apache-2.0
+
+linters-settings:
+  misspell:
+    locale: US
+
+  exhaustive:
+    default-signifies-exhaustive: true
+
+  gomodguard:
+    blocked:
+      modules:
+      - github.com/pkg/errors:
+          recommendations:
+          - errors
+
+  tagliatelle:
+    case:
+      use-field-name: true
+      rules:
+        json: snake
+        yaml: snake
+        xml: snake
+
+  gci:
+    sections:
+    - standard
+    - default
+    - prefix(cunicu.li/skeleton)
+    - blank
+    - dot
+
+    custom-order: true
+
+linters:
+  enable:
+  - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
+  - bidichk # Checks for dangerous unicode character sequences
+  - bodyclose # checks whether HTTP response body is closed successfully
+  - contextcheck # check the function whether use a non-inherited context
+  - decorder # check declaration order and count of types, constants, variables and functions
+  - dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
+  - dupl # Tool for code clone detection
+  - durationcheck # check for two durations multiplied together
+  - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
+  - errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted.
+  - errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.
+  - 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.
+  - exhaustive # check exhaustiveness of enum switch statements
+  - exportloopref # checks for pointers to enclosing loop variables
+  - forcetypeassert # finds forced type assertions
+  - gci # Gci control golang package import order and make it always deterministic.
+  - gochecknoglobals # Checks that no globals are present in Go code
+  - gochecknoinits # Checks that no init functions are present in Go code
+  - gocognit # Computes and checks the cognitive complexity of functions
+  - goconst # Finds repeated strings that could be replaced by a constant
+  - gocritic # The most opinionated Go source code linter
+  - goerr113 # Golang linter to check the errors handling expressions
+  - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
+  - gofumpt # Gofumpt checks whether code was gofumpt-ed.
+  - goheader # Checks is file header matches to pattern
+  - goimports # Goimports does everything that gofmt does. Additionally it checks unused imports
+  - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
+  - 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.
+  - goprintffuncname # Checks that printf-like functions are named with `f` at the end
+  - gosec # Inspects source code for security problems
+  - gosimple # Linter for Go source code that specializes in simplifying a code
+  - govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+  - grouper # An analyzer to analyze expression groups.
+  - importas # Enforces consistent import aliases
+  - ineffassign # Detects when assignments to existing variables are not used
+  - misspell # Finds commonly misspelled English words in comments
+  - nakedret # Finds naked returns in functions greater than a specified function length
+  - nilerr # Finds the code that returns nil even if it checks that the error is not nil.
+  - nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value.
+  - noctx # noctx finds sending http request without context.Context
+  - predeclared # find code that shadows one of Go's predeclared identifiers
+  - revive # golint replacement, finds style mistakes
+  - staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
+  - stylecheck # Stylecheck is a replacement for golint
+  - tagliatelle # Checks the struct tags.
+  - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
+  - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
+  - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
+  - unconvert # Remove unnecessary type conversions
+  - unparam # Reports unused function parameters
+  - unused # Checks Go code for unused constants, variables, functions and types
+  - wastedassign # wastedassign finds wasted assignment statements
+  - whitespace # Tool for detection of leading and trailing whitespace
+
+  disable:
+  - containedctx # containedctx is a linter that detects struct contained context.Context field
+  - cyclop # checks function and package cyclomatic complexity
+  - depguard # Go linter that checks if package imports are in a list of acceptable packages
+  - exhaustivestruct # Checks if all struct's fields are initialized
+  - forbidigo # Forbids identifiers
+  - funlen # Tool for detection of long functions
+  - gocyclo # Computes and checks the cyclomatic complexity of functions
+  - godot # Check if comments end in a period
+  - godox # Tool for detection of FIXME, TODO and other comment keywords
+  - gomnd # An analyzer to detect magic numbers.
+  - ifshort # Checks that your code uses short syntax for if-statements whenever possible
+  - ireturn # Accept Interfaces, Return Concrete Types
+  - lll # Reports long lines
+  - maintidx # maintidx measures the maintainability index of each function.
+  - makezero # Finds slice declarations with non-zero initial length
+  - maligned # Tool to detect Go structs that would take less memory if their fields were sorted
+  - nestif # Reports deeply nested if statements
+  - nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity
+  - nolintlint # Reports ill-formed or insufficient nolint directives
+  - paralleltest # paralleltest detects missing usage of t.Parallel() method in your Go test
+  - prealloc # Finds slice declarations that could potentially be preallocated
+  - promlinter # Check Prometheus metrics naming via promlint
+  - rowserrcheck # checks whether Err of rows is checked successfully
+  - sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed.
+  - testpackage # linter that makes you use a separate _test package
+  - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
+  - varnamelen # checks that the length of a variable's name matches its scope
+  - wrapcheck # Checks that errors returned from external packages are wrapped
+  - wsl # Whitespace Linter - Forces you to use empty lines!

.renovaterc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>cunicu/renovate-config"
+  ]
+}

.renovaterc.json.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2023 Steffen Vogel <[email protected]>
+SPDX-License-Identifier: Apache-2.0

.reuse/dep5

@@ -0,0 +1,8 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: skeleton
+Upstream-Contact: Steffen Vogel <[email protected]>
+Source: https://github.com/stv0g/skeleton
+
+Files: go.sum flake.lock
+Copyright: 2023 Steffen Vogel <[email protected]>
+License: Apache-2.0

CODEOWNERS

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2023 Steffen Vogel <[email protected]>
+# SPDX-License-Identifier: Apache-2.0
+
+* @stv0g