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

Lint the code with clj-kondo #190

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

pbalduino
Copy link

Hi @weavejester

It's basically a cosmetic PR where I used clj-kondo on the source code before sending a feature PR that will follow soon.

clj-kondo uses Batsov's Clojure Style Guide, as defined in CONTRIBUTING guidelines.

Thank you very much, and also all the collaborators, for such awesome tool.

@weavejester
Copy link
Owner

Thanks for the PR. Tools like clj-kondo are good for linting the codebase, but their recommendations shouldn't be applied blindly, as they can be opinionated or even incorrect.

The if/when changes aren't part of the style guide, so should be removed.

The changes to the multimethod arguments are technically part of the style guide, but in this context I think it's better to use full names in order to document the multimethod's expected arguments.

The :use to :refer change is good, but I think a better change would be to use :require :as instead.

Finally, the removal of the mkdirs function should be moved into another commit, as it's not a styling change.

@pbalduino
Copy link
Author

pbalduino commented Jan 4, 2020

The if/when changes aren't part of the style guide, so should be removed.

You're right. 🤔

The changes to the multimethod arguments are technically part of the style guide, but in this context I think it's better to use full names in order to document the multimethod's expected arguments.

I agree. When I removed the parameters I realized the clarity was gone.

Finally, the removal of the mkdirs function should be moved into another commit, as it's not a styling change.

Right.

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.

None yet

2 participants