jackfirth / jackfirth/resyntax
Rethink the fix limit flag
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Resyntax allows limiting the number of fixes it will apply via a --max-fixes flag. When used with the Autofixer, this can result in confusion because Resyntax will leave files in a partially fixed state. It can be difficult to tell if a fix was skipped because Resyntax couldn't refactor it, because Resyntax hit the fix limit, or some other reason.
This ought to be redesigned so that Autofixer pull requests are clearer. Ideally, Resyntax would either fully fix files or not fix them at all, or it would fully fix a very clear chunk of the file in the case of large files. The modified line limit interacts with this too and makes things more complicated. Further thought required.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the --max-fixes and modified line limit handling in the Autofixer. Clarify whether file-level or chunk-level atomicity is intended, and distinguish skipped fixes from limit-related skips in the resulting pull request; done when the redesign resolves the stated ambiguity.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100