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

StyleGuide config #1101

Closed
3 of 6 tasks
pirj opened this issue Nov 27, 2020 · 0 comments · Fixed by #1225
Closed
3 of 6 tasks

StyleGuide config #1101

pirj opened this issue Nov 27, 2020 · 0 comments · Fixed by #1225

Comments

@pirj
Copy link
Member

pirj commented Nov 27, 2020

Problem

We use the StyleGuide in the config/default.yml to point to our cop's docs, e.g. https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Be, while there's no corresponding guideline.

It's our primary project goal to:

Enforce the guidelines and best practices outlined in the community RSpec style guide

There's a StyleGuideBaseURL setting:

RSpec:
  StyleGuideBaseURL: https://rspec.rubystyle.guide

and to have an anchor to the guide:

RSpec/HookArgument:
  StyleGuide: '#ambiguous-hook-scope'

RuboCop has an undocumented --only-guide-cops option that skips petty tyrant cops not supported by a style guide entry.

I believe that some of our cops try to enforce several guidelines at once.

Proposed solution

  • adjust bin/build_config to stop overwriting references to the community RSpec style guide with our cop docs
  • adjust our style guide links
  • remove links that point to our own docs

Bonus points:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant