Skip to content
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.

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

Improve the usability of rust-dbg-wrap-or-unwrap #498

Merged
merged 8 commits into from
Aug 3, 2023

Conversation

micl2e2
Copy link
Contributor

@micl2e2 micl2e2 commented Jul 23, 2023

While the original implementation of rust-dbg-wrap-or-unwrap works in many cases, it has following problems:

Issue1. Insertion happens indiscriminately.

For example:

before:

*<---cursor is here
let a = 1;

after:

dbg!(
let) a = 1;

Issue2. Not handling the cursor position after dbg!() insertion.

Insertion of dbg!() indicates that user's intention to debug an expression. if the return value is significant(case 1), the original expression must be surrounded by another expression, which means not handling the cursor position is totally fine, but if dbg!'s return value is insignificant(case 2), the subsequent action the user will take must be adding an trailing semicolon, for the original implementation in such cases, users must reach the end of line first(C-e or similar) and then add a semicolon.

In fact, in practice, the second case is far more common than the first one, we can do some rough statistics on the source files of rust-lang/rust:

rg 'dbg!\(.*\).*[^;]$' | wc -l  # 61 the first case
rg 'dbg!\(.*\).*;$' |  wc -l  # 270 the second case

The point is that, whether users insert trailing semicolon or not, moving cursor to the end of dbg!() automatically after insertion not only does no harms, but it likely saves one keystroke for most cases.

Overall, these patches do nothing more than fixing the issues mentioned above and cutting some unnecessary branches. For the first issue , the result after fixed will be

dbg!()
let a = 1;

Other known issues:

  1. Similar to the original implementaion, the current rust-dbg-wrap-or-unwrap still relies on forward/backward-sexp to move forward/backward the cursor. In some cases where the cursor is inside pattern match arms or a complex structure or similar, C-c C-d may break the code.

@psibi
Copy link
Member

psibi commented Aug 2, 2023

Thanks for the PR. Can you add some tests for the different cases here ?

@micl2e2
Copy link
Contributor Author

micl2e2 commented Aug 3, 2023

Thanks for the PR. Can you add some tests for the different cases here ?

Sure, I'm working on this.

@micl2e2
Copy link
Contributor Author

micl2e2 commented Aug 3, 2023

Hi! @psibi I've added tests for new cases(two), as well as existing cases(three). And I've splited changes into relatively small commits, which might be helpful for the review. If these commits are too verbose and need to be squashed or rearranged, please let me know.

@psibi psibi merged commit 601824c into rust-lang:master Aug 3, 2023
9 checks passed
@psibi
Copy link
Member

psibi commented Aug 3, 2023

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants