Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add style guide references #1225

Merged
merged 2 commits into from
Jan 13, 2022
Merged

Add style guide references #1225

merged 2 commits into from
Jan 13, 2022

Conversation

pirj
Copy link
Member

@pirj pirj commented Jan 4, 2022

partially addresses fixes #1101. I believe #1101 raised the bar too high, and this PR is sufficient to a desired state.

☣️ ⚠️ This will affect the list of cops that RuboCop will run with --only-guide-cops option.


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • [-] Updated documentation.
  • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@pirj pirj self-assigned this Jan 4, 2022
@pirj pirj force-pushed the 1101-align-with-style-guide branch 2 times, most recently from 29d7fc6 to 45359c3 Compare January 4, 2022 21:43
@pirj pirj force-pushed the 1101-align-with-style-guide branch from 45359c3 to 0e81581 Compare January 4, 2022 21:47
config/default.yml Show resolved Hide resolved
@pirj pirj force-pushed the 1101-align-with-style-guide branch from 0e81581 to a26e98f Compare January 5, 2022 16:15

RSpec/AnyInstance:
Description: Check that instances are not being stubbed globally.
Enabled: true
VersionAdded: '1.4'
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AnyInstance
StyleGuide: "#any_instance_of"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could only find 23 cops that enforce style guide guidelines.

@pirj
Copy link
Member Author

pirj commented Jan 5, 2022

Green 🍏

@pirj
Copy link
Member Author

pirj commented Jan 11, 2022

@bquorning @Darhazer WDYT?

Copy link
Collaborator

@bquorning bquorning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with me. @Darhazer ?

@pirj pirj force-pushed the 1101-align-with-style-guide branch from a26e98f to 7b4fcfe Compare January 11, 2022 22:15
@@ -104,6 +104,7 @@ end

=== References

* https://rubystyle.guide#any_instance_of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are generated with the wrong domain

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see other extensions are not using short links: https://github.com/rubocop/rubocop-rails/blob/0a902551d34f192ea3b24d7bdbbc90349d1eb9ef/config/default.yml#L63. Let me fix it real quick.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thanks for noticing 👍

@pirj pirj force-pushed the 1101-align-with-style-guide branch from bf4ebd5 to f51d12c Compare January 12, 2022 19:31
@pirj pirj force-pushed the 1101-align-with-style-guide branch from f51d12c to 0e7beb6 Compare January 12, 2022 19:35
@pirj pirj requested a review from Darhazer January 12, 2022 20:17
@pirj pirj merged commit 9192504 into master Jan 13, 2022
@pirj pirj deleted the 1101-align-with-style-guide branch January 13, 2022 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

StyleGuide config
3 participants