Skip to content

Commit

Permalink
fix: conform files to editorconfig specification
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-grande committed Jul 8, 2024
1 parent 89a4ea8 commit 523bca2
Show file tree
Hide file tree
Showing 18 changed files with 49 additions and 36 deletions.
4 changes: 0 additions & 4 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,13 @@ jobs:
- name: Install pip packages
run: pip3 install $(cat dependencies/pip.txt)
- uses: pre-commit/[email protected]
continue-on-error: true
env:
SPEC_VENDOR: Github Actions
SPEC_PACKAGER: Github Actions
- uses: editorconfig-checker/action-editorconfig-checker@main
- name: Run Editorconfig Checker
continue-on-error: true
run: editorconfig-checker
- name: Lint commits
continue-on-error: true
# yamllint disable-line rule:line-length
run: |
if test "${{ github.event_name}}" = "pull_request"
then
Expand Down
6 changes: 3 additions & 3 deletions docs/SALT.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ name: keys
force: True
{# Only run this state if the requirements are executed successfully #}
require:
{# Ensure successful 'qvm.clone' run to create 'tpl-keys-clone'
This module was executed in the 'clone_template' macro #}
{# Ensure successful 'qvm.clone' run to create 'tpl-keys-clone' #}
{# This module was executed in the 'clone_template' macro #}
- qvm: tpl-keys-clone
{# If qube does not exist, create it with the specified settings #}
present:
Expand Down Expand Up @@ -157,7 +157,7 @@ features:
- service.cups
{# Set feature values, useful for string values #}
- 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"
{# Stop loading to the 'defaults' variable #}
{% endload %}
Expand Down
3 changes: 3 additions & 0 deletions rpm_spec/qusal-dev.spec
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.

%changelog
* Mon Jul 08 2024 Ben Grande <[email protected]> - f60077f
- doc: spell check

* Fri Jul 05 2024 Ben Grande <[email protected]> - 34d2943
- fix: correct markdown lint package name

Expand Down
3 changes: 3 additions & 0 deletions rpm_spec/qusal-dotfiles.spec
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.

%changelog
* Mon Jul 08 2024 Ben Grande <[email protected]> - f60077f
- doc: spell check

* Thu Jul 04 2024 Ben Grande <[email protected]> - 383c840
- doc: lint markdown files

Expand Down
3 changes: 3 additions & 0 deletions rpm_spec/qusal-electrum.spec
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.

%changelog
* Mon Jul 08 2024 Ben Grande <[email protected]> - f60077f
- doc: spell check

* Thu Jul 04 2024 Ben Grande <[email protected]> - 383c840
- doc: lint markdown files

Expand Down
4 changes: 2 additions & 2 deletions rpm_spec/qusal-fetcher.spec
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ will be able to download from many protocol as long as the installed tools
accepts them.

Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS,
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.

%prep
%setup -q
Expand Down
6 changes: 3 additions & 3 deletions rpm_spec/qusal-sys-cacher.spec
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.

%changelog
* Mon Jul 08 2024 Ben Grande <[email protected]> - f60077f
- doc: spell check

* Sat Jul 06 2024 Ben Grande <[email protected]> - 8604887
- feat: unify cacher tag list to a single script

Expand Down Expand Up @@ -276,6 +279,3 @@ fi

* Wed Dec 20 2023 Ben Grande <[email protected]> - 38d98ec
- fix: nft shebang and table names

* Wed Dec 20 2023 Ben Grande <[email protected]> - d3ae662
- fix: cacher client installation indentation
3 changes: 3 additions & 0 deletions rpm_spec/qusal-sys-ssh-agent.spec
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ fi
%dnl TODO: missing '%ghost', files generated during %post, such as Qrexec policies.

%changelog
* Mon Jul 08 2024 Ben Grande <[email protected]> - f60077f
- doc: spell check

* Thu Jul 04 2024 Ben Grande <[email protected]> - 383c840
- doc: lint markdown files

Expand Down
7 changes: 3 additions & 4 deletions salt/dom0/files/bin/qvm-mgmt
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ usage(){

get_qube_feat(){
qube="${1}"
qvm-features "${qube}" \
| grep -e os-distribution -e os-version -e template-release \
-e template-release -e template-name \
| tr -s " " | sed "s/ /: /;s/^/ /"
qvm-features "${qube}" | \
grep -E "^(os-(distribution|version)|template-(release|name))" | \
sed "s/ / /g;s/ /: /;s/^/ /"
}

case "${1-}" in
Expand Down
6 changes: 3 additions & 3 deletions salt/dom0/files/bin/qvm-port-forward
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ forward() {
unset dev
## TODO: Handle multiple interfaces in upstream.
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}"
dev="${untrusted_dev}"

unset from_ip
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}"
from_ip="${untrusted_from_ip}"

Expand Down Expand Up @@ -220,7 +220,7 @@ get_lan(){
unset dev
## TODO: Handle multiple interfaces in upstream.
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}"
dev="${untrusted_dev}"

Expand Down
6 changes: 4 additions & 2 deletions salt/dom0/files/bin/qvm-screenshot
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ take_screenshot() {
}

print_help(){
# editorconfig-checker-disable
echo "Usage: ${0##*/} [OPTIONS]
-h, --help print this help message and exit
Capture mode:
Expand All @@ -57,6 +58,7 @@ Development mode:
-D, --dialog-cmd dialog tool: kdialog, zenity
-S, --screenshot-cmd screenshot tool: maim, scrot, spectacle,
xfce4-screenshooter"
# editorconfig-checker-enable
exit 1
}

Expand Down Expand Up @@ -271,8 +273,8 @@ if test "${exit_required}" = "1"; then
fi

qube_list="$(qvm-ls --no-spinner --raw-data --fields=NAME,CLASS | \
awk -F "|" '$1 !~ /(^dvm-|-dvm$)/ &&
$2 !~ /^(AdminVM|TemplateVM)$/{print $1}')"
awk -F "|" '$1 !~ /(^dvm-|-dvm$)/ &&
$2 !~ /^(AdminVM|TemplateVM)$/{print $1}')"

if test -z "${qube}"; then
dialog_title="Select destination qube (Unix based):"
Expand Down
4 changes: 2 additions & 2 deletions salt/fetcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ will be able to download from many protocol as long as the installed tools
accepts them.

Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS,
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.
IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP,
SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS, WSS, RSYNC, BitTorrent.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion salt/signal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Install Signal Desktop and creates an app qube named "signal".

```sh
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 state.apply signal.appmenus
```
Expand Down
13 changes: 8 additions & 5 deletions scripts/shell-lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,16 @@ case "${find_tool}" in
;;
find)
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
sh_files="$(find salt/ -type f -name "rc.local")"
;;
esac

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}
echo "${files}" | sort -u | tr " " "\n"
exit

#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}
2 changes: 1 addition & 1 deletion scripts/spec-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ spec_get="./scripts/spec-get.sh"
if test -z "${1-}"; then
# shellcheck disable=SC2046
set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \
| sort -d | tr "\n" " ")
| sort -d | tr "\n" " ")
fi
counter=0
for p in "$@"; do
Expand Down
2 changes: 1 addition & 1 deletion scripts/spec-gen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ fi
if echo "${@}" | grep -qE "(^scripts/| scripts/|/template.spec)" || test -z "${1-}"; then
# shellcheck disable=SC2046
set -- $(find salt/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' \
| sort -d | tr "\n" " ")
| sort -d | tr "\n" " ")
fi

projects_seen=""
Expand Down
9 changes: 5 additions & 4 deletions scripts/spec-get.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ set -eu

usage(){
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 "Example: ${0##*/} qubes-builder description"
echo "Names: ${names}"
Expand Down Expand Up @@ -105,9 +105,10 @@ if test "${key}" = "description"; then
fi

if test "${key}" = "summary"; then
summary="$(sed -n "/^# ${name}$/,/^## Table of Contents$/{
/./!d; /^#/d; /^SPDX/d; /^<!--/d; /^-->/d; s/\.$//; p}" \
-- "${readme}")"
summary="$(sed -n -e \
"/^# ${name}$/,/^## Table of Contents$/{
/./!d; /^#/d; /^SPDX/d; /^<!--/d; /^-->/d; s/\.$//; p}" \
-- "${readme}")"
block_max_chars summary "${summary}" 70
fi

Expand Down
2 changes: 1 addition & 1 deletion scripts/unicode-prohibit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ fi
files="$(echo "${files}" | sort -u)"
# shellcheck disable=SC2086
unicode_match="$(grep -oPrHn --exclude-dir=.git --exclude-dir=LICENSES \
-e "[^\x00-\x7F]" -- ${files} || true)"
-e "[^\x00-\x7F]" -- ${files} || true)"

match_found=""
if test -n "${unicode_match}"; then
Expand Down

0 comments on commit 523bca2

Please sign in to comment.