feat: Allow control of Header and Footer#316
Open
thompson-tomo wants to merge 13 commits intothlorenz:masterfrom
Open
feat: Allow control of Header and Footer#316thompson-tomo wants to merge 13 commits intothlorenz:masterfrom
thompson-tomo wants to merge 13 commits intothlorenz:masterfrom
Conversation
thompson-tomo
requested review from
AndrewSouthpaw and
PeterDaveHello
as code owners
thompson-tomo
force-pushed
the
feat/#315_controlHeaderFooter
branch
from
910343e to
9ec94fd
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds configurable TOC header/footer generation to doctoc so users can remove the legacy “generated TOC…” wrappers and/or inject custom header/footer content, while refactoring marker/comment generation into a dedicated module.
Changes:
- Introduces
toc.header/toc.footeroptions (remove + custom content) and wires them through CLI parsing intotransform(). - Refactors comment/pragma generation into
lib/content-generation.jsand updates tests accordingly. - Documents the new CLI flags in
README.mdand adds dedicated header/footer behavior tests.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
lib/transform.js |
Adds options-driven marker generation and header/footer injection; refactors skip tag and marker logic to use shared generator. |
lib/content-generation.js |
New shared helper for comment blocks, escaped start tags, and legacy pragma strings. |
doctoc.js |
Adds new CLI flags and builds an options object passed into transform(). |
test/transform.js |
Updates legacy wrapper expectations to use the new content-generation helper; updates title padding tests to pass options. |
test/transform-toc-headerFooter.js |
New test coverage for header/footer removal and custom header/footer content (md + mdx). |
README.md |
Documents the new TOC header/footer flags and updates the README TOC. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Closes #315
Introduce configuration options which enable the header and footer of toc to be DRY ie no un-necessary content.
In the process introduce options to specify user definable headers and footers.
Note the title padding had been consolidated into the options object which makes it easier to pass properties through and test. Only that option could be move due to not being available in a released version.
The content block generation has been decoupled from the transform module which is the cause of the test changes.
An example of what could be added to header/footer is markdownlint/prettier pragma to enable/disable checks.