feat(cli): add --format option for html output#1211
Merged
antfu merged 1 commit intoshikijs:mainfrom Dec 4, 2025
Merged
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 #1211 +/- ##
=======================================
Coverage 95.20% 95.20%
=======================================
Files 92 92
Lines 7922 7922
Branches 1689 1689
=======================================
Hits 7542 7542
Misses 374 374
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
antfu
approved these changes
Dec 4, 2025
This was referenced Dec 12, 2025
This was referenced Jan 22, 2026
This was referenced Feb 5, 2026
This was referenced Feb 8, 2026
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 introduces a new
--formatoption to the@shikijs/cli, enabling users to output syntax-highlighted code as HTML, in addition to the existing ANSI terminal output.Changes:
--format <format>flag (supportsansi|html, default:ansi).codeToHtmlfor HTML output generation.Why this is valuable:
npx shiki-cli file.js --format html > snippet.htmlpygments) that support multiple output formats.Implementation Details:
codeToHtmlfunction from the core package, ensuring consistent output with the main library.Verification:
packages/cli/test/cli.test.tsto verify that--format htmlcorrectly produces an HTML string with the expected class names.pnpm test packages/cli-> All tests passed.pnpm build-> Build successful.