docs: clarify multiline command continuations#1477
Open
KirtiRamchandani wants to merge 1 commit into
Open
Conversation
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.
Fixes #1149
Problem
The getting-started guide shows arrays for long argument lists, but it does not show how to split one shell command across multiple lines. This makes it easy to write a backslash followed by trailing spaces and accidentally start a new shell command on the next line.
Root cause
zx passes literal command text to the configured shell. A newline is treated by the shell as a command separator unless it is escaped, and a backslash only continues the line when it is the final character before the newline.
Solution
Add a concise multiline
fzfexample and call out that trailing spaces after the continuation backslash break the command.Tests run
npx prettier --check docs/getting-started.mdgit diff --check HEAD~1..HEADnpm run docs:build; it fails on the current checkout in Vite/esbuild while transforming generated VitePress app destructuring, before this Markdown content is involved.