✨ New Universal.FunctionDeclarations.NoLongClosures sniff
#240
Conversation
This file contains 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
New sniff to check for "long" closures and recommend using named functions instead. The sniff is fully configurable via the following properties: * (int) `recommendedLines` - this determines when a warning will be thrown. Defaults to `5`, which means that a warning will be thrown if the closure is more than 5 lines long. * (int) `maxLines` - this determines when an error will be thrown. Defaults to `8`, which means that an error will be thrown if the closure is more than 8 lines long. * (bool) `ignoreCommentLines` - whether or not comment-only lines should be ignored for the lines count. Defaults to `true`. * (bool) `ignoreEmptyLines` - whether or not blank lines should be ignored for the lines count. Defaults to `true`. The error and the warning have their own error codes - `ExceedsMaximum` and `ExceedsRecommended` - and can be included/excluded separately from a ruleset. Includes unit tests. Includes documentation. Includes metrics. Closes 192
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.
New sniff to check for "long" closures and recommend using named functions instead.
The sniff is fully configurable via the following properties:
recommendedLines- this determines when a warning will be thrown. Defaults to5, which means that a warning will be thrown if the closure is more than 5 lines long.maxLines- this determines when an error will be thrown. Defaults to8, which means that an error will be thrown if the closure is more than 8 lines long.ignoreCommentLines- whether or not comment-only lines should be ignored for the lines count. Defaults totrue.ignoreEmptyLines- whether or not blank lines should be ignored for the lines count. Defaults totrue.The error and the warning have their own error codes -
ExceedsMaximumandExceedsRecommended- and can be included/excluded separately from a ruleset.Includes unit tests.
Includes documentation.
Includes metrics.
Closes #192