Change testing library and improve documentation

Author: krostar

.envrc

@@ -1 +1,10 @@
-use flake
+#!/usr/bin/env bash
+
+if type -P lorri &>/dev/null; then
+  eval "$(lorri direnv)"
+elif type -v nix &>/dev/null; then
+  use flake .
+else
+  echo "The shell is set up via Nix, but it seems it is not installed."
+  echo "Please setup your shell manually following README's instructions."
+fi

.github/dependabot.yml

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:best-practices",
+    "config:semverAllMonthly"
+  ],
+  "nix": {
+    "enabled": true
+  }
+}

.github/renovate.json

@@ -0,0 +1,49 @@
+---
+name: "Quality"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_call: {}
+  workflow_dispatch: {}
+
+env:
+  GITHUB_COM_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+permissions:
+  contents: "read"
+
+jobs:
+  ci:
+    name: "Quality Checks (lint and test)"
+    permissions:
+      actions: "write"
+      contents: "read"
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 10
+    steps:
+      - uses: "nixbuild/nix-quick-install-action@1f095fee853b33114486cfdeae62fa099cda35a9" # v33
+      - uses: "nix-community/cache-nix-action@135667ec418502fa5a3598af6fb9eb733888ce6a" # v6
+        with:
+          primary-key: "cache-nix-store-${{ runner.os }}-${{ hashFiles('flake.nix', 'flake.lock') }}"
+          restore-prefixes-first-match: "cache-nix-store-${{ runner.os }}-"
+          gc-max-store-size-linux: 1073741824 # 1go
+          purge: true
+          purge-prefixes: "cache-nix-store-${{ runner.os }}-"
+          purge-created: 0
+          purge-primary-key: "never"
+      - uses: "cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad" # v16
+        with:
+          name: "krostar"
+          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
+      - uses: "actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8" # v5
+      - name: "Print nix version"
+        run: "nix --version"
+      - name: "Print flake metadata"
+        run: "nix flake metadata"
+      - name: "Setup shell"
+        run: "nix develop --command true"
+      - name: "Just CI"
+        run: "nix develop --command just ci"

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+---
+name: "Scheduled Quality"
+
+on:
+  schedule:
+    - cron: "0 4 1 * *"
+
+  workflow_dispatch:
+    inputs:
+      activity_days_threshold:
+        description: "Days to look back for commit activity"
+        required: false
+        type: "number"
+
+concurrency:
+  group: "${{ github.workflow }}"
+  cancel-in-progress: false
+
+env:
+  GITHUB_COM_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+  ACTIVITY_DAYS_THRESHOLD: "${{ inputs.activity_days_threshold || 30 }}"
+
+permissions:
+  contents: "read"
+
+jobs:
+  get-activity:
+    name: "Check Repository Activity"
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 1
+    outputs:
+      have-recent-commits: "${{ steps.get-activity.outputs.have-recent-commits }}"
+    steps:
+      - name: "Get commits activity"
+        id: "get-activity"
+        uses: "actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea" # v7
+        with:
+          script: |
+            const daysThreshold = parseInt(process.env.ACTIVITY_DAYS_THRESHOLD);
+            const checkDate = new Date();
+            checkDate.setDate(checkDate.getDate() - daysThreshold);
+
+            const commits = await github.rest.repos.listCommits({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              since: checkDate.toISOString(),
+              per_page: 1
+            });
+
+            core.setOutput('have-recent-commits', commits.data.length != 0);
+
+  call-ci-workflow:
+    name: "Call CI workflow"
+    needs: "get-activity"
+    if: "needs.get-activity.outputs.have-recent-commits == 'false'"
+    uses: "./.github/workflows/quality.yml"
+    secrets: "inherit"
+    permissions:
+      actions: "write"
+      contents: "read"

.github/workflows/quality.yml

@@ -1 +1,7 @@
 /.direnv
+/result
+
+# nixago: ignore-linked-files
+/.editorconfig
+/.idea/watcherTasks.xml
+/.justfile

.github/workflows/scheduled-quality.yml

@@ -0,0 +1,21 @@
+{
+  ci.testers.go.enable = true;
+  ci.linters = {
+    editorconfig-checker.settings.Exclude = ["./double/internal/*_generated*.go"];
+    golangci-lint = {
+      enable = true;
+      linters = {
+        exclusions = {
+          paths = ["internal/example"];
+          rules = [
+            {
+              path = "api.go";
+              linters = ["gocritic"];
+              text = "hugeParam: serverAddress is heavy";
+            }
+          ];
+        };
+      };
+    };
+  };
+}

.gitignore

@@ -0,0 +1 @@
+{deps, ...}: deps.synergy.result.devShells.harmony.go