feat(#155): add too-deep-object lint - #1247
Open
VasilevNStas wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
@volodya-lombrozo plz review this pull request |
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
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.
fix #155
What
A new
design/too-deep-objectlint that warns when an object is nesteddeeper than twelve levels.
How it works
The lint counts the ancestors of every object in XMIR:
If the depth exceeds 12, the object is reported as a
warning.Synthetic nodes introduced by the parser are excluded from the count:
Φ.tuple(tuples written as*),Φ.bytes,Φ.numberandΦ.string(literals). Without this, even the canonical example
(
src/test/resources/org/eolang/lints/canonical.eo, which is only about12 source levels deep) would be flagged, because the parser wraps every
literal and tuple in extra levels of nesting.
Only the deepest offending objects are reported (not every descendant),
so a single deep chain yields a single defect.
Why
Deeply nested objects are hard to read and debug. The issue proposes a
threshold of 12, which this lint follows.
Tests
catches-too-deep-object— a 14-level chain is flaggedallows-normal-nesting— a 7-level chain (from the issue) is cleanBoth
mvn test(592 tests) andmvn clean install -Pqulicepass.