Proposal for string.split #3284

dvdherron · 2022-04-06T12:58:19Z

Proposal for adding split() to the Strings module based on Issue #1950

jathak

This looks good overall; most of my comments are about changes in what arguments are allowed and some formatting tweaks.

Thanks!

proposal/string-split.md

stof · 2022-04-08T16:05:08Z

proposal/string-split.md

+returned in the list:
+
+- ```scss
+  string.split($fonts, ', ', 2); // "Helvetica Neue" "Helvetica"


should the limit truncate the end of the string, or should it take all the remainder in the last part ? Javascript is one of the few languages implementing the truncation (which is easy to achieve otherwise by doing an unlimited split and slicing the array)

@stof Are you saying, should this work by 1) making all the splits and then slicing the array at the limit or 2) only splitting up to the limit and then stopping?

Do you think there would be downsides to taking one approach or the other?

Well, to me, it would be more useful if limit would work by splitting the string on the limit -1 first separators, with the last item containing all the remaining work.
Your current proposal does the opposite (truncating the remaining parts), and this could be achieved through an unlimited split and then slicing the list (but I just figured out that list.slice does not exist in Sass).

I remember reading an article a few weeks ago comparing the behavior of the string splitting API of lots of different languages in that regard (but unfortunately, I did not manage to find it back for now to share it here. But AFAIR, most languages are providing the non-truncating version of the API (Javascript being one of the exceptions).

Also, a benefit of the non-truncation is that we don't loose content when splitting the string, so joining the list items with the separator (not exposed as a function in sass:list either btw) always produces the original string.

I'd lean towards matching the JS behavior here. @nex3: Do you have any thoughts on this?

I agree with @stof here. I think JS's behavior is a misfeature, and we should match other languages in preserving the entire remainder of the string.

In that case, let's change this to do that.

@jathak I've updated this section (and the examples) to show limit working as noted in the conversation above. The function should preserve the remainder of the string now.

@mirisuzanne made a function based on these steps that you can see here

…tring-split

jathak

Sorry for the delay on re-reviewing this!

proposal/string-split.md

jathak · 2022-04-25T22:51:06Z

proposal/string-split.md

+returned in the list:
+
+- ```scss
+  string.split($fonts, ', ', 2); // "Helvetica Neue" "Helvetica"


I'd lean towards matching the JS behavior here. @nex3: Do you have any thoughts on this?

proposal/string-split.md

dvdherron · 2022-04-29T17:15:22Z

Sorry for the delay on re-reviewing this!

All good @jathak. I'm back in the office in another week-and-a-half or so and I'll adress your latest review then!

jathak

Just realized that I left comments, but never submitted a formal review. The changes necessary now are to change the limit parameter so it adds the remaining text to the last item, and to explicitly specify that it returns an unbracketed, comma-separated list.

dvdherron · 2022-06-01T11:09:37Z

Just realized that I left comments, but never submitted a formal review. The changes necessary now are to change the limit parameter so it adds the remaining text to the last item, and to explicitly specify that it returns an unbracketed, comma-separated list.

Thanks @jathak . I'm currently working on edits based on re-working how limit works and your review. I should have something to show by the week's end or early next week at the latest.

dvdherron · 2022-06-14T16:50:09Z

Just realized that I left comments, but never submitted a formal review. The changes necessary now are to change the limit parameter so it adds the remaining text to the last item, and to explicitly specify that it returns an unbracketed, comma-separated list.

@jathak I just wanted to give you a heads up that I will be away starting next week and back around early August. I can respond to your upcoming review then, or if something is urgent, feel free to reach out to the OddBird team in the meantime.

jathak

Sorry for the long delay on reviewing this!

The logic here all looks good, my only remaining comments are formatting/eliminating redundancies.

jathak · 2022-07-11T18:26:04Z

proposal/string-split.md

+
+* If `$string` is not a string, throw an error.
+
+* If `$separator` is `null` or is not a string, throw an error.


Suggested change

* If `$separator` is `null` or is not a string, throw an error.

* If `$separator` is not a string, throw an error.

null is already not a string, so we don't need to specifically call it out here.

removed the null reference here.

jathak · 2022-07-11T18:30:01Z

proposal/string-split.md

+
+* Let `split-counter` equal 0.
+
+* While `split-counter` is `<=` `limit` and `length` is `>` 0:


Suggested change

* While `split-counter` is `<=` `limit` and `length` is `>` 0:

* While `split-counter <= limit` and `length > 0`:

jathak · 2022-07-11T18:30:12Z

proposal/string-split.md

+
+* While `split-counter` is `<=` `limit` and `length` is `>` 0:
+
+  * If `split-counter` `==` `limit`:


Suggested change

* If `split-counter` `==` `limit`:

* If `split-counter == limit`:

jathak · 2022-07-11T18:36:01Z

proposal/string-split.md

+* Let `limit` be the value of `$limit`.
+
+* Otherwise, if `$limit` is `null`, set `limit` to the value of `length`.


It's probably simpler to just say:

