Skip to content

docs(run): add --sequential #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(run): add --sequential #665

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/cli/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ immediately in all matching packages with prefixed streaming output. This is the
preferred flag for long-running processes over many packages, for instance, a
lengthy build process.

### --sequential

Alias for `--workspace-concurrency=1`. Run scripts one after another in a blocking
manner rather than concurrently. Note that there are no guarantees that the scripts
will run in topological sort order.
Comment on lines +115 to +116
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noted this in #672, which is a dupe of this, but it'd be good to clarify here what the expected behaviour is in terms of order of execution when using this with pnpm run "/regex/". My understanding is that in that situation, it'll use the order that the scripts are defined in package.json.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's fine but i don't think it should block merging this pr. the reason why there's a dupe im assuming is because we both were trying to find this in the docs but needed to look at the help to find it. the pre work for making something more substantive here would be to have tests in the pnpm repo asserting a particular behavior, because i don't think just looking at the implementation is good enough

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably disagree, I think it'd be better to properly figure out what should be documented first, rather than landing partial documentation that doesn't even acknowledge all the use-cases for it (nothing about this wording implies it can be used w/ pnpm run "/regex/", and in some ways even suggests its not for that due to the reference to topological sorting for pnpm -r).


### --stream

Stream output from child processes immediately, prefixed with the originating
Expand Down