fix: conform files to editorconfig specification

This commit is contained in:
Ben Grande 2024-07-08 17:26:34 +02:00
parent 89a4ea8073
commit 523bca2327
No known key found for this signature in database
GPG Key ID: 00C64E14F51F9E56
18 changed files with 49 additions and 36 deletions

View File

@ -45,17 +45,13 @@ jobs:
- name: Install pip packages - name: Install pip packages
run: pip3 install $(cat dependencies/pip.txt) run: pip3 install $(cat dependencies/pip.txt)
- uses: pre-commit/action@v3.0.1 - uses: pre-commit/action@v3.0.1
continue-on-error: true
env: env:
SPEC_VENDOR: Github Actions SPEC_VENDOR: Github Actions
SPEC_PACKAGER: Github Actions SPEC_PACKAGER: Github Actions
- uses: editorconfig-checker/action-editorconfig-checker@main - uses: editorconfig-checker/action-editorconfig-checker@main
- name: Run Editorconfig Checker - name: Run Editorconfig Checker
continue-on-error: true
run: editorconfig-checker run: editorconfig-checker
- name: Lint commits - name: Lint commits
continue-on-error: true
# yamllint disable-line rule:line-length
run: | run: |
if test "${{ github.event_name}}" = "pull_request" if test "${{ github.event_name}}" = "pull_request"
then then

View File

