Add make targets for shellcheck, rustfmt, and a "test everything before I push"

[davidMcneil]

It would be nice to have make targets that run test/shellcheck.sh, support/ci/rustfmt.sh, and one to test several things that are tested in the CI build. This would be useful to run before submitting a PR. The list of things to test could include things such as:

• rustfmt
• clippy
• shellcheck
• tests

[baumanj]

I think this is a great idea!

Some things to keep in mind for implementing this:

rustfmt should be fairly straightforward. The main complication would be making sure it's running with the rust toolchain specified in RUSFMT_VERSION.

clippy for local runs needs to consider rust-lang/rust-clippy#2604, or else there will likely be false negatives due to the fact that code has already been built locally.

shellcheck can be run well locally, but the current script is oriented towards finding all potential shell files to check rather that running quickly. We could look into hybrid approaches, but I'd be careful that we don't make changes that would require newly added shell files to be manually added to a list to receive checking.

For rustfmt and shellcheck, I think the best approach is to have editor integration to run them while files are edited. Looking into pre-commit hooks may also be useful.

The las thing I'd say is that if we do this work, it would be particularly nice if we can provide a common interface for both linux and windows platforms. A lot of these sort of tasks have been codified in our Makefile, but that leaves out windows.

[dmccown]

@mwrock Thoughts on a way to get our Makefile to work across Windows and Linux?

[baumanj]

I think we'd be better served by looking into writing cargo extension commands to do these tasks. Then we can implement them in rust and they're inherently cross-platform.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.