Implement new Style/ExponentialNotation cop #7851
Merged
+368
−0
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
bbatsov
reviewed
Apr 7, 2020
| @@ -0,0 +1,113 @@ | |||
| # frozen_string_literal: true | |||
|
|
|||
| # TODO: when finished, run `rake generate_cops_documentation` to update the docs | |||
There was a problem hiding this comment.
You should remove this line. :-)
bbatsov
reviewed
Apr 7, 2020
| module Cop | ||
| module Style | ||
| # This cop enforces consistency when using exponential notation | ||
| # for numbers in the code (eg 1.2e4). Multiple modes can be selected |
There was a problem hiding this comment.
Multiple modes -> Different style are supported.
That makes it consistent with RuboCop's terminology. I'd also add the explanations of the supported style before the examples - again, for consistency with other cops.
bbatsov
reviewed
Apr 7, 2020
config/default.yml
Outdated
| Style/ExponentialNotation: | ||
| Description: 'When using exponential notation, favor a mantissa between 1 (inclusive) and 10 (exclusive).' | ||
| StyleGuide: '#exponential-notation' | ||
| Reference: 'https://github.com/rubocop-hq/ruby-style-guide/issues/803' |
There was a problem hiding this comment.
That's normally used for links to resources like wikipedia, blog posts, etc.
tdeo
force-pushed
the
td/exponential_notation
branch
from
4a60b22
to
8234573
Compare
|
Thanks for the review, I just amended the commit and pushed the branch |
tdeo
force-pushed
the
td/exponential_notation
branch
2 times, most recently
from
d9e4bba
to
98d9ae0
Compare
bbatsov
reviewed
Apr 10, 2020
CHANGELOG.md
Outdated
| @@ -30,6 +30,7 @@ | |||
| * [#7816](https://github.com/rubocop-hq/rubocop/pull/7816): Support Ruby 2.7's numbered parameter for `Style/Lambda`. ([@koic][]) | |||
| * [#7829](https://github.com/rubocop-hq/rubocop/issues/7829): Fix an error for `Style/OneLineConditional` when one of the branches contains `next` keyword. ([@koic][]) | |||
| * [#7384](https://github.com/rubocop-hq/rubocop/pull/7384): Add new `Style/DisableCopsWithinSourceCodeDirective` cop. ([@egze][]) | |||
| * Add a new `Style/ExponentialNotation` cop. ([@tdeo][]) | |||
There was a problem hiding this comment.
Btw, you should move this to master, as 0.81 was already released.
tdeo
force-pushed
the
td/exponential_notation
branch
from
98d9ae0
to
3226f12
Compare
This cop implements the rule describe in the "exponential notation" section of the ruby style guide. It allows for an additional style not mentionned in the guide, `integral` which allows only integer mantissa, without any trailing zero.
tdeo
force-pushed
the
td/exponential_notation
branch
from
3226f12
to
da236d5
Compare
|
Amended and rebased again :) |
|
Victory! 🎉 Thanks for working on this! 🙇♂️ |
|
Thanks 🎉 |
koic
added a commit
to koic/rubocop
that referenced
this pull request
Apr 13, 2020
Follow rubocop#7384, rubocop#7857, and rubocop#7869. This PR fixes the next release version with 0.82 because RuboCop 0.81 has been released. This version (0.82) is based on rubocop#7851.
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.
This cop implements the rule describe in the "exponential notation"
section of the ruby style guide.
It allows for an additional style not mentionned in the guide,
integralwhich allows only integer mantissa, without anytrailing zero.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.