fix: report messages for configuration comments correctly by andreahlert · Pull Request #618 · eslint/markdown

andreahlert · 2026-02-05T11:36:15Z

Summary

Previously, ESLint messages that pointed to configuration comments (such as unused disable directive warnings) were being silently dropped because the adjustMessage function returned null for any message pointing to lines before the actual code content.

This change:

Tracks the original HTML comment positions when collecting configuration comments from the Markdown
Builds a mapping from linted code line numbers to original comment info
Maps messages pointing to configuration comment lines back to their original HTML comment locations in the Markdown file

This fixes the issue where --report-unused-disable-directives would not work with the markdown processor, as those warnings were being filtered out.

Before

$ eslint --report-unused-disable-directives README.md
# (no output even when there are unused disable directives)

After

$ eslint --report-unused-disable-directives README.md
README.md
  3:1  warning  Unused eslint-disable directive (no problems were reported from 'no-undef')

Test plan

Added new test suite reportUnusedDisableDirectives with tests for single-line and multi-line HTML comments
All existing 1590 tests pass
Lint passes

Fixes #115

linux-foundation-easycla · 2026-02-05T11:36:23Z

The committers listed above are authorized under a signed CLA.

✅ login: andreahlert / name: André Ahlert (1917fa0, a08617f, aaa9b03)

andreahlert · 2026-02-07T20:09:51Z

