Merge pull request #314 from DannyBen/add/shfmt-compliance

Fix all shfmt offenses

Author: DannyBen

.github/workflows/test.yml

@@ -10,7 +10,8 @@ jobs:
     runs-on: ubuntu-latest
 
     env: 
-      LC_ALL: en_US.UTF-8 # consistent sort order
+      # For consistent sort order
+      LC_ALL: en_US.UTF-8 
 
     strategy:
       matrix: { ruby: ['2.7', '3.0', '3.1', 'head'] }
@@ -19,6 +20,7 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v3
 
+    # libyaml needed for Ruby's YAML library
     - name: Install OS dependencies
       run: sudo apt-get -y install libyaml-dev
 
@@ -31,5 +33,34 @@ jobs:
     - name: Run tests
       run: bundle exec rspec
 
+  static_analysis:
+    name: Static analysis of Example files
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    # Rush needed for easy installation of latest shfmt
+    - name: Install rush
+      run: curl -Ls http://get.dannyb.co/rush/setup | bash
+
+    - name: Install shfmt
+      run: rush snatch dannyben shfmt
+
+    # libyaml needed for Ruby's YAML library
+    - name: Install OS dependencies
+      run: sudo apt-get -y install libyaml-dev
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with: 
+        ruby-version: '3.1'
+        bundler-cache: true
+
     - name: Run shellcheck tests
       run: bundle exec run shellcheck
+
+    - name: Run shfmt tests
+      run: bundle exec run shfmt

README.md

@@ -27,7 +27,6 @@ usually handled by a framework in any other programming language.
 It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
 a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
-
 ## Documentation
 
 - [Bashly Homepage][docs]
@@ -49,6 +48,7 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 Bashly is responsible for:
 
 - Generating a **single, standalone bash script**.
+- Generating a **human readable, shellcheck-compliant and shfmt-compliant script**.
 - Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
@@ -72,15 +72,12 @@ to contribute, feel free to [open an issue][issues] or
 
 Visit the *[How to contribute][contributing]* page for more information.
 
-
 ## Stargazers and Forkers
 
 [![Stargazers repo roster for @DannyBen/bashly](https://reporoster.com/stars/DannyBen/bashly)](https://github.com/DannyBen/bashly/stargazers)
 
 [![Forkers repo roster for @DannyBen/bashly](https://reporoster.com/forks/DannyBen/bashly)](https://github.com/DannyBen/bashly/network/members)
 
-
-
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/

Runfile

@@ -35,14 +35,15 @@ end
 help   "Run shfmt checks on all examples"
 action :shfmt do
   Example.executables.each do |example|
-    if File.exist? example
-      success = system "shfmt -d -i 2 -ci #{example}"
-      color = success ? 'txtgrn' : 'txtred'
-      say "- shfmt !#{color}!#{example}"
-      exit 1 unless success
-    else
-      say "- skip       !txtcyn!#{example}"
+    if example == 'examples/heredoc/cli' || !File.exist?(example)
+      say "- skip  !txtcyn!#{example}"
+      next
     end
+
+    success = system "shfmt -d -i 2 -ci #{example}"
+    color = success ? 'txtgrn' : 'txtred'
+    say "- shfmt !#{color}!#{example}"
+    exit 1 unless success
   end
 end
 

examples/filters/README.md

@@ -59,7 +59,7 @@ commands:
 # Print an error string if docker is not running.
 # The script will automatically exit if this function prints anything.
 filter_docker_running() {
-  docker info > /dev/null 2>&1 || echo "Docker must be running"
+  docker info >/dev/null 2>&1 || echo "Docker must be running"
 }
 
 # This is just a sample filter designed to always fail

examples/filters/src/lib/filters.sh

@@ -6,7 +6,7 @@
 # Print an error string if docker is not running.
 # The script will automatically exit if this function prints anything.
 filter_docker_running() {
-  docker info > /dev/null 2>&1 || echo "Docker must be running"
+  docker info >/dev/null 2>&1 || echo "Docker must be running"
 }
 
 # This is just a sample filter designed to always fail

examples/heredoc-alt/README.md

@@ -40,7 +40,7 @@ echo "$text"
 
 ```bash
 message1() {
-  cat << EOF
+  cat <<EOF
 this is a
   multiline
     heredoc text

examples/heredoc-alt/src/lib/heredocs.sh

@@ -1,5 +1,5 @@
 message1() {
-  cat << EOF
+  cat <<EOF
 this is a
   multiline
     heredoc text

lib/bashly/views/command/command_fallback.gtx

@@ -24,6 +24,7 @@ elsif extensible.is_a? String
   >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
+  >   ;;
   >
 
 elsif extensible
@@ -34,6 +35,7 @@ elsif extensible
   >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
+  >   ;;
   >
 
 else

lib/bashly/views/command/default_assignments.gtx

@@ -2,11 +2,11 @@ if default_args.any? or default_flags.any?
   = view_marker
 
   default_args.each do |arg|
-    > [[ -n ${args[{{ arg.name }}]:-} ]] || args[{{ arg.name }}]="{{ arg.default }}"
+    > [[ -n ${args['{{ arg.name }}']:-} ]] || args['{{ arg.name }}']="{{ arg.default }}"
   end
 
   default_flags.each do |flag|
-    > [[ -n ${args[{{ flag.long }}]:-} ]] || args[{{ flag.long }}]="{{ flag.default }}"
+    > [[ -n ${args['{{ flag.long }}']:-} ]] || args['{{ flag.long }}']="{{ flag.default }}"
   end
 
   >

lib/bashly/views/command/fixed_flags_filter.gtx

@@ -4,14 +4,14 @@
 >   case "${1:-}" in
 
 if root_command?
-  = short_flag_exist?("-v") ? "--version)" : "--version | -v)".indent(4)
+  = (short_flag_exist?("-v") ? "--version)" : "--version | -v)").indent(4)
   >       version_command
   >       exit
   >       ;;
   > 
 end
 
-= short_flag_exist?("-h") ? "--help)" : "--help | -h)".indent(4)
+= (short_flag_exist?("-h") ? "--help)" : "--help | -h)").indent(4)
 >       long_usage=yes
 >       <%= function_name %>_usage
 >       exit