feat: add transformerNotationFold #1219
Open
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.
Description
This PR adds a new transformer
transformerNotationFoldto@shikijs/transformers. This transformer allows users to mark sections of code as foldable using comment notation, similar to VS Code or Monaco Editor.It supports two syntaxes:
// [!code fold:start]and// [!code fold:end]// #regionand// #endregionChanges
packages/transformers/src/transformers/notation-fold.tstransformerNotationFoldinpackages/transformers/src/index.tspackages/transformers/test/fold.test.tsUsage
Shiki Syntax
Region Syntax
Implementation Details
The transformer adds the following classes to the generated HTML:
fold-start: Added to the line containing the start marker (for#region) or the line following the start marker (for[!code fold:start]).fold-end: Added to the line containing the end marker (for#endregion) or the line preceding the end marker (for[!code fold:end]).fold-content: Added to all lines between the start and end lines.Note: Shiki-style markers (
[!code fold:...]) are removed from the output, while#regionmarkers are preserved (but still get the classes).Verification
Added a new test file
packages/transformers/test/fold.test.tswhich verifies:closes: #861