feat: create no-unused-definitions rule
#425
Merged
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
lumirlumir
changed the title
no-unused-definition ruleno-unused-definitions rule
…reate-no-unused-definition-rule
…b.com/eslint/markdown into feat-create-no-unused-definition-rule
lumirlumir
commented
Jun 22, 2025
|
|
||
| defaultOptions: [ | ||
| { | ||
| allowDefinitions: ["//"], |
Member
Author
There was a problem hiding this comment.
Suggested change
| allowDefinitions: ["//"], | |
| allowDefinitions: ["//"], |
// is usally used as a definition-style comment.
References:
- feat: create
no-duplicate-definitions#360 (comment) - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md053---link-and-image-reference-definitions-should-be-needed
- https://stackoverflow.com/questions/4823468/comments-in-markdown
- https://www.jamestharpe.com/markdown-comments/
lumirlumir
commented
Jun 22, 2025
| footnoteDefinitions.add(node); | ||
| }, | ||
|
|
||
| "root:exit"() { |
Member
Author
There was a problem hiding this comment.
Suggested change
| "root:exit"() { | |
| "root:exit"() { |
In this PR, unlike the no-duplicate-definitions rule, errors should be reported only after all definition and footnoteDefinition nodes have been collected, as Reference and Definition nodes may appear in any order within the document.
1 task
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new ESLint rule no-unused-definitions to detect and report unused Markdown reference and footnote definitions.
- Adds the rule implementation under
src/rules. - Provides a comprehensive test suite covering valid/invalid cases.
- Updates documentation and the main README to include the new rule.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/rules/no-unused-definitions.test.js | Adds valid/invalid test cases for the new rule |
| src/rules/no-unused-definitions.js | Implements the no-unused-definitions rule logic |
| docs/rules/no-unused-definitions.md | Documents the rule’s behavior, options, and examples |
| README.md | Registers the rule in the plugin’s rule table |
Comments suppressed due to low confidence (1)
docs/rules/no-unused-definitions.md:19
- [nitpick] Consider replacing the inline HTML comment with a proper Markdown lint directive or moving the note outside the blockquote to improve readability and maintain consistency.
> [!IMPORTANT] <!-- eslint-disable-line -- This should be fixed in https://github.com/eslint/markdown/issues/294 -->
nzakas
previously approved these changes
Jun 24, 2025
Member
nzakas
left a comment
nzakas
left a comment
There was a problem hiding this comment.
Just one note on the docs and otherwise LGTM. Would like another review before merging.
Co-authored-by: Nicholas C. Zakas <[email protected]>
1 task
Co-authored-by: Nitin Kumar <[email protected]>
snitin315
approved these changes
Jun 27, 2025
github-project-automation
bot
moved this from Second Review Needed
to Complete
in Triage
Merged
1 task
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.
Prerequisites checklist
What is the purpose of this pull request?
In this PR, I've created
no-unused-definitionsrule.I've left a few comments on some key parts.
This PR resolves #424.
What changes did you make? (Give an overview)
I've created
no-unused-definitionsrule.Related Issues
Fixes: #424
Is there anything you'd like reviewers to focus on?