[Chore] Update credo config to support check private vs public functions order #256
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.
What happened 👀
.credo.exs
to support the conventionPrefer placing all private functions at the bottom of the module.
on Compass:Link: https://nimblehq.co/compass/development/code-conventions/elixir/#module
Insight 📝
We need to ignore the check for
ignore: ~w/callback_impl/a
because the generated template Phoenix does not consistently follow this layout, for example:Therefore, we ignored the
callback_impl
to keep the.credo.exs
follow the existing output of the generated Phoenix structure, just support for thepublic
andprivate
method function order verification.Proof Of Work 📹
The tests should pass and the
.credo.exs
output should containpublic_fun private_fun