feat: add checkSiblingsOnly option to no-duplicate-headings rule #393
+380
−27
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new siblingsOnly option to the no-duplicate-headings rule so that duplicate heading checks may be applied only among headings that share the same parent.
- Added a siblingsOnly boolean option in the rule’s schema and updated the implementation to track headings by level.
- Updated tests and documentation to verify the behavior for ATX and setext-style headings.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/rules/no-duplicate-headings.test.js | New test cases validating the siblingsOnly behavior for both valid and invalid heading structures. |
| src/rules/no-duplicate-headings.js | Modified duplicate heading tracking logic to support the siblingsOnly option using level-based tracking instead of a global set. |
| docs/rules/no-duplicate-headings.md | Updated documentation with options and examples for the new siblingsOnly setting. |
nzakas
reviewed
May 30, 2025
xbinaryx
changed the title
lumirlumir
requested changes
Jun 3, 2025
nzakas
approved these changes
Jun 5, 2025
|
@xbinaryx please double-check your spam folder, I sent you an email. 😄 |
github-project-automation
bot
moved this from Second Review Needed
to Complete
in Triage
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?
This PR adds a new siblingsOnly option to the no-duplicate-headings rule to make it more flexible. Currently, the rule flags any duplicate headings in the entire document, which can be too restrictive in some cases. With this new option, users can configure the rule to only check for duplicate headings among siblings (headings at the same level under the same parent heading).
What changes did you make? (Give an overview)
Added a new siblingsOnly boolean option to the rule's schema and refactored the implementation to track headings by level, resetting tracking when moving between levels when siblingsOnly is enabled. Updated documentation and added test cases for both ATX and setext-style headings to verify the new behavior.
Related Issues
Fixes #390
Is there anything you'd like reviewers to focus on?