feat: add RemoveWhiteSpace

docs/strutil.md

@@ -57,6 +57,7 @@ import (
 -   [Trim](#Trim)
 -   [SplitAndTrim](#SplitAndTrim)
 -   [HideString](#HideString)
+-   [RemoveWhiteSpace](#RemoveWhiteSpace)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1240,3 +1241,36 @@ func main() {
     // false
 }
 ```
+
+### <span id="RemoveWhiteSpace">RemoveWhiteSpace</span>
+
+<p>Remove whitespace characters from a string. when set repalceAll is true removes all whitespace, false only replaces consecutive whitespace characters with one space.</p>
+
+<b>Signature:</b>
+
+```go
+func RemoveWhiteSpace(str string, repalceAll bool) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := " hello   \r\n   \t   world"
+
+    result1 := strutil.RemoveWhiteSpace(str, true)
+    result2 := strutil.RemoveWhiteSpace(str, false)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // helloworld
+    // hello world
+}
+```

docs/strutil_zh-CN.md

@@ -57,6 +57,8 @@ import (
 -   [Trim](#Trim)
 -   [SplitAndTrim](#SplitAndTrim)
 -   [HideString](#HideString)
+-   [RemoveWhiteSpace](#RemoveWhiteSpace)
+
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1272,3 +1274,36 @@ func main() {
     // false
 }
 ```
+
+### <span id="RemoveWhiteSpace">RemoveWhiteSpace</span>
+
+<p>删除字符串中的空格，当设置repalceAll为true时，删除全部空格，为false时，替换多个空格为1个空格。</p>
+
+<b>函数签名:</b>
+
+```go
+func RemoveWhiteSpace(str string, repalceAll bool) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := " hello   \r\n   \t   world"
+
+    result1 := strutil.RemoveWhiteSpace(str, true)
+    result2 := strutil.RemoveWhiteSpace(str, false)
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // helloworld
+    // hello world
+}
+```

strutil/string.go

@@ -6,6 +6,7 @@ package strutil
 
 import (
 	"reflect"
+	"regexp"
 	"strings"
 	"unicode"
 	"unicode/utf8"
@@ -503,3 +504,21 @@ func ContainsAny(str string, substrs []string) bool {
 
 	return false
 }
+
+var (
+	whitespaceRegexMatcher     *regexp.Regexp = regexp.MustCompile(`\s`)
+	mutiWhitespaceRegexMatcher *regexp.Regexp = regexp.MustCompile(`[[:space:]]{2,}|[\s\p{Zs}]{2,}`)
+)
+
+// RemoveWhiteSpace remove whitespace characters from a string.
+// when set repalceAll is true removes all whitespace, false only replaces consecutive whitespace characters with one space.
+func RemoveWhiteSpace(str string, repalceAll bool) string {
+	if repalceAll && str != "" {
+		return strings.Join(strings.Fields(str), "")
+	} else if str != "" {
+		str = mutiWhitespaceRegexMatcher.ReplaceAllString(str, " ")
+		str = whitespaceRegexMatcher.ReplaceAllString(str, " ")
+	}
+
+	return strings.TrimSpace(str)
+}

strutil/string_test.go

@@ -455,3 +455,13 @@ func TestContainsAny(t *testing.T) {
 	assert.Equal(true, ContainsAny("hello world", []string{"hello", "abc"}))
 	assert.Equal(false, ContainsAny("hello world", []string{"123", "abc"}))
 }
+
+func TestRemoveWhiteSpace(t *testing.T) {
+	assert := internal.NewAssert(t, "TestRemoveWhiteSpace")
+
+	str := " hello   \r\n	\t   world"
+
+	assert.Equal("", RemoveWhiteSpace("", true))
+	assert.Equal("helloworld", RemoveWhiteSpace(str, true))
+	assert.Equal("hello world", RemoveWhiteSpace(str, false))
+}