chore: add pre-commit

.github/workflows/pr-build.yml

@@ -5,6 +5,12 @@ on:
     branches:
       - master
 
+permissions:
+  contents: read
+  packages: write
+  attestations: write
+  id-token: write
+
 jobs:
   changes:
     runs-on: ubuntu-latest
@@ -22,6 +28,8 @@ jobs:
               - '.github/workflows/pr-build.yml'
               - '.github/workflows/release.yml'
               - '.github/workflows/reusable-docker-build.yml'
+              - '.github/workflows/reusable-pre-commit.yml'
+              - '.pre-commit-config.yaml'
               - 'pkg/**'
               - 'main.go'
               - 'go.*'
@@ -53,3 +61,11 @@ jobs:
     needs: changes
     if: ${{ needs.changes.outputs.src == 'true' }}
     uses: ./.github/workflows/reusable-unittests.yml
+
+  pre-commit:
+    needs: changes
+    if: ${{ needs.changes.outputs.src == 'true' }}
+    uses: ./.github/workflows/reusable-pre-commit.yml
+    with:
+      base_sha: ${{ github.event.pull_request.base.sha }}
+      head_sha: ${{ github.event.pull_request.head.sha }}

.github/workflows/reusable-docker-build.yml

@@ -18,7 +18,7 @@ jobs:
       packages: write
       attestations: write
       id-token: write
-      
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.github/workflows/reusable-pre-commit.yml

@@ -0,0 +1,28 @@
+name: Reusable Pre-commit
+
+on:
+  workflow_call:
+    inputs:
+      base_sha:
+        required: true
+        type: string
+      head_sha:
+        required: true
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --from-ref ${{ inputs.base_sha }} --to-ref ${{ inputs.head_sha }}

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/golangci/golangci-lint
+    rev: v2.12.2
+    hooks:
+      - id: golangci-lint

Dockerfile

@@ -23,4 +23,3 @@ WORKDIR /app
 COPY --from=builder /app/plugnpin .
 
 CMD [ "./plugnpin" ]
-

README.md

@@ -31,8 +31,8 @@ as local DNS/CNAME records in **Pi-Hole** (or DNS Rewrites in **AdGuard Home**)
 PlugNPiN discovers services by scanning for Docker containers that have the following labels:
 
 - `plugNPiN.ip` - The IP address and port of the container (e.g., `192.168.1.100:8080`).
-- `plugNPiN.url` - The desired URL for the service (e.g., `my-service.local`).  
-   Multiple domains are supported and should be comma-separated,  
+- `plugNPiN.url` - The desired URL for the service (e.g., `my-service.local`).
+   Multiple domains are supported and should be comma-separated,
    for example `domain1.local,domain2.local`.
 
 The application operates in two complementary modes to keep your services synchronized:

docs/css/theme.css

@@ -7,4 +7,3 @@
 [data-md-color-scheme="slate"] {
   --md-code-fg-color: #DEDEDE;
 }
-

docs/index.md

@@ -21,8 +21,8 @@ See [Optional Environment Variables](./configuration.md#optional).
 PlugNPiN discovers services by scanning for Docker containers that have the following labels:
 
 - `plugNPiN.ip` - The IP address and port of the container (e.g., `192.168.1.100:8080`).
-- `plugNPiN.url` - The desired URL for the service (e.g., `my-service.local`).  
-  Multiple domains are supported (since version [:octicons-tag-24: 0.10.0](https://github.com/DeepSpace2/plugnpin/releases/tag/v0.10.0){ .md-tag target="_blank" }) and should be comma-separated,  
+- `plugNPiN.url` - The desired URL for the service (e.g., `my-service.local`).
+  Multiple domains are supported (since version [:octicons-tag-24: 0.10.0](https://github.com/DeepSpace2/plugnpin/releases/tag/v0.10.0){ .md-tag target="_blank" }) and should be comma-separated,
    for example `domain1.local,domain2.local`.
 
 The application operates in two complementary modes to keep your services synchronized:

docs/js/anchor-jump-highlight.js

@@ -14,7 +14,7 @@ function isElementInsideTable(element) {
 document.addEventListener('DOMContentLoaded', function() {
   document.querySelectorAll('a[href^="#"]').forEach(anchor => {
     anchor.addEventListener('click', function(e) {
-      
+
       const targetId = this.getAttribute('href').substring(1);
       let targetElement = document.getElementById(targetId);
 

docs/js/copy-to-clipboard.js

@@ -12,25 +12,25 @@ document$.subscribe(function() {
 
     const wrapper = document.createElement("span");
     wrapper.classList.add("copy-to-clipboard-wrapper");
-    
+
     code.parentNode.insertBefore(wrapper, code);
     wrapper.appendChild(code);
-    
+
     const button = document.createElement("button");
     button.type = "button";
     button.setAttribute("aria-label", "Copy to clipboard");
     button.setAttribute("title", "Copy to clipboard");
     button.classList.add("copy-to-clipboard-button");
     button.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 21H8V7h11m0-2H8a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h11a2 2 0 0 0 2-2V7a2 2 0 0 0-2-2m-3-4H4a2 2 0 0 0-2 2v14h2V3h12V1Z"/></svg>';
-    
+
     wrapper.appendChild(button);
-    
+
     button.addEventListener("click", (e) => {
       e.preventDefault();
       e.stopPropagation();
 
       const textToCopy = code.textContent.trim();
-      
+
       const fallbackCopy = () => {
         const textArea = document.createElement("textarea");
         textArea.value = textToCopy;
@@ -64,10 +64,10 @@ document$.subscribe(function() {
 
   function showSuccess(button) {
     const originalHTML = button.innerHTML;
-    
+
     button.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 7 9 19l-5.5-5.5 1.41-1.41L9 16.17 19.59 5.59 21 7Z"/></svg>';
     button.classList.add("copy-success");
-    
+
     setTimeout(() => {
       button.innerHTML = originalHTML;
       button.classList.remove("copy-success");

docs/monitoring.md

@@ -4,10 +4,10 @@
 
 [:octicons-tag-24: 1.0.0](https://github.com/DeepSpace2/plugnpin/releases/tag/v1.0.0){ .md-tag target="_blank" }
 
-PlugNPiN optionally exposes runtime and application metrics in Prometheus format  
+PlugNPiN optionally exposes runtime and application metrics in Prometheus format
 by using the `METRICS` environment variable ([Configuration → Environment Variables](./configuration.md#optional)).
 
-By default the metrics endpoint is available at `http://<plugnpin-host>:9100/metrics`  
+By default the metrics endpoint is available at `http://<plugnpin-host>:9100/metrics`
 and the port can be set with the `METRICS_SERVER_PORT` environment variable.
 
 ### Example Prometheus Scrape Configuration
@@ -18,4 +18,3 @@ scrape_configs:
     static_configs:
       - targets: ["<plugnpin-host>:9100"]
 ```
-

docs/theme/overrides/main.html

@@ -2,7 +2,7 @@
 
 {% block outdated %}
   You're not viewing the latest version.
-  <a href="{{ '../' ~ base_url }}"> 
+  <a href="{{ '../' ~ base_url }}">
     <strong>Click here to go to latest.</strong>
   </a>
 {% endblock %}