Copy only commands in command snippets #352
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Reviewer note: This PR is based on top of #348 so |
avatus
previously approved these changes
Jul 31, 2023
ptgott
changed the base branch from
paul.gottschling/2023-07-24-fix-tests
to
main
|
@avatus Changing the branch's base to |
Fixes #121 The `CodeLine` component represents a string within a `code` snippet that is not a command. This is often an example of a command's output. However, for code snippets consisting of, say, example YAML, `CodeLines` represent the value we want a user to copy. This use case enables example values to include `Var` components, and we'll likely deprecate it once we enable support for `Var`s in syntax-highlighted code blocks. Since a `CodeLine` can show up in both of these use cases, we need to make sure that they are copied when there are no commands in a `code` snippet and _not_ copied when there are commands. This is because, when there are commands in a snippet, the intention is for a reader to copy only the commands--the output would be what the reader sees when they enter the commands into their terminal. This change adds branching in the `Pre` component, which handles the copy/paste logic for `Snippet`, to copy `CodeLine`s only when there are no `CommandLine`s in the snippet.
ptgott
force-pushed
the
paul.gottschling/121-code-copy
branch
from
d3b442f
to
91115f4
Compare
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 #121
The
CodeLinecomponent represents a string within acodesnippet that is not a command. This is often an example of a command's output.However, for code snippets consisting of, say, example YAML,
CodeLinesrepresent the value we want a user to copy. This use case enables example values to includeVarcomponents, and we'll likely deprecate it once we enable support forVars in syntax-highlighted code blocks.Since a
CodeLinecan show up in both of these use cases, we need to make sure that they are copied when there are no commands in acodesnippet and not copied when there are commands. This is because, when there are commands in a snippet, the intention is for a reader to copy only the commands--the output would be what the reader sees when they enter the commands into their terminal.This change adds branching in the
Precomponent, which handles the copy/paste logic forSnippet, to copyCodeLines only when there are noCommandLines in the snippet.