initial commit

Signed-off-by: Liam Stanley <liam@liam.sh>

.editorconfig

@@ -0,0 +1,53 @@
+# THIS FILE IS GENERATED! DO NOT EDIT! Maintained by Terraform.
+#
+# editorconfig:  https://editorconfig.org/
+# actual source: https://github.com/lrstanley/.github/blob/master/terraform/github-common-files/templates/.editorconfig
+#
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 100
+
+[*.tf]
+indent_size = 2
+
+[*.go]
+indent_style = tab
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{md,py,sh,yml,yaml,cjs,js,ts,vue,css}]
+max_line_length = 105
+
+[*.{yml,yaml,toml}]
+indent_size = 2
+
+[*.json]
+indent_size = 2
+insert_final_newline = ignore
+
+[*.html]
+max_line_length = 140
+indent_size = 2
+
+[*.{cjs,js,ts,vue,css}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+
+[**.min.js]
+indent_style = ignore
+insert_final_newline = ignore
+
+[*.bat]
+indent_style = tab

.github/workflows/generate-readme.yml

@@ -0,0 +1,14 @@
+name: generate-readme
+
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  schedule:
+    - cron: "0 13 * * *"
+
+jobs:
+  generate:
+    uses: lrstanley/.github/.github/workflows/generate-readme.yml@master
+    secrets:
+      token: ${{ secrets.USER_PAT }}

.github/workflows/tag-semver.yml

@@ -0,0 +1,33 @@
+name: tag-semver
+
+on:
+  workflow_dispatch:
+    inputs:
+      method:
+        description: "Tagging method to use"
+        required: true
+        type: choice
+        options: [major, minor, patch, alpha, rc, custom]
+      custom:
+        description: "Custom tag, if the default doesn't suffice. Must also use method 'custom'."
+        required: false
+        type: string
+      ref:
+        description: "Git ref to apply tag to (will use default branch if unspecified)."
+        required: false
+        type: string
+      annotation:
+        description: "Optional annotation to add to the commit."
+        required: false
+        type: string
+
+jobs:
+  tag-semver:
+    uses: lrstanley/.github/.github/workflows/tag-semver.yml@master
+    with:
+      method: ${{ github.event.inputs.method }}
+      ref: ${{ github.event.inputs.ref }}
+      custom: ${{ github.event.inputs.custom }}
+      annotation: ${{ github.event.inputs.annotation }}
+    secrets:
+      token: ${{ secrets.USER_PAT }}

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+
+on:
+  pull_request:
+    branches: [master]
+    paths-ignore: [".gitignore", "**/*.md", ".github/ISSUE_TEMPLATE/**"]
+    types: [opened, edited, reopened, synchronize, unlocked]
+  push:
+    branches: [master]
+    paths-ignore: [".gitignore", "**/*.md", ".github/ISSUE_TEMPLATE/**"]
+
+jobs:
+  go-test:
+    uses: lrstanley/.github/.github/workflows/lang-go-test-matrix.yml@master
+    permissions:
+      contents: read
+    with: { num-minor: 1, num-patch: 2 }
+  go-lint:
+    uses: lrstanley/.github/.github/workflows/lang-go-lint.yml@master
+    permissions:
+      checks: write
+      contents: read
+      pull-requests: read
+      security-events: write
+      statuses: write
+    secrets:
+      SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

.gitignore

@@ -0,0 +1,8 @@
+*.test
+*.prof
+bin/*
+*.lock
+*.txt
+*.log
+.env
+_examples/*/ent

.golangci.yml

@@ -0,0 +1,211 @@
+# THIS FILE IS GENERATED! DO NOT EDIT! Maintained by Terraform.
+#
+# golangci-lint:       https://golangci-lint.run/
+# false-positives:     https://golangci-lint.run/usage/false-positives/
+# actual source:       https://github.com/lrstanley/.github/blob/master/terraform/github-common-files/templates/.golangci.yml
+# modified variant of: https://gist.github.com/maratori/47a4d00457a92aa426dbd48a18776322
+#
+
+run:
+  timeout: 3m
+
+issues:
+  max-per-linter: 0
+  # max-same-issues: 0
+  max-same-issues: 50
+
+  exclude-rules:
+    - source: "(noinspection|TODO)"
+      linters: [godot]
+    - source: "//noinspection"
+      linters: [gocritic]
+    - path: "_test\\.go"
+      linters:
+        - bodyclose
+        - dupl
+        - funlen
+        - goconst
+        - gosec
+        - noctx
+        - wrapcheck
+
+severity:
+  default-severity: error
+  rules:
+    - linters:
+        - errcheck
+        - gocritic
+      severity: warning
+
+linters:
+  disable-all: true
+  enable:
+    - asasalint # checks for pass []any as any in variadic func(...any)
+    - asciicheck # checks 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
+    - cyclop # checks function and package cyclomatic complexity
+    - dupl # tool for code clone detection
+    - durationcheck # checks for two durations multiplied together
+    - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
+    - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
+    - execinquery # checks query string in Query function which reads your Go src files and warning it finds
+    - exportloopref # checks for pointers to enclosing loop variables
+    - forbidigo # forbids identifiers
+    - funlen # tool for detection of long functions
+    - gci # controls golang package import order and makes it always deterministic
+    - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
+    - gochecknoinits # checks that no init functions are present in Go code
+    - goconst # finds repeated strings that could be replaced by a constant
+    - gocritic # provides diagnostics that check for bugs, performance and style issues
+    - gocyclo # computes and checks the cyclomatic complexity of functions
+    - godot # checks if comments end in a period
+    - godox # detects FIXME, TODO and other comment keywords
+    - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
+    - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
+    - gomodguard # allow and block lists 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 # specializes in simplifying a code
+    - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+    - ineffassign # detects when assignments to existing variables are not used
+    - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
+    - makezero # finds slice declarations with non-zero initial length
+    - misspell # finds commonly misspelled words
+    - musttag # enforces field tags in (un)marshaled structs
+    - 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 # finds sending http request without context.Context
+    - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
+    - predeclared # finds code that shadows one of Go's predeclared identifiers
+    - promlinter # checks Prometheus metrics naming via promlint
+    - reassign # checks that package variables are not reassigned
+    - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
+    - rowserrcheck # checks whether Err of rows is checked successfully
+    - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
+    - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
+    - stylecheck # is a replacement for golint
+    - tenv # detects using os.Setenv instead of t.Setenv since Go1.17
+    - testableexamples # checks if examples are testable (have an expected output)
+    - 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 # removes unnecessary type conversions
+    - unparam # reports unused function parameters
+    - unused # checks for unused constants, variables, functions and types
+    - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
+    - wastedassign # finds wasted assignment statements
+    - whitespace # detects leading and trailing whitespace
+
+    # disabled for now:
+    # - gomnd # detects magic numbers
+    # - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
+    # - gochecknoglobals # checks that no global variables exist
+    # - gocognit # computes and checks the cognitive complexity of functions
+    # - nestif # reports deeply nested if statements
+    # - nonamedreturns # reports all named returns
+    # - testpackage # makes you use a separate _test package
+
+linters-settings:
+  cyclop:
+    # The maximal code complexity to report.
+    max-complexity: 30
+    # The maximal average package complexity.
+    # If it's higher than 0.0 (float) the check is enabled
+    package-average: 10.0
+
+  errcheck:
+    # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
+    # Such cases aren't reported by default.
+    check-type-assertions: true
+
+  funlen:
+    # Checks the number of lines in a function.
+    # If lower than 0, disable the check.
+    lines: 150
+    # Checks the number of statements in a function.
+    # If lower than 0, disable the check.
+    statements: 75
+
+  # gocognit:
+  #   # Minimal code complexity to report.
+  #   min-complexity: 25
+
+  gocritic:
+    disabled-checks:
+      - whyNoLint
+      - hugeParam
+      - ifElseChain
+    enabled-tags:
+      - diagnostic
+      - opinionated
+      - performance
+      - style
+    # https://go-critic.github.io/overview.
+    settings:
+      captLocal:
+        # Whether to restrict checker to params only.
+        paramsOnly: false
+      underef:
+        # Whether to skip (*x).method() calls where x is a pointer receiver.
+        skipRecvDeref: false
+
+  # gomnd:
+  #   # Values always ignored: `time.Date`,
+  #   # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
+  #   # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
+  #   ignored-functions:
+  #     - os.Chmod
+  #     - os.Mkdir
+  #     - os.MkdirAll
+  #     - os.OpenFile
+  #     - os.WriteFile
+  #     - prometheus.ExponentialBuckets
+  #     - prometheus.ExponentialBucketsRange
+  #     - prometheus.LinearBuckets
+
+  gomodguard:
+    blocked:
+      # List of blocked modules.
+      modules:
+        - github.com/golang/protobuf:
+            recommendations:
+              - google.golang.org/protobuf
+            reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
+        - github.com/satori/go.uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "satori's package is not maintained"
+        - github.com/gofrs/uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "gofrs' package is not go module"
+
+  govet:
+    enable-all: true
+    # Run `go tool vet help` to see all analyzers.
+    disable:
+      - fieldalignment # too strict
+    settings:
+      shadow:
+        # Whether to be strict about shadowing; can be noisy.
+        strict: true
+
+  nakedret:
+    # Make an issue if func has more lines of code than this setting, and it has naked returns.
+    max-func-lines: 0
+
+  rowserrcheck:
+    # database/sql is always checked
+    packages:
+      - github.com/jmoiron/sqlx
+
+  stylecheck:
+    checks:
+      - all
+      - -ST1008 # handled by revive already.
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    all: true

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "golang.go",
+        "jinliming2.vscode-go-template"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "files.associations": {
+        "**/*.gotmpl": "go-template",
+    },
+    "files.exclude": {
+        "**/*.example": true,
+        "**/*.log": true,
+        "**/*.sum": true,
+        "**/.*ignore": true,
+        "**/.golangci.yml": true,
+        "**/LICENSE": true,
+        "**/tmp": true,
+    },
+    "go.lintTool": "golangci-lint",
+    "gopls": {
+        "formatting.gofumpt": true
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Liam Stanley <liam@liam.sh>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.