feat: add transformerNotationFold#1219
Open
SHUBHI-KUMARI wants to merge 2 commits intoshikijs:mainfrom
Open
Conversation
✅ Deploy Preview for shiki-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for shiki-matsu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1219 +/- ##
==========================================
+ Coverage 95.20% 95.27% +0.06%
==========================================
Files 92 93 +1
Lines 7922 8034 +112
Branches 1689 1708 +19
==========================================
+ Hits 7542 7654 +112
Misses 374 374
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
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