Fix linting issues

.editorconfig

@@ -1,3 +1,9 @@
 [*.sh]
 indent_style = space
 indent_size = 4
+
+[spec/**]
+ignore = true
+
+[.tox/**]
+ignore = true

.github/actions/vagrant-setup/action.yml

@@ -8,6 +8,7 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 name: Vagrant setup
+description: Configures the Vagrant requirements
 inputs:
   distro:
     description: Linux distribution

.github/actions/vagrant-up/action.yml

@@ -8,6 +8,7 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 name: Vagrant up
+description: Creates a Vagrant Virtual Machine
 inputs:
   memory:
     description: "Memory"

.github/workflows/diagram.yml

@@ -15,6 +15,7 @@ on:
       - codebase-structure.svg
       - .github/
   workflow_dispatch:
+permissions: read-all
 jobs:
   check-diagram:
     name: Update the codebase structure diagram

.github/workflows/distros.yml

@@ -13,6 +13,7 @@ on:
   schedule:
     - cron: "0 0 1 * *"
   workflow_dispatch:
+permissions: read-all
 jobs:
   check-versions:
     runs-on: vm-self-hosted

.github/workflows/lint.yml

@@ -12,6 +12,7 @@ name: Lint Code Base
 on:
   push:
   pull_request:
+permissions: read-all
 jobs:
   get-sloc:
     name: Count Lines of Code
@@ -43,6 +44,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           LINTER_RULES_PATH: /
+          VALIDATE_SHELL_SHFMT: false
+          EDITORCONFIG_FILE_NAME: .editorconfig
   check-tox:
     name: Check syntax (tox)
     runs-on: ubuntu-latest

.github/workflows/on-demand_ci.yml

@@ -18,6 +18,7 @@ on:
     types:
       - submitted
   workflow_dispatch:
+permissions: read-all
 jobs:
   changes:
     runs-on: ubuntu-latest

.github/workflows/rebase.yml

@@ -12,6 +12,7 @@ name: Automatic Rebase
 on:
   issue_comment:
     types: [created]
+permissions: read-all
 jobs:
   rebase:
     name: Rebase

.github/workflows/scheduled_ci.yml

@@ -13,6 +13,7 @@ on:
   schedule:
     - cron: "0 0 * * 5"
   workflow_dispatch:
+permissions: read-all
 jobs:
   check-ubuntu-jammy-baremetal:
     runs-on: ubuntu-22.04

.github/workflows/spell.yml

@@ -17,6 +17,7 @@ on:
   pull_request_review:
     types:
       - submitted
+permissions: read-all
 jobs:
   check-reviewdog:
     name: Check spelling (reviewdog)

.github/workflows/update.yml

@@ -13,6 +13,7 @@ on:
   schedule:
     - cron: "0 0 * * 5"
   workflow_dispatch:
+permissions: read-all
 jobs:
   check-versions:
     runs-on: ubuntu-latest

Makefile

@@ -14,7 +14,9 @@ lint:
 	sudo -E $(DOCKER_CMD) run --rm -v $$(pwd):/tmp/lint \
 	-e RUN_LOCAL=true \
 	-e LINTER_RULES_PATH=/ \
-	github/super-linter
+	-e VALIDATE_SHELL_SHFMT=false \
+	-e EDITORCONFIG_FILE_NAME=.editorconfig \
+	ghcr.io/super-linter/super-linter
 	tox -e lint
 
 .PHONY: fmt

README.md

@@ -61,7 +61,7 @@ coding, documenting, testing, spreading the word at events within others.
 Thanks to all the people who already contributed!
 
 <a href="https://github.com/electrocucaracha/bootstrap-vagrant/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=electrocucaracha/bootstrap-vagrant" />
+  <img src="https://contrib.rocks/image?repo=electrocucaracha/bootstrap-vagrant" alt="Contributors" />
 </a>
 
 ![Visualization of the codebase](./codebase-structure.svg)

ci/update_distros.sh

@@ -58,11 +58,13 @@ function _vagrant_pull {
         msg+="$name($version, $PROVIDER) box doesn't exist\n"
         return
     fi
+    # editorconfig-checker-disable
     cat <<EOT >>.distros_supported.yml
   - alias: $alias
     name: $name
     version: "$version"
 EOT
+    # editorconfig-checker-enable
 }
 
 if ! command -v vagrant >/dev/null; then

spec/setup_spec.sh

@@ -9,33 +9,33 @@
 ##############################################################################
 
 Describe 'setup.sh'
-Include setup.sh
+    Include setup.sh
 
-Describe '_vercmp()'
-Parameters
-'1.1.1' '==' '1.1.1' success
-'1.1.1' '==' '1.1.0' failure
-'1.1.0' '<' '1.1.1' success
-'1.1.1' '<' '1.1.0' failure
-'1.1.1' '<' '1.1.1' failure
-'1.1.1' '<=' '1.1.1' success
-'1.1.0' '<=' '1.1.1' success
-'1.1.1' '<=' '1.1.0' failure
-'1.1.1' '>' '1.1.0' success
-'1.1.0' '>' '1.1.1' failure
-'1.1.1' '>' '1.1.1' failure
-'1.1.1' '>=' '1.1.0' success
-'1.1.1' '>=' '1.1.1' success
-'1.1.0' '>=' '1.1.1' failure
-End
-It 'performs comparation'
-When call _vercmp "$1" "$2" "$3"
-The status should be "$4"
-End
-It 'raises error when specified an invalid operator'
-When run _vercmp '1.0.0' '!=' '2.0.0'
-The stdout should equal "unrecognised op: !="
-The status should be failure
-End
-End
+    Describe '_vercmp()'
+        Parameters
+            '1.1.1' '==' '1.1.1' success
+            '1.1.1' '==' '1.1.0' failure
+            '1.1.0' '<' '1.1.1' success
+            '1.1.1' '<' '1.1.0' failure
+            '1.1.1' '<' '1.1.1' failure
+            '1.1.1' '<=' '1.1.1' success
+            '1.1.0' '<=' '1.1.1' success
+            '1.1.1' '<=' '1.1.0' failure
+            '1.1.1' '>' '1.1.0' success
+            '1.1.0' '>' '1.1.1' failure
+            '1.1.1' '>' '1.1.1' failure
+            '1.1.1' '>=' '1.1.0' success
+            '1.1.1' '>=' '1.1.1' success
+            '1.1.0' '>=' '1.1.1' failure
+        End
+        It 'performs comparation'
+            When call _vercmp "$1" "$2" "$3"
+            The status should be "$4"
+        End
+        It 'raises error when specified an invalid operator'
+            When run _vercmp '1.0.0' '!=' '2.0.0'
+            The stdout should equal "unrecognised op: !="
+            The status should be failure
+        End
+    End
 End

validate.sh

@@ -83,6 +83,7 @@ export VAGRANT_DEFAULT_PROVIDER
 
 info "Validating Vagrant operation"
 pushd "$(mktemp -d)"
+# editorconfig-checker-disable
 cat <<EOT >vagrant_file.erb
 Vagrant.configure("2") do |config|
   config.vm.box = "<%= box_name %>"
@@ -95,6 +96,7 @@ Vagrant.configure("2") do |config|
   end
 end
 EOT
+# editorconfig-checker-enable
 vagrant init generic/alpine316 --box-version 3.5.0 --template vagrant_file.erb
 vagrant up || :
 vagrant halt