fix(no-types, require-example, implements-on-classes): allow any to match function variable declarations #1448
+166 −9
Conversation
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
…ny` to match function variable declarations; fixes gajus#1446
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where the any context configuration was not properly matching function variable declarations in three JSDoc rules. The fix allows the rules to detect TypeScript-style arrow function variable declarations when using the any context.
- Adds a new
isIteratingFunctionOrVariableutility function that extends function detection to include variable declarations with function initializers - Updates three rules to use the new utility instead of the original
isIteratingFunction - Adds comprehensive test coverage for both regular and exported function variable declarations
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/iterateJsdoc.js | Implements the new isIteratingFunctionOrVariable utility function and refactors isIteratingFunction |
| src/rules/requireExample.js | Updates to use isIteratingFunctionOrVariable for broader function detection |
| src/rules/noTypes.js | Updates to use isIteratingFunctionOrVariable for broader function detection |
| src/rules/implementsOnClasses.js | Updates to use isIteratingFunctionOrVariable for broader function detection |
| test/rules/assertions/requireExample.js | Adds test case for function variable declarations with TypeScript syntax |
| test/rules/assertions/noTypes.js | Adds test cases for both regular and exported function variable declarations |
| docs/rules/require-example.md | Updates documentation with example of function variable declaration |
| docs/rules/no-types.md | Updates documentation with examples of function variable declarations |
| 🎉 This PR is included in version 53.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
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(
no-types,require-example,implements-on-classes): allowanyto match function variable declarations; fixes #1446