Merge pull request #1883 from pi-hole/editorconfig

Add editorconfig

Author: PromoFaux

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig is awesome: https://editorconfig.org/
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = tab
+tab_width = 4
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.yml]
+tab_width = 2
+
+[*.md]
+tab_width = 2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,31 +12,31 @@ assignees: ''
 
 <!-- IMPORTANT Complete the entire template please, the info gathered here is usually needed to debug issues anyway so it saves time in the long run. Incomplete/stock template issues may be closed -->
 
-<!-- pick ONE: Bug, 
-               Feature Request, 
-               Run Issue (running Pi-hole container failing), 
-               Build Issue (Building image failing) 
+<!-- pick ONE: Bug,
+               Feature Request,
+               Run Issue (running Pi-hole container failing),
+               Build Issue (Building image failing)
 Enter in line below: -->
-This is a: **FILL ME IN**  
+This is a: **FILL ME IN**
 
 
 ## Details
 <!-- Provide a more detailed introduction to the issue or feature, try not to duplicate info from lower sections by reviewing the entire template first -->
 
 ## Related Issues
-- [ ] I have searched this repository/Pi-hole forums for existing issues and pull requests that look similar 
+- [ ] I have searched this repository/Pi-hole forums for existing issues and pull requests that look similar
 <!-- Add links below! -->
 
 <!------- FEATURE REQUESTS CAN STOP FILLING IN TEMPLATE HERE -------->
 <!------- ISSUES SHOULD FILL OUT REMAINDER OF TEMPLATE -------->
 
-## How to reproduce the issue 
+## How to reproduce the issue
 
 1. Environment data
   * Operating System: **ENTER HERE** <!-- Debian, Ubuntu, Rasbian, etc -->
   * Hardware: <!-- PC, RasPi B/2B/3B/4B, Mac, Synology, QNAP, etc -->
   * Kernel Architecture: <!-- x86/amd64, ArmV7, ArmV8 32bit, ArmV8 64bit, etc -->
-  * Docker Install Info and version: 
+  * Docker Install Info and version:
     - Software source: <!-- official docker-ce, OS provided package, Hypriot -->
     - Supplimentary Software: <!-- synology, portainer, etc -->
   * Hardware architecture: <!-- ARMv7, x86 -->

.github/ISSUE_TEMPLATE/config.yml

@@ -9,4 +9,4 @@ contact_links:
   - name: Documentation
     url: https://docs.pi-hole.net
     about: Documentation and guides.
-    
+

.github/dependabot.yml

@@ -2,7 +2,7 @@ version: 2
 updates:
   # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
-    directories: 
+    directories:
       - "/"
     schedule:
       interval: "weekly"

.github/workflows/build-and-publish.yml

@@ -33,7 +33,7 @@ jobs:
             runner: ubuntu-24.04-arm
           - platform: linux/riscv64
             runner: ubuntu-24.04-arm
-          
+
     steps:
       - name: Prepare name for digest up/download
         run: |
@@ -57,7 +57,7 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           images: |
             ${{ env.dockerhub }}
-            ${{ env.ghcr }}            
+            ${{ env.ghcr }}
           flavor: |
             latest=${{ startsWith(github.ref, 'refs/tags/') }}
           tags: |
@@ -95,10 +95,10 @@ jobs:
           context: ./src/
           platforms: ${{ matrix.platform }}
           build-args: |
-            PIHOLE_DOCKER_TAG=${{ steps.meta.outputs.version }}            
+            PIHOLE_DOCKER_TAG=${{ steps.meta.outputs.version }}
             FTL_BRANCH=${{ env.components_branch }}
             CORE_BRANCH=${{ env.components_branch }}
-            WEB_BRANCH=${{ env.components_branch }}            
+            WEB_BRANCH=${{ env.components_branch }}
             PADD_BRANCH=${{ env.components_branch }}
           labels: ${{ steps.meta.outputs.labels }}
           outputs: |
@@ -142,7 +142,7 @@ jobs:
           path: /tmp/digests
           pattern: digests-*
           merge-multiple: true
-      
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
@@ -187,4 +187,4 @@ jobs:
       - name: Inspect images
         run: |
           docker buildx imagetools inspect ${{ env.dockerhub }}:${{ steps.meta.outputs.version }}
-          docker buildx imagetools inspect ${{ env.ghcr }}:${{ steps.meta.outputs.version }}
+          docker buildx imagetools inspect ${{ env.ghcr }}:${{ steps.meta.outputs.version }}

.github/workflows/build-and-test.yml

@@ -34,7 +34,7 @@ jobs:
       uses: actions/setup-python@v5.6.0
       with:
         python-version: "3.13"
-    
+
     - name: Run black formatter
       run: |
         pip install black

.github/workflows/editorconfig.yml

@@ -0,0 +1,18 @@
+name: Editorconfig-Checker
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  editorconfig-checker:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Get editorconfig-checker
+      uses: editorconfig-checker/action-editorconfig-checker@main # tag v1.0.0 is really out of date
+
+    - name: Run editorconfig-checker
+      run: editorconfig-checker

.github/workflows/housekeeping.yml

@@ -17,4 +17,4 @@ jobs:
                     repository: ${{ github.repository }}
                     untagged_only: true
                     owner_type: org # or user
-                    except_untagged_multiplatform: true
+                    except_untagged_multiplatform: true

.gitignore

@@ -13,9 +13,11 @@ docker-compose.yml
 etc-dnsmasq.d/
 etc-pihole/
 var-log/
+.vscode/
+.pytest_cache/
 
 # WIP/test stuff
 doco.yml
 
 # Ignore FTL Binary if it exists
-src/pihole-FTL
+src/pihole-FTL