internal: quote in CommandBuilder #807
Merged
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
Potential failure handling for shlex::try_quoteCategory let command = if command.contains(|c: char| c.is_whitespace()) {
shlex::try_quote(command).map_err(|e| format!("Failed to quote command: {}", e))?
} else {
command.into()
};```
**Reasoning**
Using unwrap() could cause a panic if try_quote fails. While this is unlikely, proper error handling would make the code more robust and provide better error messages.
</details>
<details>
<summary> Missing documentation for whitespace handling logic </summary>
**Category**
Maintainability
**Code Snippet**
// don't always quote the `command` since moon in windows will be quoted into 'moon'
**Recommendation**
Add more detailed documentation explaining the Windows-specific behavior:
```rust
/// Creates a new CommandBuilder with proper command quoting.
///
/// On Windows, commands containing whitespace need special handling to prevent
/// double-quoting issues. Simple commands (without whitespace) are left unquoted
/// to avoid problems with commands like 'moon' being incorrectly quoted.```
**Reasoning**
The current comment is terse and doesn't fully explain the rationale behind the conditional quoting behavior. Better documentation would help future maintainers understand the Windows-specific considerations.
</details>
<details>
<summary> Consider extracting whitespace check into a named function </summary>
**Category**
Maintainability
**Code Snippet**
command.contains(|c: char| c.is_whitespace())
**Recommendation**
Extract the check into a descriptive function:
```rust
fn needs_quoting(s: &str) -> bool {
s.contains(|c: char| c.is_whitespace())
}
let command = if needs_quoting(command) {
shlex::try_quote(command).unwrap()
} else {
command.into()
};```
**Reasoning**
The whitespace check could be reused elsewhere and its purpose would be clearer with a descriptive function name. This would also make the code more maintainable if the quoting rules need to change in the future.
</details> |
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.
No description provided.