added "formatter" to all functions that produce text edits directly - #2872
Open
jurgenvinju wants to merge 1 commit into
Open
added "formatter" to all functions that produce text edits directly#2872jurgenvinju wants to merge 1 commit into
jurgenvinju wants to merge 1 commit into
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2872 +/- ##
=======================================
Coverage 45% 45%
- Complexity 6788 6799 +11
=======================================
Files 844 844
Lines 68785 68785
Branches 10023 10023
=======================================
+ Hits 31329 31343 +14
+ Misses 35081 35068 -13
+ Partials 2375 2374 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
DavyLandman
approved these changes
Aug 28, 2026
toinehartman
requested changes
Aug 28, 2026
| * can be used to normalize case-insensitive literals in one go | ||
| } | ||
| @pitfalls{ | ||
| * only applicable to entire files. For selection-based formatting see ((subTreeEdits)) and ((subStringEdits)). |
Member
There was a problem hiding this comment.
Suggested change
| * only applicable to entire files. For selection-based formatting see ((subTreeEditFormatter)) and ((subStringEditFormatter)). |
toinehartman
requested changes
Aug 28, 2026
toinehartman
left a comment
toinehartman
left a comment
Member
There was a problem hiding this comment.
Better names! Like @DavyLandman pointed out, the renaming is not complete, as the old names appear at use sites and in the tutor documentation in various places. I tried to point them all out.
| | ((fileFormatter)) | `void (loc)` | replaces the current file | | ||
| | ((stringFormatter)) | `str (str) ` | | | ||
| | ((subStringFormatter)) | str (type[Tree], str) | can be used on any non-terminal in the grammar | | ||
| | ((fileEdits)) | `list[TextEdit] (loc)` | use ((executeTextEdits)) or ((executeFileSystemChanges)) or ((applyFileSystemEdits)) later | |
| | ((stringFormatter)) | `str (str) ` | | | ||
| | ((subStringFormatter)) | str (type[Tree], str) | can be used on any non-terminal in the grammar | | ||
| | ((fileEdits)) | `list[TextEdit] (loc)` | use ((executeTextEdits)) or ((executeFileSystemChanges)) or ((applyFileSystemEdits)) later | | ||
| | ((treeEdits)) | `list[TextEdit] (Tree)` | | |
| | ((subStringFormatter)) | str (type[Tree], str) | can be used on any non-terminal in the grammar | | ||
| | ((fileEdits)) | `list[TextEdit] (loc)` | use ((executeTextEdits)) or ((executeFileSystemChanges)) or ((applyFileSystemEdits)) later | | ||
| | ((treeEdits)) | `list[TextEdit] (Tree)` | | | ||
| | ((subTreeEdits)) | `list[TextEdit](Tree)` | this uses a subparser based on the top-level type of the input tree` | |
| | ((fileEdits)) | `list[TextEdit] (loc)` | use ((executeTextEdits)) or ((executeFileSystemChanges)) or ((applyFileSystemEdits)) later | | ||
| | ((treeEdits)) | `list[TextEdit] (Tree)` | | | ||
| | ((subTreeEdits)) | `list[TextEdit](Tree)` | this uses a subparser based on the top-level type of the input tree` | | ||
| | ((stringEdits)) | `list[TextEdit](str)` | | |
| | ((treeEdits)) | `list[TextEdit] (Tree)` | | | ||
| | ((subTreeEdits)) | `list[TextEdit](Tree)` | this uses a subparser based on the top-level type of the input tree` | | ||
| | ((stringEdits)) | `list[TextEdit](str)` | | | ||
| | ((subStringEdits)) | `list[TextEdit](type[Tree], str)` | | |
| * can be used to normalize case-insensitive literals in one go | ||
| } | ||
| @pitfalls{ | ||
| * only applicable to entire files. For selection-based formatting see ((subTreeEdits)) and ((subStringEdits)). |
Member
There was a problem hiding this comment.
subTreeEditFormatter and subStringEditFormatter
| * can be used to normalize case-insensitive literals in one go | ||
| } | ||
| @pitfalls{ | ||
| * only applicable to entire files. For selection-based formatting see ((subTreeEdits)) and ((subStringEdits)). |
Member
There was a problem hiding this comment.
subTreeEditFormatter en subStringEditFormatter
| * can be used to normalize case-insensitive literals in one go | ||
| } | ||
| @pitfalls{ | ||
| * only applicable to entire files. For selection-based formatting see ((subTreeEdits)) and ((subStringEdits)). |
Member
There was a problem hiding this comment.
subTreeEditFormatter and subStringEditFormatter
| * can be slow for very very large input | ||
| } | ||
| str(str) stringFormatter(type[&G <: Tree] grammar, Style style, FormattingOptions opts=fo()) { | ||
| list[TextEdit](str) toEdits = stringEdits(grammar, style, opts=opts); |
| * can be slow for very very large input | ||
| } | ||
| str(type[Tree], str) subStringFormatter(type[&G <: Tree] grammar, Style style, FormattingOptions opts=fo()) { | ||
| list[TextEdit](type[Tree], str) toEdits = subStringEdits(grammar, style, opts=opts); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.