Fbuys/207 rubocop and standardrb #208
Closed
Conversation
This file contains 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
fbuys
force-pushed
the
fbuys/207-rubocop-and-standardrb
branch
4 times, most recently
from
e3a31e9 to
71977fe
Compare
Includes - CI github workflow - Rubocop and Standard ruby gems - Rubocop config To automate linting and code standards. RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter. Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide. StandardRB is built on top of RuboCop with some specific configurations for RuboCop's cops. Further reading: - https://docs.rubocop.org/rubocop/1.18/index.html - https://rubystyle.guide/ - https://github.com/testdouble/standard - https://github.com/testdouble/standard/blob/main/config/base.yml
fbuys
force-pushed
the
fbuys/207-rubocop-and-standardrb
branch
from
7287f5d to
c029a5b
Compare
So we can ignore the non-safe linting errors for now. We can open additional issues to fix the remaining linting issues. CI will use the todo file and therefore not fail while we have time to fix the remaining linting issues. IDE integration should still report on all the errors until we fix them.
fbuys
force-pushed
the
fbuys/207-rubocop-and-standardrb
branch
2 times, most recently
from
561e89d to
fa11ae9
Compare
To autocorrect all safe linting errors. The remaining errors are in the todo file so we can look at it in the future.
fbuys
force-pushed
the
fbuys/207-rubocop-and-standardrb
branch
from
fa11ae9 to
014eb17
Compare
fbuys
commented
Oct 6, 2021
| ruby-version: '2.7' | ||
| - run: gem install rubocop bundler | ||
| - run: bundle install | ||
| - run: bundle exec rubocop -c .rubocop_with_todo.yml |
There was a problem hiding this comment.
🥦 CI uses todo config so it excludes unsafe linting errors.
| @@ -0,0 +1,439 @@ | |||
| # This configuration was generated by | |||
There was a problem hiding this comment.
🥦 File contains the list of cops that we need to fix when we have time
| $ t display | ||
|
|
||
| Submit bugs and feature requests to http://github.com/samg/timetrap/issues | ||
| USAGE = <<~EOF |
There was a problem hiding this comment.
🥦 ~ removes the padding
fbuys
force-pushed
the
fbuys/207-rubocop-and-standardrb
branch
from
cf40efb to
1e87883
Compare
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.
Description
Includes
To automate linting and code standards.
RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter.
Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide.
StandardRB is built on top of RuboCop with some specific configurations for RuboCop's cops.
Further reading:
A
todoconfig file was added so we can ignore the non-safe linting errors for now.We can open additional issues to fix the remaining linting issues.
CI will use the todo file and therefore not fail while we have time to
fix the remaining linting issues.
IDE integration should still report on all the errors until we fix them.
Motivation and Context
Closes: #207
This change makes it easy for all contributors to maintain the same coding standard.
This should make contributing easier too.
How Has This Been Tested?
I have added a CI workflow and if the CI workflow passes then it means we have adhered to the required linting standard.
Screenshots (if appropriate):
Types of changes
Checklist: