Add preserve case option for buffer replace. References #165. #938

paradoxxxzero · 2017-08-10T09:22:29Z

Description of the Change

This PR adds a preserveCaseOnReplace option (off by default) which keeps the replaced text case. For exemple, when replacing test with case:
test Test TEST will be replaced with: case Case CASE.

This is made by swapping the replacement right before putting it in the buffer in buffer-search.js. The preserveCase algorithm is trivial and defined in project/util.coffee.

This only works in buffer search. The project replace is done in atom core and should be addressed in a separate ticket.

Alternate Designs

One could have added a button for this option, but a plugin configuration was chosen since it concerns only replacing (not searching) and it might not be toggled very often.

Benefits

Huge benefits arise when replacing variables name that are in different case, for instance replacing in one pass client, getClient and MAX_CLIENT with person, getPerson, MAX_PERSON.

Possible Drawbacks

This adds a boolean check for each replace, low performance impact though.

Applicable Issues

#165

bmperrea · 2017-08-30T03:19:58Z

lib/buffer-search.js

-          replacePattern;
+        const replacedText = this.editor.getTextInBufferRange(bufferRange)
+        let replacementText = findRegex ? replacedText.replace(findRegex, replacePattern) : replacePattern;
+        replacementText = preserveCaseOnReplace ? Util.preserveCase(replacementText, replacedText): replacementText


bmperrea · 2017-08-30T03:40:56Z

lib/project/util.coffee

+  else if reference is reference.toUpperCase()
+    text.toUpperCase()
+  else
+    text


This seems like a difficult feature to design. You have implemented preservation of All CAPS, and of Proper case. I would have expected lower case to be preserved as well. It might be worth thinking through a few more cases, such as strings with chars other than spaces and letters (e.g. one could imaging replacing snake_case and SNAKE_CASE at the same time, one being recognizably lower case and the other upper). camelCase might be interesting too if both the find and replace had that form, although maybe now I'm getting too fancy. I would prefer to open this discussion a little bit, though, such as with an issue for this feature.

You have support for

Title Case

UPPER CASE

I suggest you add

lower case

Sentence case

These are the main ones in Wikipedia/Letter_case, and ones that can be recovered from lower case. Then the user can set the default (what they put in the replace box) to whatever mixed case they want otherwise. I realize not supporting "Sentence case" was by design, but I would expect it to keep that case. Thanks!

bmperrea · 2017-08-30T03:41:25Z

spec/buffer-search-spec.js

+      `);
+    });
+  });
+});


bmperrea · 2017-08-30T14:11:44Z

lib/project/util.coffee

+  else if reference is reference.toUpperCase()
+    text.toUpperCase()
+  else
+    text


You have support for

Title Case

UPPER CASE

I suggest you add

lower case

Sentence case

These are the main ones in Wikipedia/Letter_case, and ones that can be recovered from lower case. Then the user can set the default (what they put in the replace box) to whatever mixed case they want otherwise. I realize not supporting "Sentence case" was by design, but I would expect it to keep that case. Thanks!

Distinguish between titleize and capitalize for lower case and Sentence case support. Change them to return strict cases. (Don't keep other uppercase letters.) Add a clearer test.

bmperrea

Thanks - very well done on the tests!

paradoxxxzero · 2017-08-31T13:12:33Z

First, thanks for the code review!
Ok so now when replacing aAa bBb by xxX yYy, it goes like this:

aaa bbb -> xxx yyy  # lower case
Aaa bbb -> Xxx yyy  # Sentence case
aaa Bbb -> xxX yYy  # ? -> default
Aaa Bbb -> Xxx Yyy  # Title Case
AAA BBB -> XXX YYY  # UPPER CASE
aaA bbb -> xxX yYy  # ? -> default
aaa bbB -> xxX yYy  # ? -> default
aaA bbB -> xxX yYy  # ? -> default

Is that what you wanted?

Edit: Took too long to type this comment! Thanks for the approval.

paradoxxxzero · 2017-10-04T13:12:49Z

Is there anything else that I could do to make it hit a release?

Le-Stagiaire · 2017-12-13T10:06:39Z

Aaaah that's what I was looking for ! Hope to see it in the next release.
Shouldn't it be merged already though ?

jedwards1211 · 2018-08-14T14:29:57Z

I made a PR that supports a wider range of cases like snake case, camel case, and kebab case, using spaces, dashes, underscores, or camel casing as word boundaries during conversion. Could we close this in favor of it? #1041

Mine also adds a toggle button because there really needs to be a toggle button. Multiple other editors use a toggle for preserve case, like WebStorm and Sublime.

darangi · 2021-03-23T11:51:33Z

Thanks @paradoxxxzero

50Wliu added the needs-review label Aug 15, 2017

bmperrea reviewed Aug 30, 2017

View reviewed changes

bmperrea suggested changes Aug 30, 2017

View reviewed changes

paradoxxxzero added 2 commits August 31, 2017 10:17

Add preserve case option for buffer replace. References atom#165.

3285ff5

Very small optimization.

e517d2f

paradoxxxzero force-pushed the preserve-case branch from a0b5e25 to e517d2f Compare August 31, 2017 08:18

Support for lower case and Sentence case in preserve-case replace.

5983fcc

Distinguish between titleize and capitalize for lower case and Sentence case support. Change them to return strict cases. (Don't keep other uppercase letters.) Add a clearer test.

bmperrea approved these changes Aug 31, 2017

View reviewed changes

darangi added the triaged label Dec 11, 2020

darangi merged commit 65bf3e6 into atom:master Mar 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add preserve case option for buffer replace. References #165. #938

Add preserve case option for buffer replace. References #165. #938

paradoxxxzero commented Aug 10, 2017

bmperrea Aug 30, 2017

bmperrea Aug 30, 2017 •

edited

Loading

bmperrea Aug 30, 2017

bmperrea Aug 30, 2017

bmperrea Aug 30, 2017

bmperrea left a comment

paradoxxxzero commented Aug 31, 2017 •

edited

Loading

paradoxxxzero commented Oct 4, 2017

Le-Stagiaire commented Dec 13, 2017 •

edited

Loading

jedwards1211 commented Aug 14, 2018 •

edited

Loading

darangi commented Mar 23, 2021

Add preserve case option for buffer replace. References #165. #938

Add preserve case option for buffer replace. References #165. #938

Conversation

paradoxxxzero commented Aug 10, 2017

Description of the Change

Alternate Designs

Benefits

Possible Drawbacks

Applicable Issues

bmperrea Aug 30, 2017

Choose a reason for hiding this comment

bmperrea Aug 30, 2017 • edited Loading

Choose a reason for hiding this comment

bmperrea Aug 30, 2017

Choose a reason for hiding this comment

bmperrea Aug 30, 2017

Choose a reason for hiding this comment

bmperrea Aug 30, 2017

Choose a reason for hiding this comment

bmperrea left a comment

Choose a reason for hiding this comment

paradoxxxzero commented Aug 31, 2017 • edited Loading

paradoxxxzero commented Oct 4, 2017

Le-Stagiaire commented Dec 13, 2017 • edited Loading

jedwards1211 commented Aug 14, 2018 • edited Loading

darangi commented Mar 23, 2021

bmperrea Aug 30, 2017 •

edited

Loading

paradoxxxzero commented Aug 31, 2017 •

edited

Loading

Le-Stagiaire commented Dec 13, 2017 •

edited

Loading

jedwards1211 commented Aug 14, 2018 •

edited

Loading