You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Summary
Improved JSDoc ESLint configuration to better support TypeScript
projects by using TypeScript-specific recommended rules and adding
explicit file targeting.
## Changes
- Switched from `flat/recommended` to `flat/recommended-typescript`
config
- Added explicit file targeting with `GLOB_JS` and `GLOB_TS`
- Removed `jsdoc/no-restricted-syntax` rule
- Updated `jsdoc/require-jsdoc` to not require JSDoc on
ArrowFunctionExpression or FunctionDeclaration
## Motivation
The previous configuration used generic JSDoc recommended rules which
were not optimized for TypeScript. The TypeScript-specific preset
provides better defaults for TypeScript projects. Additionally,
requiring JSDoc on arrow functions (which are more commonly used in
modern codebases) while making it optional for function declarations
provides better documentation coverage without being overly restrictive.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Style**
* Switched JSDoc linting to a TypeScript-focused baseline.
* JSDoc is no longer required on arrow functions or function
declarations.
* Removed a restrictive JSDoc syntax rule.
* **Chores**
* Improved JavaScript/TypeScript file targeting in lint configuration.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
0 commit comments