Skip to content

updated dune_lint #11628

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

Closed
wants to merge 3 commits into from
Closed

updated dune_lint #11628

wants to merge 3 commits into from

Conversation

A-RAKSHITHA
Copy link

No description provided.

Signed-off-by: A-RAKSHITHA <[email protected]>
Signed-off-by: A-RAKSHITHA <[email protected]>
Signed-off-by: A-RAKSHITHA <[email protected]>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think you want to push this file.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think you want to push this file.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think you want to push this file.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think you want to push this file.

Copy link
Collaborator

@maiste maiste left a comment

Choose a reason for hiding this comment

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

Could you elaborate a bit more about the context of this PR and what you are trying to solve?

@A-RAKSHITHA
Copy link
Author

Could you elaborate a bit more about the context of this PR and what you are trying to solve?

This PR improves the developer experience by detecting common typos in dune-project files that are syntactically valid but likely unintended. Examples include using = version instead of :version, or :with_test instead of :with-test. Dune will now emit warnings with suggestions, helping users avoid subtle bugs. Optionally, it could auto-correct or assume the intended meaning. Users can override this behavior if the typo was intentional. This makes dune-project more robust and user-friendly.

@maiste
Copy link
Collaborator

maiste commented Apr 15, 2025

As suggested by @gridbugs in #11561:

@A-RAKSHITHA are you still interested in contributing to this? If so please suggest a conservative subset of this problem you'd like to work on that doesn't overlap with #11575.

My suggestion would be to open an issue, link it to the meta issue and define the scope of the work here first. It would make it easier to draft the solution and make sure it doesn't overlap and go in the right direction: some part of the work has already been done in #11600.

@A-RAKSHITHA
Copy link
Author

As suggested by @gridbugs in #11561:

@A-RAKSHITHA are you still interested in contributing to this? If so please suggest a conservative subset of this problem you'd like to work on that doesn't overlap with #11575.

My suggestion would be to open an issue, link it to the meta issue and define the scope of the work here first. It would make it easier to draft the solution and make sure it doesn't overlap and go in the right direction: some part of the work has already been done in #11600.

I’m still interested in contributing to this, but I’m not sure what the exact next steps are. Could you please guide me through the process, step by step?

I’m not sure where to start, so any advice on how to approach the task, from opening an issue to defining the scope and drafting the solution, would be really helpful.

I just want to make sure I’m going in the right direction and not missing anything important.

@maiste
Copy link
Collaborator

maiste commented Apr 15, 2025

I’m not sure where to start, so any advice on how to approach the task, from opening an issue to defining the scope and drafting the solution, would be really helpful.

What I would recommend you to do is:

  1. Read Detect common typos in metadata and attempt to guess user's intention (or at least print a hint) #11561 thread and check what has already been done.
  2. Answer to this comment
  3. Wait and check for maintainer answer (I would say @gridbugs here as he opened the issue)
  4. Update this PR or open a new one to solve the sub problem that was defined.
  5. Iterate over future comments on the PR until it can be merged.

Hope it provides more details.

@maiste maiste added the wontfix label Apr 15, 2025
@A-RAKSHITHA
Copy link
Author

I’m not sure where to start, so any advice on how to approach the task, from opening an issue to defining the scope and drafting the solution, would be really helpful.

What I would recommend you to do is:

  1. Read Detect common typos in metadata and attempt to guess user's intention (or at least print a hint) #11561 thread and check what has already been done.
  2. Answer to this comment
  3. Wait and check for maintainer answer (I would say @gridbugs here as he opened the issue)
  4. Update this PR or open a new one to solve the sub problem that was defined.
  5. Iterate over future comments on the PR until it can be merged.

Hope it provides more details.

okay thank you!!!

@gridbugs gridbugs marked this pull request as draft April 17, 2025 02:26
@gridbugs
Copy link
Collaborator

Hi @A-RAKSHITHA. If you haven't already, please read my comment here. I don't think there's any more work required for typo detection that isn't already in progress with the possible exception of automatically fixing typos, though that may not be easy.

I'd prefer we work out the details of how you'll contribute to dune on issues or possibly on discord before you raise a PR to maximise the chance of your contribution being accepted. I'm closing this PR, but please feel free to reach out if you think there's missing functionality from the existing typo detection support or any other good first issues you'd like to contribute to.

@gridbugs gridbugs closed this Apr 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants