feat: add lefthook, megalinter and update editorconfig (#270)

This change adds [LeftHook](https://lefthook.dev/) as a GitHub hook management tool alongside [MegaLinter](https://megalinter.io/) to lint all relevant files within the repository.

For users that don't end up installing LeftHook for pre-commit hooks, megalinter picks up the necessary formatting changes and reports them.

* feat: add lefthook, megalinter and update editorconfig
* fix: lint commit ordering
* refactor: adjust megalinter reporters
* refactor: adjust description for cache domains
* refactor: single - for passing options
* refactor: add repo-specific fmt in megalinter pre-commands too

Author: nightah

.editorconfig

@@ -2,7 +2,13 @@ root = true
 
 [*]
 indent_style = space
-indent_size = 4
+indent_size = 2
 trim_trailing_whitespace = true
 end_of_line = lf
 insert_final_newline = true
+
+[*.md]
+indent_size = 0
+
+[*.sh]
+indent_style = tab

.github/workflows/mega-linter.yml

@@ -0,0 +1,55 @@
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+---
+name: MegaLinter
+
+on:
+  pull_request:
+    branches:
+      - master
+
+env:
+  GITHUB_STATUS_REPORTER: true
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: MegaLinter
+        uses: oxsecurity/megalinter@v8
+        id: ml
+        env:
+          VALIDATE_ALL_CODEBASE: >-
+            ${{
+              github.event_name == 'push' &&
+              github.ref == 'refs/heads/master'
+            }}
+
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: MegaLinter reports
+          include-hidden-files: "true"
+          path: |
+            megalinter-reports
+            mega-linter.log

.gitignore

@@ -1,2 +1,3 @@
 scripts/output
 scripts/config.json
+megalinter-reports/

.lefthook.yml

@@ -0,0 +1,19 @@
+pre-commit:
+  parallel: true
+  jobs:
+    - name: sort cache domains
+      run: jq ".cache_domains |= sort_by(.name)" {all_files} > {all_files}.tmp && mv {all_files}.tmp {all_files}
+      glob: "cache_domains.json"
+
+    - name: sort cdns
+      run: |
+        for f in {all_files}; do
+          sort -uo ${f} ${f}
+        done
+      env:
+        LC_ALL: C
+      glob: "*.txt"
+
+    - name: megalinter
+      run: docker run --rm -e USER=$(id -u) -e GROUP=$(id -g) -v "$PWD:/tmp/lint" oxsecurity/megalinter:v8
+      stage_fixed: true

.mega-linter.yml

@@ -0,0 +1,39 @@
+# Configuration file for MegaLinter
+#
+# See all available variables at https://megalinter.io/latest/config-file/ and in
+# linters documentation
+
+APPLY_FIXES: all
+FLAVOR_SUGGESTIONS: false
+PRINT_ALPACA: false
+SHOW_ELAPSED_TIME: true
+
+ENABLE:
+  - ACTION
+  - BASH
+  - EDITORCONFIG
+  - JSON
+  - MARKDOWN
+  - SPELL
+  - YAML
+
+DISABLE_LINTERS:
+  - JSON_V8R
+  - MARKDOWN_MARKDOWNLINT
+  - SPELL_CSPELL
+  - YAML_V8R
+
+PRE_COMMANDS:
+  - command: apk add --no-cache yq
+    cwd: root
+  - command: yq -i ".cache_domains |= sort_by(.name)" cache_domains.json
+    cwd: workspace
+  - command: |
+      for f in *.txt; do
+        sort -uo ${f} ${f}
+      done
+    cwd: workspace
+
+POST_COMMANDS:
+  - command: find . -user root -group root -exec chown ${USER}:${GROUP} {} \;
+    cwd: workspace

blizzard.txt

@@ -1,11 +1,11 @@
-dist.blizzard.com
-dist.blizzard.com.edgesuite.net
+*.cdn.blizzard.com
 blizzard.vo.llnwd.net
 blzddist1-a.akamaihd.net
 blzddist2-a.akamaihd.net
 blzddist3-a.akamaihd.net
+cdn.blizzard.com
+dist.blizzard.com
+dist.blizzard.com.edgesuite.net
+edge.blizzard.top.comcast.net
 level3.blizzard.com
 nydus.battle.net
-edge.blizzard.top.comcast.net
-cdn.blizzard.com
-*.cdn.blizzard.com