Hi @nzakas, this fixes a 7-year-old issue (#115) where --report-unused-disable-directives silently drops warnings from HTML comments in Markdown files. CI is green and I've added 4 test cases covering the mapping logic. Would appreciate a review when you get a chance!

andreahlert · 2026-02-08T11:04:25Z

Thanks for the review, @Ari4ka!

nzakas · 2026-02-09T22:16:24Z

@andreahlert thanks, I'll take a look when I'm able.

Did you use AI to generate this PR?

andreahlert · 2026-02-10T20:45:14Z

Hey @nzakas . Everybody says that to me 😅 I write lots of docs at work so it's a habit to be super detailed. And I usually generate an AI template of PR (for headers for exemple), to keep the same looking, but its all my writing.

I'll keep PR descriptions shorter going forward. Lmk if you want me to clarify anything about the implementation!

docs/processors/markdown.md

src/processor.js

DMartens · 2026-02-11T14:59:25Z

Thank you for submitting a PR for this. It is a really good starting for fixing this.

lumirlumir · 2026-02-15T13:28:51Z

Hi — there's a CI failure. If you have a moment, could you take a look?

Lint was failing because report-unused-disable-directives now correctly reports warnings in .md files; tests/fixtures/long.md has intentional directives that trigger those warnings. Align with main config which already ignores tests/fixtures. Refs eslint#618

andreahlert · 2026-02-23T06:29:03Z

Hi — there's a CI failure. If you have a moment, could you take a look?

Done! Ready for final review.

andreahlert · 2026-03-05T19:18:57Z

@nzakas @DMartens can we have a look on this?

DMartens · 2026-03-05T22:36:27Z

src/types.ts

+
 export interface BlockBase {
 	baseIndentText: string;
 	comments: string[];


The comments property should be removed as it is no longer set.

Can you double-check this? It seems like comments is still used.

It seems the current implementation still uses the comments property. Otherwise it throws a type error.

Confirmed, comments is still used in getBlockRangeMap, block.comments.join for assembling linted text, and leadingCommentLines calculation. Kept it as-is.

DMartens · 2026-03-05T22:37:59Z

Sorry for the delay. Other than the small things I mentioned, the changes LGTM.

nzakas

Overall this looks good to me. I'd like to rename CommentInfo to something that better describes what it is. CommentWithLoc? MappedCommentLocation? Just something that makes it clear what it's doing.

nzakas · 2026-03-09T20:19:28Z

src/types.ts

+
 export interface BlockBase {
 	baseIndentText: string;
 	comments: string[];


Can you double-check this? It seems like comments is still used.

lumirlumir

Could you rebase or merge from the main branch once? While reviewing the codebase, I noticed this PR is a bit behind HEAD, so I'm concerned some things may be out of sync when it's merged into main.

Also, it seems there are CI failures that need to be addressed before merging.

src/processor.js

tests/plugin.test.js

eslint.config-content.js

lumirlumir · 2026-03-10T09:19:17Z

src/types.ts

+
 export interface BlockBase {
 	baseIndentText: string;
 	comments: string[];


It seems the current implementation still uses the comments property. Otherwise it throws a type error.

tests/plugin.test.js

src/processor.js

Previously, ESLint messages that pointed to configuration comments (such as unused disable directive warnings) were being silently dropped because the `adjustMessage` function returned `null` for any message pointing to lines before the actual code content. This change: - Tracks the original HTML comment positions when collecting configuration comments from the Markdown - Builds a mapping from linted code line numbers to original comment info - Maps messages pointing to configuration comment lines back to their original HTML comment locations in the Markdown file This fixes the issue where `--report-unused-disable-directives` would not work with the markdown processor, as those warnings were being filtered out. Fixes eslint#115 Signed-off-by: André Ahlert <andre@aex.partners>

Lint was failing because report-unused-disable-directives now correctly reports warnings in .md files; tests/fixtures/long.md has intentional directives that trigger those warnings. Align with main config which already ignores tests/fixtures. Refs eslint#618 Signed-off-by: André Ahlert <andre@aex.partners>

@typedef

- Rename CommentInfo to MappedCommentLocation for clarity - Import MappedCommentLocation type from ./types.js instead of inline @typedef - Remove unnecessary * from wrapComment regex character sets - Refactor tests to use beforeEach with shared config - Add reportUnusedDisableDirectives tests under LegacyESLint describe block Signed-off-by: André Ahlert <andre@aex.partners>

andreahlert · 2026-03-12T08:08:09Z

@nzakas Renamed CommentInfo to MappedCommentLocation in both types.ts and processor.js. Also rebased on main and addressed all other review feedback.

andreahlert · 2026-03-12T08:08:21Z

@lumirlumir Rebased on main, all feedback addressed. Tests and lint are passing.

eslint-github-bot bot added the bug label Feb 5, 2026

eslint-github-bot bot mentioned this pull request Feb 5, 2026

eslint --report-unused-disable-directives does not work with this plugin #115

Open

eslintbot added this to Triage Feb 5, 2026

github-project-automation bot moved this to Needs Triage in Triage Feb 5, 2026

andreahlert force-pushed the fix/report-unused-disable-directives branch from 31d9362 to dcccf5a Compare February 6, 2026 12:52

Ari4ka approved these changes Feb 8, 2026

View reviewed changes

DMartens reviewed Feb 11, 2026

View reviewed changes

docs/processors/markdown.md Show resolved Hide resolved

DMartens reviewed Feb 11, 2026

View reviewed changes

src/processor.js Outdated Show resolved Hide resolved

DMartens reviewed Feb 11, 2026

View reviewed changes

src/processor.js Show resolved Hide resolved

DMartens reviewed Feb 11, 2026

View reviewed changes

src/processor.js Show resolved Hide resolved

DMartens moved this from Needs Triage to Implementing in Triage Feb 11, 2026

Ari4ka approved these changes Feb 11, 2026

View reviewed changes

Ari4ka approved these changes Feb 17, 2026

View reviewed changes

andreahlert requested review from Ari4ka, DMartens and nzakas February 23, 2026 06:28

Ari4ka approved these changes Feb 23, 2026

View reviewed changes

DMartens reviewed Mar 5, 2026

View reviewed changes

nzakas added the contributor pool label Mar 9, 2026

nzakas requested changes Mar 9, 2026

View reviewed changes

lumirlumir requested changes Mar 10, 2026

View reviewed changes

andreahlert added 3 commits March 12, 2026 04:35

andreahlert force-pushed the fix/report-unused-disable-directives branch from e4ed80c to aaa9b03 Compare March 12, 2026 07:48

andreahlert requested review from DMartens, lumirlumir and nzakas March 12, 2026 08:27

Conversation

andreahlert commented Feb 5, 2026

Summary

Before

After

Test plan

Uh oh!

linux-foundation-easycla bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andreahlert commented Feb 7, 2026

Uh oh!

andreahlert commented Feb 8, 2026

Uh oh!

nzakas commented Feb 9, 2026

Uh oh!

andreahlert commented Feb 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DMartens commented Feb 11, 2026

Uh oh!

lumirlumir commented Feb 15, 2026

Uh oh!

andreahlert commented Feb 23, 2026

Uh oh!

andreahlert commented Mar 5, 2026

Uh oh!

DMartens Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

nzakas Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

lumirlumir Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

andreahlert Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

DMartens commented Mar 5, 2026

Uh oh!

nzakas left a comment

Choose a reason for hiding this comment

Uh oh!

nzakas Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

lumirlumir left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lumirlumir Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andreahlert commented Mar 12, 2026

Uh oh!

andreahlert commented Mar 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

linux-foundation-easycla bot commented Feb 5, 2026 •

edited

Loading

lumirlumir left a comment •

edited

Loading