cisagov / skeleton-generic

A generic skeleton project for quickly getting a new cisagov project started.
Creative Commons Zero v1.0 Universal
14 stars 11 forks source link

Switch the pre-commit hook used to run `shellcheck` #168

Closed mcdonnnj closed 6 months ago

mcdonnnj commented 6 months ago

๐Ÿ—ฃ Description

This pull request switches the pre-commit hook used to run shellcheck from detailyang/pre-commit-shell to shellcheck-py/shellcheck-py.

๐Ÿ’ญ Motivation and context

The new hook actually bundles the binary releases from shellcheck into a Python package that is used for the hook. This will ensure that we are always using the same version of shellcheck when linting since individual distributions and the GitHub Actions runners may update at different times..

๐Ÿงช Testing

Automated tests pass. I had @dav3r confirm that the hook works on his ARM Mac (shellcheck has limited binaries available for macOS).

โœ… Pre-approval checklist

jsf9k commented 6 months ago

I done tried it and it done worked on my dang machine! :shipit:

I think that should be "dang ol' machine". :laughing:

dav3r commented 6 months ago

I done tried it and it done worked on my dang machine! :shipit:

I think that should be "dang ol' machine". ๐Ÿ˜†

I had "ole" in there originally, but it didn't (dun) look right. Definitely should've gone with "ol'" - missed opportunity.