feat(ansi): rename writeAnsi/createAnsiWriter to printAnsi/createAnsiPrinter - #382
Merged
Conversation
…Printer Deprecate writeAnsi, createAnsiWriter, and AnsiWriterOptions as aliases, to be removed in the next major version.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Documentation previews |
comark
@comark/angular
@comark/ansi
@comark/html
@comark/nuxt
@comark/react
@comark/svelte
@comark/vue
commit: |
Contributor
✅ Bundle snapshot updatedCommitted the new snapshot as 96e94ad, verified by re-running the bundle check against it. GitHub suppresses the events a workflow commit would normally raise, so the Produced by this run. |
farnabaz
approved these changes
Aug 24, 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
2 participants
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.
What
Renames
writeAnsi()toprintAnsi()andcreateAnsiWriter()tocreateAnsiPrinter()in@comark/ansi. The old names (plus theAnsiWriterOptionstype) remain as@deprecatedTypeScript aliases so existing code keeps working. Docs, README, AGENTS.md, examples, benchmarks, and tests are updated to the new names.Why
"Print" describes the behavior (parse and print to stdout) better than "write". Keeping deprecated aliases makes this a non-breaking change now, with removal planned for the next major version.