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

Generate hlint default configuration #234

Merged
merged 1 commit into from
Apr 25, 2024

Conversation

philderbeast
Copy link
Contributor

See #233. This is the .hlint.yaml configuration generated by hlint --default . > .hlint.yaml with stock comments removed.

Copy link

coderabbitai bot commented Mar 27, 2024

Important

Auto Review Skipped

Auto reviews are limited to the following labels: CodeRabbit. Please add one of these labels to enable auto reviews.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@doyougnu
Copy link
Collaborator

doyougnu commented Apr 6, 2024

I'm not opposed to silencing the warnings, but I do like seeing them because some code should certainly be refactored. Thoughts @gelisam @david-christiansen

@david-christiansen
Copy link
Collaborator

As someone without time to really work on this project, my opinion doesn't matter that much. But here it is: I think hlint is great, but many of its defaults are not so useful. In particular, it pushes for a very point free style, which is harder to work with in practice. If I were active on the project, I'd want to go in and enable the suggestions a few at a time, considering whether they actually help, rather than just turning it all on and believing what it says, but as I said, I'm not active right now!

@gelisam
Copy link
Owner

gelisam commented Apr 21, 2024

See #233.

I was fine with #233 because the Klister project would benefit from more contributors, and applying hlint suggestions seemed like an easy and inoffensive way for someone new to the codebase to get their feet wet without having to spend a long time understanding how everything works. Now that @david-christiansen points out that hlint "pushes for a very point free style", which I agree is "harder to work with in practice", I am not so convinced that #233 is a good idea.

@philderbeast if you want to contribute to the Klister project and you are looking for an easy ticket to start with, may I recommend looking at the good first issue label?

@gelisam gelisam mentioned this pull request Apr 22, 2024
27 tasks
@gelisam
Copy link
Owner

gelisam commented Apr 25, 2024

Merging as per #233 (comment)

@gelisam gelisam merged commit f135035 into gelisam:main Apr 25, 2024
6 checks passed
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.

4 participants