Rewrite scripts in Ruby with strict linting#938
Draft
leighmcculloch wants to merge 1 commit into
Draft
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Port the five helper scripts in
.scripts/from a mix of Python and Bash to Ruby, and add a RuboCop setup that enforces a deliberately plain, predictable dialect of the language. The lint configuration requires parentheses on method calls and bansunlessand trailing modifierif/unlessthrough two custom cops, while disabling the cops that would otherwise push code back toward those forms. Linting runs inside a Ruby container via a newmake linttarget and a CI job, so neither contributors nor the runners need Ruby installed locally.Why
After some comments from fnando I wanted to see whether these scripts would be easier to maintain as Ruby than as Python. Because Ruby readily invites idioms that readers unfamiliar with the language find surprising, the RuboCop rules are tuned to forbid those constructs up front rather than relying on review to catch them, keeping the scripts approachable for anyone maintaining the image build pipeline. Running the linter through Docker keeps the toolchain consistent between local development and CI without adding a Ruby installation step to either.