ci: lint YAML and spell check code

.codespellrc

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+# vim: ft=toml
+
+[codespell]
+skip = LICENSES,.git,*.asc,./rpm_spec/*-*.spec,*.muttrc,./salt/sys-cacher/files/server/conf/*_mirrors_*,./salt/dotfiles/files/vim/.config/vim/after/plugin/update-time.vim
+ignore-words-list = uptodate,iterm,doas
+ignore-regex = (nnoremap|bind)\b.*

.github/workflows/main.yaml

@@ -34,13 +34,12 @@ jobs:
         run: sudo apt-get -y update
       - name: Install OS packages
         # yamllint disable-line rule:line-length
-        run: sudo apt-get install -y python3-dev python3-pip shellcheck reuse ruby-mdl pylint
+        run: sudo apt-get install -y $(cat dev-deps-debian.txt)
-      # gitlint is available on Debian but Ubuntu has an older version.
       - name: Remove externally managed python environment flag
         # yamllint disable-line rule:line-length
         run: sudo dpkg-divert --rename --add /usr/lib/$(py3versions -d)/EXTERNALLY-MANAGED
       - name: Install pip packages
-        run: pip3 install salt-lint gitlint
+        run: pip3 install $(cat dev-deps-pip.txt)
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+# yamllint disable-line rule:line-length
 # SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
@@ -14,6 +15,13 @@ repos:
         pass_filenames: true
         description: Prohibit Unicode
 
+      - id: spell-lint
+        name: spell-lint
+        entry: scripts/spell-lint.sh
+        language: script
+        pass_filenames: true
+        description: Spellcheck files
+
       - id: shell-lint
         name: shell-lint
         entry: scripts/shell-lint.sh
@@ -45,6 +53,14 @@ repos:
         files: \.(sls|top)$
         description: Lint Salt files
 
+      - id: yaml-lint
+        name: yaml-lint
+        entry: scripts/yaml-lint.sh
+        language: script
+        pass_filenames: true
+        files: \.(yaml|yml)$
+        description: Lint YAML files
+
       - id: qubesbuilder-gen
         name: qubesbuilder-gen
         entry: scripts/qubesbuilder-gen.sh
@@ -53,14 +69,14 @@ repos:
         pass_filenames: false
         description: Check if .qubesbuilder is up to date
 
-# TODO: generate temporary spec and compare against staged one.
+        # TODO: generate temporary spec and compare against staged one.
-#       - id: spec-gen
+        # - id: spec-gen
-#         name: spec-gen
+        #   name: spec-gen
-#         language: script
+        #   language: script
-#         entry: scripts/spec-gen.sh test
+        #   entry: scripts/spec-gen.sh test
-#         args: [test]
+        #   args: [test]
-#         # pass_filenames: true
+        #   # pass_filenames: true
-#         description: Check if RPM SPEC files are up to date
+        #   description: Check if RPM SPEC files are up to date
 
       - id: reuse-lint
         name: reuse-lint

.reuse/dep5

@@ -11,6 +11,10 @@ Files: version salt/*/version
 Copyright: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 License: CC0-1.0
 
+Files: dependencies/*
+Copyright: 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+License: CC0-1.0
+
 Files: salt/electrum/files/client/keys/*
 Copyright: SomberNight/ghost43 <somber.night@protonmail.com>
            Stephan Oeste <stephan@oeste.de>

.yamllint.yaml

@@ -11,8 +11,8 @@ ignore: |
 yaml-files:
   - '*.yaml'
   - '*.yml'
-  - .salt-lint
+
-  - .yamllint
+strict: true
 
 rules:
   empty-values:

dependencies/debian.txt

@@ -0,0 +1,11 @@
+codespell
+git
+gitlint
+pre-commit
+pylint
+python3-dev
+python3-pip
+reuse
+ruby-mdl
+shellcheck
+yamllint

dependencies/pip.txt

@@ -0,0 +1 @@
+salt-lint

dependencies/rpm.txt

@@ -0,0 +1,4 @@
+dnf
+dnf-plugins-core
+rpm
+rpmlint

scripts/spell-lint.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+## SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+# shellcheck disable=SC2086
+set -eu
+
+command -v git >/dev/null || { echo "Missing program: git" >&2; exit 1; }
+cd "$(git rev-parse --show-toplevel)" || exit 1
+./scripts/requires-program.sh codespell
+
+if test -n "${1-}"; then
+  files=""
+  for f in "$@"; do
+    test -f "$f" || continue
+    case "$f" in
+      *LICENSES/*|.git/*|*.asc|rpm_spec/*-*.spec|*.muttrc| \
+      salt/sys-cacher/files/server/conf/*_mirrors_*|\
+      salt/dotfiles/files/vim/.config/vim/after/plugin/update-time.vim)
+        continue;;
+      *) files="$files $f";;
+    esac
+  done
+  test -n "$files" || exit 0
+  exec codespell --check-filenames --check-hidden ${files}
+fi
+
+exec codespell --check-filenames --check-hidden

scripts/yaml-lint.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+## SPDX-FileCopyrightText: 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+# shellcheck disable=SC2086
+set -eu
+
+command -v git >/dev/null || { echo "Missing program: git" >&2; exit 1; }
+cd "$(git rev-parse --show-toplevel)" || exit 1
+./scripts/requires-program.sh yamllint
+
+if test -n "${1-}"; then
+  files=""
+  for f in "$@"; do
+    test -f "$f" || continue
+    extension="${f##*.}"
+    case "$extension" in
+      yaml|yml) files="$files $f";;
+      *) continue;;
+    esac
+  done
+  test -n "$files" || exit 0
+  exec yamllint ${files}
+fi
+
+exec yamllint .