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

Decompose config/default.yml #8

Closed
jgarber623 opened this issue Jan 8, 2024 · 0 comments · Fixed by #9
Closed

Decompose config/default.yml #8

jgarber623 opened this issue Jan 8, 2024 · 0 comments · Fixed by #9
Assignees
Labels
enhancement New feature or request

Comments

@jgarber623
Copy link
Contributor

Similar to rubocop-airbnb's config folder, we could/should/will break out this gem's rules into discrete namespace-specific configuration files. Doing so will prevent config/default.yml from growing unmanageable as we add more gems and custom configuration (e.g. rubocop-rails, rubocop-rspec). config/default.yml should serve as a clown car of sorts and inherit from all of the namespace-specific configuration files.

A recommended layout (within ./config):

  • default.yml (the whole thing)
  • rubocop.yml (inherits all namespaced files configureable in RuboCop)
  • rubocop-layout.yml (Layout/* rules from the rubocop gem)
  • rubocop-performance.yml (Performance/* rules from the rubocop-performance gem)
  • etc. etc. etc.

As a secondary bonus, this configuration change will also allow consumers to pick-and-choose configuration files within their projects. Documentation should be updated to reflect this capability while also strongly encouraging the existing preferred usage (inherit the whole thing and go about your day).

@jgarber623 jgarber623 added the enhancement New feature or request label Jan 8, 2024
@jgarber623 jgarber623 self-assigned this Jan 8, 2024
jgarber623 added a commit that referenced this issue Jan 8, 2024
This commit decomposes the default configuration file into namespace-
specific configuration files as recommended in #8.

For each namespace (in RuboCop proper) and each gem (e.g. rubocop-rake),
there's a new YML file configuring that namespace/gem.
jgarber623 added a commit that referenced this issue Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant