[Request] Merge `log` and `stream` #304

Open

Open

[Request] Merge log and stream#304

Labels

Member

The @clack/prompts package has both log and stream helpers, but the only difference is that stream accepts iterables and log accepts strings. Ideally these could be merged into a single API that handles both.

added

on Apr 18, 2025

github-project-automation

added this to Triage Board

on Apr 18, 2025

github-project-automation

moved this to Needs triage in Triage Board

on Apr 18, 2025

moved this from Needs triage to On deck in Triage Board

on Apr 18, 2025

moved this from On deck to Needs triage in Triage Board

on Apr 18, 2025

Contributor

The main issue with the merge of log and stream it's there is a signature change for log.
It changes from a synchronous API to an asynchronous API

It's nothing big, but it introduces a breaking change

Contributor

Another difference, log utilities assume that if message is an Array ten each element is a line (so it add \n at the end of each element).
But in stream every iteration is push to the current line (no \n is added)

linked a pull request that will close this issue

on Apr 18, 2025

feat(prompts): Merge stream and log utilities #305

to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

Labels

Type

No type

Projects

Status

Needs triage

Milestone

No milestone

Relationships

None yet

Development

feat(prompts): Merge stream and log utilitiesbombshell-dev/clack

Participants