feat: modularise toc part generation with variable padding length#369
Open
thompson-tomo wants to merge 7 commits into
Open
feat: modularise toc part generation with variable padding length#369thompson-tomo wants to merge 7 commits into
thompson-tomo wants to merge 7 commits into
Conversation
thompson-tomo
requested review from
AndrewSouthpaw and
PeterDaveHello
as code owners
thompson-tomo
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors TOC assembly by extracting TOC header/title/footer line generation into lib/content-generation.js, aiming to improve modularity and enable configurable padding around TOC parts.
Changes:
- Moved TOC header/title/footer line construction into reusable helpers (
tocHeader,tocTitle,tocFooter) inlib/content-generation.js. - Updated
lib/transform.jsto use the new content generator helpers and to centralize title options underoptions.toc.title. - Adjusted
README.mddocumentation for TOC title padding.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates documentation around --toc-title-padding-before behavior/expectations. |
| lib/transform.js | Switches TOC composition to use new content-generation helpers and updates title inference flow. |
| lib/content-generation.js | Introduces helpers to generate TOC parts with padding and content selection logic. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
thompson-tomo
force-pushed
the
content_generation
branch
from
cad5716 to
080da6b
Compare
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.
This extracts the generation of the toc parts into the content generator module.
This extraction improves testability, functionality scoping & lays the foundation for enabling full control of padding before & after the content.
This approach enables control of the qty of padding before title etc.