* If `$limit` is `null`, set `$limit` to the value of `length`.

and then refer to $limit below.

jathak · 2022-07-11T18:52:23Z

proposal/string-split.md

+
+        * Increase `split-counter` by 1.
+
+  * Set `length` to `string.length($string)`.


Since we have to update it after each change to $string anyway, and length is only referenced once each loop, I think it makes more sense to eliminate the length variable entirely and just call string.length($string) when we need it.

Makes sense. I removed the length variable and inserted calls to string.length($string) where needed.

dvdherron · 2022-08-25T16:10:57Z

Hi @jathak! These changes should cover the last bit of cleanup you suggested. Ready for another look whenever you get a chance.

jathak

Thank you for all your work on this! Sorry it's taken so long to get approved

add string.split proposal draft

b3fbef3

nex3 assigned jathak Apr 6, 2022

jathak requested changes Apr 8, 2022

View reviewed changes

clean up formatting

6652244

stof reviewed Apr 8, 2022

View reviewed changes

dvdherron and others added 6 commits April 11, 2022 13:38

clean up semantics section

c3d3df3

Merge branch 'sass:main' into string-split

f6db4e0

fix function link

03e841f

Merge branch 'string-split' of ssh://github.com/dvdherron/sass into s…

e79584d

…tring-split

remove markers from examples

4b663fe

Merge branch 'sass:main' into string-split

ead86d4

dvdherron requested a review from jathak April 12, 2022 17:20

jathak reviewed Apr 25, 2022

View reviewed changes

roydukkey reviewed Apr 29, 2022

View reviewed changes

proposal/string-split.md Show resolved Hide resolved

dvdherron and others added 4 commits May 12, 2022 14:36

Merge branch 'sass:main' into string-split

a17bab4

reflow text

f8f4a96

clean up empty separator logic

52ee123

make append steps consistent

16ba697

dvdherron requested a review from jathak May 17, 2022 15:07

jathak requested changes May 31, 2022

View reviewed changes

dvdherron and others added 2 commits June 1, 2022 20:09

adjust logic to keep string remainder

719f988

Merge branch 'sass:main' into string-split

084e054

dvdherron requested a review from jathak June 1, 2022 18:22

jathak reviewed Jul 11, 2022

View reviewed changes

dvdherron and others added 2 commits August 25, 2022 13:51

Merge branch 'sass:main' into string-split

9109048

clean up formatting and redundancies

07c4fc2

dvdherron requested a review from jathak August 25, 2022 16:11

jathak approved these changes Aug 29, 2022

View reviewed changes

jathak merged commit 7d1b02b into sass:main Aug 29, 2022

nex3 mentioned this pull request Oct 28, 2022

string.split() function #1950

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposal for string.split #3284

Proposal for string.split #3284

dvdherron commented Apr 6, 2022

jathak left a comment

stof Apr 8, 2022

dvdherron Apr 12, 2022

stof Apr 12, 2022

jathak Apr 25, 2022

nex3 May 18, 2022

jathak May 18, 2022

dvdherron Jun 1, 2022

jathak left a comment

jathak Apr 25, 2022

dvdherron commented Apr 29, 2022

jathak left a comment

dvdherron commented Jun 1, 2022

dvdherron commented Jun 14, 2022

jathak left a comment

jathak Jul 11, 2022

dvdherron Aug 25, 2022

jathak Jul 11, 2022

dvdherron Aug 25, 2022

jathak Jul 11, 2022

dvdherron Aug 25, 2022

jathak Jul 11, 2022

dvdherron Aug 25, 2022

jathak Jul 11, 2022

dvdherron Aug 25, 2022

dvdherron commented Aug 25, 2022

jathak left a comment


		* If `$string` is not a string, throw an error.

		* If `$separator` is `null` or is not a string, throw an error.

	* If `$separator` is `null` or is not a string, throw an error.
	* If `$separator` is not a string, throw an error.


		* Let `split-counter` equal 0.

		* While `split-counter` is `<=` `limit` and `length` is `>` 0:

	* While `split-counter` is `<=` `limit` and `length` is `>` 0:
	* While `split-counter <= limit` and `length > 0`:


		* While `split-counter` is `<=` `limit` and `length` is `>` 0:

		* If `split-counter` `==` `limit`:

	* If `split-counter` `==` `limit`:
	* If `split-counter == limit`:

		* Let `limit` be the value of `$limit`.

		* Otherwise, if `$limit` is `null`, set `limit` to the value of `length`.


		* Increase `split-counter` by 1.

		* Set `length` to `string.length($string)`.

Proposal for string.split #3284

Proposal for string.split #3284

Conversation

dvdherron commented Apr 6, 2022

jathak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jathak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dvdherron commented Apr 29, 2022

jathak left a comment

Choose a reason for hiding this comment

dvdherron commented Jun 1, 2022

dvdherron commented Jun 14, 2022

jathak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dvdherron commented Aug 25, 2022

jathak left a comment

Choose a reason for hiding this comment