Skip to content

fix: enforce jsdoc/empty-tags rule and fix all violations#35853

Merged
Hotell merged 4 commits intomicrosoft:masterfrom
Hotell:chore/valid-jsdoc
Mar 11, 2026
Merged

fix: enforce jsdoc/empty-tags rule and fix all violations#35853
Hotell merged 4 commits intomicrosoft:masterfrom
Hotell:chore/valid-jsdoc

Conversation

@Hotell
Copy link
Collaborator

@Hotell Hotell commented Mar 9, 2026

Needs

Description

Enables the jsdoc/empty-tags ESLint rule and fixes all existing violations across the repo.

Problem

Modifier tags like @internal, @public, @override, etc. were incorrectly authored with description content after them. This caused JSDoc parsers (including the CLI metadata command's ts-morph-based parser) to assign the description text to the tag instead of treating it as the main description.

Before:

/**
 * @internal
 * Helper to manage a browser requestAnimationFrame.
 *
 * @returns A pair of [requestAnimationFrame, cancelAnimationFrame]
 */

After:

/**
 * Helper to manage a browser requestAnimationFrame.
 *
 * @internal
 * @returns A pair of [requestAnimationFrame, cancelAnimationFrame]
 */

Changes

  1. packages/eslint-plugin — Enabled jsdoc/empty-tags: 'error' rule and removed ignoreInternal setting
  2. 98 source files — Restructured JSDoc blocks to move descriptions before modifier tags, leaving the tags empty as required

Validation

  • yarn nx run-many -t lint passes for all 242 targets (0 errors)

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

📊 Bundle size report

✅ No changes found

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Pull request demo site: URL

@@ -13,17 +13,19 @@ export interface ILegendOverflowData {
}
Copy link

@github-actions github-actions bot Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🕵🏾‍♀️ visual changes to review in the Visual Change Report

vr-tests-react-components/Charts-DonutChart 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-react-components/Charts-DonutChart.Dynamic - RTL.default.chromium.png 5570 Changed
vr-tests-react-components/Portal 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-react-components/Portal.Apply Class Names.should have green border.chromium.png 15 Changed
vr-tests-react-components/Positioning 2 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-react-components/Positioning.Positioning end.updated 2 times.chromium.png 129 Changed
vr-tests-react-components/Positioning.Positioning end.chromium.png 127 Changed
vr-tests-react-components/TagPicker 2 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-react-components/TagPicker.disabled - High Contrast.disabled input hover.chromium.png 1319 Changed
vr-tests-react-components/TagPicker.disabled.disabled input hover.chromium.png 677 Changed
vr-tests-web-components/Accordion 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-web-components/Accordion. - Dark Mode.normal.chromium_1.png 3154 Changed
vr-tests-web-components/MenuList 2 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-web-components/MenuList. - Dark Mode.normal.chromium.png 498 Changed
vr-tests-web-components/MenuList. - RTL.2nd selected.chromium.png 17 Changed
vr-tests-web-components/RadioGroup 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-web-components/RadioGroup. - Dark Mode.normal.chromium_1.png 89 Changed
vr-tests-web-components/TextInput 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests-web-components/TextInput. - Dark Mode.normal.chromium_1.png 288 Changed
vr-tests/Callout 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests/Callout.No callout width specified.default.chromium.png 2143 Changed
vr-tests/Keytip 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests/Keytip.Offset.default.chromium.png 86 Changed
vr-tests/react-charting-GaugeChart 1 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests/react-charting-GaugeChart.Basic.default.chromium.png 2 Changed
vr-tests/react-charting-LineChart 3 screenshots
Image Name Diff(in Pixels) Image Type
vr-tests/react-charting-LineChart.Multiple - Dark Mode.default.chromium.png 181 Changed
vr-tests/react-charting-LineChart.Multiple - RTL.default.chromium.png 200 Changed
vr-tests/react-charting-LineChart.Multiple.default.chromium.png 192 Changed

There were 4 duplicate changes discarded. Check the build logs for more information.

Hotell and others added 3 commits March 10, 2026 16:40
Move description content from after modifier tags (@internal, @public,
etc.) to before them, leaving the tags empty as required by the
jsdoc/empty-tags ESLint rule.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Hotell Hotell force-pushed the chore/valid-jsdoc branch from 7a98908 to 6c3ccb9 Compare March 10, 2026 15:40
@Hotell Hotell merged commit dd187e2 into microsoft:master Mar 11, 2026
12 checks passed
@Hotell Hotell deleted the chore/valid-jsdoc branch March 11, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants