linutil icon indicating copy to clipboard operation
linutil copied to clipboard

Emit all shellcheck errors using github action toolkit annotations and check for tab indentation

Open cartercanedy opened this issue 1 year ago • 3 comments

Tabs are problematic when rendering previews of shell scripts, as it results in a disparity between the position of expected rendered characters and where they may actually be rendered on the screen, and having mixed space/tab indentation in the same file is generally problematic as well.

Type of Change

  • [x] Bug fix
  • [x] Refactoring

Description

  • Emit all errors found within the changed files using gh actions toolkit annotations, before, the workflow would fail on the first shellcheck invocation that had an error emission
  • Add a tab indentation check to enforce consistency in code style
  • removed all current tab indentations that I've found in shell scripts

Testing

Verified using workflow runs within my own repository

Impact

Helps provide complete error information from both shellcheck and tab indentation detection

Checklist

  • [x] My code adheres to the coding and style guidelines of the project.
  • [x] I have performed a self-review of my own code.
  • [x] I have commented my code, particularly in hard-to-understand areas.
  • [x] I have made corresponding changes to the documentation.
  • [x] My changes generate no errors/warnings/merge conflicts.

cartercanedy avatar Sep 23 '24 18:09 cartercanedy

also the browser-setup formatting changes are already implemented in #648 @cartercanedy

ghost avatar Sep 23 '24 18:09 ghost

also the browser-setup formatting changes are already implemented in #648 @cartercanedy

I need those implemented here to pass the new shellcheck ci workflow. You should be able to rebase your changes on top of mine

cartercanedy avatar Sep 23 '24 18:09 cartercanedy

@ChrisTitusTech I'd recommend committing this before pulling in any shell scripts to get better shellcheck errors and catch formatting issues

cartercanedy avatar Sep 28 '24 19:09 cartercanedy