Page MenuHomePhabricator

[docs] Add ShellCheck installation instructions
ClosedPublic

Authored by abosh on Aug 8 2022, 9:32 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Apr 13, 11:25 AM
Unknown Object (File)
Sat, Apr 13, 11:25 AM
Unknown Object (File)
Sat, Apr 13, 11:25 AM
Unknown Object (File)
Sat, Apr 13, 5:26 AM
Unknown Object (File)
Sat, Apr 6, 4:30 AM
Unknown Object (File)
Fri, Apr 5, 9:27 PM
Unknown Object (File)
Thu, Apr 4, 12:33 AM
Unknown Object (File)
Mar 28 2024, 2:30 PM
Subscribers

Details

Summary

Related Linear issue here. This diff ensures developers install ShellCheck into their dev environments so that it can run with lint-staged on to-be-committed *.sh files.

D4772 adds the rule to lint all to-be-committed *.sh files.

Test Plan

Tested brew install shellcheck && brew upgrade shellcheck locally on Apple silicon Macbook. On Apple silicon, running which shellcheck should point to /opt/homebrew/bin/shellcheck.

Additionally, created a commit with a problematic *.sh file (after incorporating the changes in D4772) and lint-staged/shellcheck caught the error.

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

abosh edited the test plan for this revision. (Show Details)
abosh edited the summary of this revision. (Show Details)
abosh edited the test plan for this revision. (Show Details)
abosh edited the test plan for this revision. (Show Details)
atul requested changes to this revision.Aug 8 2022, 10:49 AM
atul added inline comments.
docs/dev_environment.md
337–343 ↗(On Diff #15425)

Can we move this closer to the rest of the brew install commands?

This revision now requires changes to proceed.Aug 8 2022, 10:49 AM

Sure, that makes sense. Moved ShellCheck instructions up to the top of the Prerequisites section under Rust and above Yarn (to keep it "alphabetized"?). It's such a small command I doubt it should be an issue, but open to thoughts about where to place it in the doc.

atul added 2 blocking reviewer(s): varun, ashoat.
This revision is now accepted and ready to land.Aug 8 2022, 5:49 PM