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 `shfmt` #160

Closed mcdonnnj closed 6 months ago

mcdonnnj commented 8 months ago

๐Ÿ—ฃ Description

This pull request switches the pre-commit hook used to run shfmt from cisagov/pre-commit-shfmt to scop/pre-commit-shfmt. It also updates the arguments to shfmt to use the long options that are now available.

๐Ÿ’ญ Motivation and context

The new hook actually bundles the binary releases from shfmt into a Python package that is used for the hook. This removes the need to have the shfmt tool installed before you are able to use the hook.

๐Ÿงช Testing

Automated tests pass.

โœ… Pre-approval checklist

โœ… Post-merge checklist

mcdonnnj commented 8 months ago

Excellent! ๐Ÿ‘

Does this mean that we can now make https://github.com/cisagov/pre-commit-shfmt a public archive?

Yes that's the plan once this is merged.

dav3r commented 8 months ago

Excellent! ๐Ÿ‘ Does this mean that we can now make https://github.com/cisagov/pre-commit-shfmt a public archive?

Yes that's the plan once this is merged.

Great! You should add that as a post-merge checklist item so that we don't forget about it.