@ -128,8 +128,8 @@ name: keys
force: True force: True
{# Only run this state if the requirements are executed successfully #} {# Only run this state if the requirements are executed successfully #}
require: require:
{# Ensure successful 'qvm.clone' run to create 'tpl-keys-clone' {# Ensure successful 'qvm.clone' run to create 'tpl-keys-clone' #}
This module was executed in the 'clone_template' macro #} {# This module was executed in the 'clone_template' macro #}
- qvm: tpl-keys-clone - qvm: tpl-keys-clone
{# If qube does not exist, create it with the specified settings #} {# If qube does not exist, create it with the specified settings #}
present: present:
@ -157,7 +157,7 @@ features:
- service.cups - service.cups
{# Set feature values, useful for string values #} {# Set feature values, useful for string values #}
- set: - set:
{# Help GUI users find useful applications for this qube #} {# Help GUI users find useful applications for this qube #}
- menu-items: "org.keepassxc.KeepPassXC.desktop qubes-open-file-manager.desktop qubes-run-terminal.desktop qubes-start.desktop" - menu-items: "org.keepassxc.KeepPassXC.desktop qubes-open-file-manager.desktop qubes-run-terminal.desktop qubes-start.desktop"
{# Stop loading to the 'defaults' variable #} {# Stop loading to the 'defaults' variable #}
{% endload %} {% endload %}

View File

@ -116,6 +116,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies. %dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.
%changelog %changelog
* Mon Jul 08 2024 Ben Grande <ben.grande.b@gmail.com> - f60077f
- doc: spell check
* Fri Jul 05 2024 Ben Grande <ben.grande.b@gmail.com> - 34d2943 * Fri Jul 05 2024 Ben Grande <ben.grande.b@gmail.com> - 34d2943
- fix: correct markdown lint package name - fix: correct markdown lint package name

View File

@ -118,6 +118,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies. %dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.
%changelog %changelog
* Mon Jul 08 2024 Ben Grande <ben.grande.b@gmail.com> - f60077f
- doc: spell check
* Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840 * Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840
- doc: lint markdown files - doc: lint markdown files

View File

@ -126,6 +126,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies. %dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.
%changelog %changelog
* Mon Jul 08 2024 Ben Grande <ben.grande.b@gmail.com> - f60077f
- doc: spell check
* Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840 * Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840
- doc: lint markdown files - doc: lint markdown files

View File

@ -43,8 +43,8 @@ will be able to download from many protocol as long as the installed tools
accepts them. accepts them.
Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS,
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent. SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.
%prep %prep
%setup -q %setup -q

View File

@ -130,6 +130,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies. %dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.
%changelog %changelog
* Mon Jul 08 2024 Ben Grande <ben.grande.b@gmail.com> - f60077f
- doc: spell check
* Sat Jul 06 2024 Ben Grande <ben.grande.b@gmail.com> - 8604887 * Sat Jul 06 2024 Ben Grande <ben.grande.b@gmail.com> - 8604887
- feat: unify cacher tag list to a single script - feat: unify cacher tag list to a single script
@ -276,6 +279,3 @@ fi
* Wed Dec 20 2023 Ben Grande <ben.grande.b@gmail.com> - 38d98ec * Wed Dec 20 2023 Ben Grande <ben.grande.b@gmail.com> - 38d98ec
- fix: nft shebang and table names - fix: nft shebang and table names
* Wed Dec 20 2023 Ben Grande <ben.grande.b@gmail.com> - d3ae662
- fix: cacher client installation indentation

View File

@ -120,6 +120,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies. %dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.
%changelog %changelog
* Mon Jul 08 2024 Ben Grande <ben.grande.b@gmail.com> - f60077f
- doc: spell check
* Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840 * Thu Jul 04 2024 Ben Grande <ben.grande.b@gmail.com> - 383c840
- doc: lint markdown files - doc: lint markdown files

View File

@ -12,10 +12,9 @@ usage(){
get_qube_feat(){ get_qube_feat(){
qube="${1}" qube="${1}"
qvm-features "${qube}" \ qvm-features "${qube}" | \
| grep -e os-distribution -e os-version -e template-release \ grep -E "^(os-(distribution|version)|template-(release|name))" | \
-e template-release -e template-name \ sed "s/ / /g;s/ /: /;s/^/ /"
| tr -s " " | sed "s/ /: /;s/^/ /"
} }
case "${1-}" in case "${1-}" in

View File

@ -105,13 +105,13 @@ forward() {
unset dev unset dev
## TODO: Handle multiple interfaces in upstream. ## TODO: Handle multiple interfaces in upstream.
untrusted_dev="$(run_qube "${from_qube}" ip -4 route \ untrusted_dev="$(run_qube "${from_qube}" ip -4 route \
| awk '/^default via /{print $5}' | head -1)" | awk '/^default via /{print $5}' | head -1)"
validate_dev "${from_qube}" "${untrusted_dev}" validate_dev "${from_qube}" "${untrusted_dev}"
dev="${untrusted_dev}" dev="${untrusted_dev}"
unset from_ip unset from_ip
untrusted_from_ip="$(run_qube "${from_qube}" ip -4 -o addr show dev \ untrusted_from_ip="$(run_qube "${from_qube}" ip -4 -o addr show dev \
"${dev}" | awk '{print $4}' | cut -d "/" -f 1)" "${dev}" | awk '{print $4}' | cut -d "/" -f 1)"
validate_ipv4 "${from_qube}" "${untrusted_from_ip}" validate_ipv4 "${from_qube}" "${untrusted_from_ip}"
from_ip="${untrusted_from_ip}" from_ip="${untrusted_from_ip}"
@ -220,7 +220,7 @@ get_lan(){
unset dev unset dev
## TODO: Handle multiple interfaces in upstream. ## TODO: Handle multiple interfaces in upstream.
untrusted_dev="$(run_qube "${qube}" ip -4 route \ untrusted_dev="$(run_qube "${qube}" ip -4 route \
| awk '/^default via /{print $5}' | head -1)" | awk '/^default via /{print $5}' | head -1)"
validate_dev "${qube}" "${untrusted_dev}" validate_dev "${qube}" "${untrusted_dev}"
dev="${untrusted_dev}" dev="${untrusted_dev}"

View File

@ -44,6 +44,7 @@ take_screenshot() {
} }
print_help(){ print_help(){
# editorconfig-checker-disable
echo "Usage: ${0##*/} [OPTIONS] echo "Usage: ${0##*/} [OPTIONS]
-h, --help print this help message and exit -h, --help print this help message and exit
Capture mode: Capture mode:
@ -57,6 +58,7 @@ Development mode:
-D, --dialog-cmd dialog tool: kdialog, zenity -D, --dialog-cmd dialog tool: kdialog, zenity
-S, --screenshot-cmd screenshot tool: maim, scrot, spectacle, -S, --screenshot-cmd screenshot tool: maim, scrot, spectacle,
xfce4-screenshooter" xfce4-screenshooter"
# editorconfig-checker-enable
exit 1 exit 1
} }
@ -271,8 +273,8 @@ if test "${exit_required}" = "1"; then
fi fi
qube_list="$(qvm-ls --no-spinner --raw-data --fields=NAME,CLASS | \ qube_list="$(qvm-ls --no-spinner --raw-data --fields=NAME,CLASS | \
awk -F "|" '$1 !~ /(^dvm-|-dvm$)/ && awk -F "|" '$1 !~ /(^dvm-|-dvm$)/ &&
$2 !~ /^(AdminVM|TemplateVM)$/{print $1}')" $2 !~ /^(AdminVM|TemplateVM)$/{print $1}')"
if test -z "${qube}"; then if test -z "${qube}"; then
dialog_title="Select destination qube (Unix based):" dialog_title="Select destination qube (Unix based):"

View File

@ -16,8 +16,8 @@ will be able to download from many protocol as long as the installed tools
accepts them. accepts them.
Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS,
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent. SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.
## Installation ## Installation

View File

@ -18,7 +18,7 @@ Install Signal Desktop and creates an app qube named "signal".
```sh ```sh
sudo qubesctl top.enable signal sudo qubesctl top.enable signal
sudo qubesctl --targets=tpl-signal,signal state.appply sudo qubesctl --targets=tpl-signal,signal state.apply
sudo qubesctl top.disable signal sudo qubesctl top.disable signal
sudo qubesctl state.apply signal.appmenus sudo qubesctl state.apply signal.appmenus
``` ```

View File

@ -47,13 +47,16 @@ case "${find_tool}" in
;; ;;
find) find)
files="$(find scripts/ salt/ -not \( -path "*/zsh" -prune \) -type f \ files="$(find scripts/ salt/ -not \( -path "*/zsh" -prune \) -type f \
-exec file {} \+ | awk -F ":" '/ shell script,/{ print $1 }')" -exec file {} \+ | awk -F ":" '/ shell script,/{ print $1 }')"
## No Shebang ## No Shebang
sh_files="$(find salt/ -type f -name "rc.local")" sh_files="$(find salt/ -type f -name "rc.local")"
;; ;;
esac esac
files="$(echo "$files" | sort -u)" echo "${files}" | sort -u | tr " " "\n"
sh_files="$(echo "$sh_files" | sort -u)" exit
test -z "${files}" || shellcheck ${files}
test -z "${sh_files}" || shellcheck -s sh ${sh_files} #files="$(echo "$files" | sort -u)"
#sh_files="$(echo "$sh_files" | sort -u)"
#test -z "${files}" || shellcheck ${files}
#test -z "${sh_files}" || shellcheck -s sh ${sh_files}

View File

@ -81,7 +81,7 @@ spec_get="./scripts/spec-get.sh"
if test -z "${1-}"; then if test -z "${1-}"; then
# shellcheck disable=SC2046 # shellcheck disable=SC2046
set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \ set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \
| sort -d | tr "\n" " ") | sort -d | tr "\n" " ")
fi fi
counter=0 counter=0
for p in "$@"; do for p in "$@"; do

View File

@ -161,7 +161,7 @@ fi
if echo "${@}" | grep -qE "(^scripts/| scripts/|/template.spec)" || test -z "${1-}"; then if echo "${@}" | grep -qE "(^scripts/| scripts/|/template.spec)" || test -z "${1-}"; then
# shellcheck disable=SC2046 # shellcheck disable=SC2046
set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \ set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \
| sort -d | tr "\n" " ") | sort -d | tr "\n" " ")
fi fi
projects_seen="" projects_seen=""

View File

@ -9,7 +9,7 @@ set -eu
usage(){ usage(){
names="$(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \ names="$(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \
| sort -d | tr "\n" " ")" | sort -d | tr "\n" " ")"
echo "Usage: ${0##*/} <NAME> <KEY>" echo "Usage: ${0##*/} <NAME> <KEY>"
echo "Example: ${0##*/} qubes-builder description" echo "Example: ${0##*/} qubes-builder description"
echo "Names: ${names}" echo "Names: ${names}"
@ -105,9 +105,10 @@ if test "${key}" = "description"; then
fi fi
if test "${key}" = "summary"; then if test "${key}" = "summary"; then
summary="$(sed -n "/^# ${name}$/,/^## Table of Contents$/{ summary="$(sed -n -e \
/./!d; /^#/d; /^SPDX/d; /^<!--/d; /^-->/d; s/\.$//; p}" \ "/^# ${name}$/,/^## Table of Contents$/{
-- "${readme}")" /./!d; /^#/d; /^SPDX/d; /^<!--/d; /^-->/d; s/\.$//; p}" \
-- "${readme}")"
block_max_chars summary "${summary}" 70 block_max_chars summary "${summary}" 70
fi fi

View File

@ -22,7 +22,7 @@ fi
files="$(echo "${files}" | sort -u)" files="$(echo "${files}" | sort -u)"
# shellcheck disable=SC2086 # shellcheck disable=SC2086
unicode_match="$(grep -oPrHn --exclude-dir=.git --exclude-dir=LICENSES \ unicode_match="$(grep -oPrHn --exclude-dir=.git --exclude-dir=LICENSES \
-e "[^\x00-\x7F]" -- ${files} || true)" -e "[^\x00-\x7F]" -- ${files} || true)"
match_found="" match_found=""
if test -n "${unicode_match}"; then if test -n "${unicode_match}"; then