Skip to content

fix(linter): exclude .introductory from headingless check #5249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcoscaceres wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −1
Open

fix(linter): exclude .introductory from headingless check #5249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/core/linter-rules/no-headingless-sections.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export function run(conf) {
}
/** @type {NodeListOf<HTMLElement>} */
const sections = document.querySelectorAll(
"section:not(.head,#abstract,#sotd)"
"section:not(.head,.introductory,#abstract,#sotd)"
);
const offendingElements = [...sections].filter(
({ firstElementChild: e }) =>
Expand Down
15 changes: 15 additions & 0 deletions tests/spec/core/linter-rules/no-headingless-sections-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,19 @@ describe("Core Linter Rule - 'no-headingless-sections'", () => {
expect(warnings[0].elements).toHaveSize(1);
expect(warnings[0].elements[0].id).toBe("badone");
});

it("doesn't warn for introductory sections without headings", async () => {
const body = `
<section class="introductory">
<p>Some introductory content without a heading.</p>
</section>
<section>
<h2>Normal section</h2>
</section>
`;
const opts = makeStandardOps(config, body);
Copy link
Copy Markdown
Contributor Author

@marcoscaceres marcoscaceres May 5, 2026

Choose a reason for hiding this comment

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

makeStandardOps is the correct name — it's exported from tests/spec/SpecHelper.js. Not a typo.

const doc = await makeRSDoc(opts);
const warnings = warningsFilter(doc);
expect(warnings).toHaveSize(0);
});
});
Loading