Add rule to remove leading shell prompt literal $ #996
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
Rule added to handle cases where the $ symbol is used in the command, this usually happens when the command is copy pasted from a documentation that includes the shell prompt symbol in the code blocks.
scorphus
requested changes
Oct 28, 2019
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "command", |
There was a problem hiding this comment.
How about parametrizing only script (as string) and declare a Command instance with "$: command not found" as output?
Suggested change
| "command", | |
| "script", |
That would make all test tables more readable.
| @pytest.mark.parametrize( | ||
| "command", | ||
| [ | ||
| Command("$ cd newdir", "$: command not found"), |
There was a problem hiding this comment.
Suggested change
| Command("$ cd newdir", "$: command not found"), | |
| "$ cd newdir", |
| Command(" $ cd newdir", "$: command not found"), | ||
| ], | ||
| ) | ||
| def test_match(command): |
There was a problem hiding this comment.
Suggested change
| def test_match(command): | |
| def test_match(script): |
| ], | ||
| ) | ||
| def test_match(command): | ||
| assert match(command) |
There was a problem hiding this comment.
Suggested change
| assert match(command) | |
| assert match(Command(script, "$: command not found")) |
Comment on lines
17
to
33
| @pytest.mark.parametrize( | ||
| "command", | ||
| [Command("$", ""), Command("$?", ""), Command(" $?", ""), Command("", "")], | ||
| ) | ||
| def test_not_match(command): | ||
| assert not match(command) | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "command, new_command", | ||
| [ | ||
| (Command("$ cd newdir", ""), "cd newdir"), | ||
| (Command("$ python3 -m virtualenv env", ""), "python3 -m virtualenv env"), | ||
| ], | ||
| ) | ||
| def test_get_new_command(command, new_command): | ||
| assert get_new_command(command) == new_command |
| return command.script.replace("$", "", 1).strip() | ||
|
|
||
|
|
||
| requires_output = True |
There was a problem hiding this comment.
This can be omitted as requires_output's default value is True.
- Refactor test for cleaner test tables - Removed unnecessary requires_output=True option
|
Thanks for the comments @scorphus! I have made the modifications as suggested. However, the non matches were not changed as I realised that the outputs were not the same for every test case. |
scorphus
approved these changes
Oct 29, 2019
|
Looks good, thanks! |
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.
Rule added to remove leading shell prompt literals found in the command.
This usually happens when a command is copy pasted from documentations with code blocks that contain it.