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 .reek.yml #129

Merged
merged 3 commits into from
Jul 13, 2022
Merged

Add .reek.yml #129

merged 3 commits into from
Jul 13, 2022

Conversation

grodowski
Copy link
Contributor

Starter Reek config file ✨ Let's go through all the warnings from the defaults and check what we might want to override here. The YAML I'm committing now is not finalised!

Once it is finalised, we can configure a pronto-reek Github Action to comment on our PRs. I believe this would make more sense than blocking on pre-push, like we do with Rubocop, because Reek design-oriented warnings may require more effort to fix.

Reek does not support config inheritance, at least until troessner/reek#1512, so I thought we can reuse our config with something like reek -c $(rf-stylez reek-config-path) in the pronto action.

Let's discuss!

Copy link
Member

@jaytennier jaytennier left a comment

Choose a reason for hiding this comment

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

These all look like reasonable defaults to me. I'm honestly not sure about the values for the max statements/methods/ivar settings but I do like the idea of having them enabled so I guess let's go with those and see if they pose an issue. We can always have this as a non-blocking check for the first little bit to get a feel for them.

@grodowski grodowski merged commit 107d892 into master Jul 13, 2022
@marvin-rfbot marvin-rfbot bot deleted the reek-config branch July 13, 2022 07:43
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.

2 participants