feat: add stripBom

liriliri · Feb 23, 2023 · dc33a76 · dc33a76
1 parent 9559fa0
commit dc33a76
Show file tree

Hide file tree

Showing 7 changed files with 89 additions and 0 deletions.
diff --git a/DOC.md b/DOC.md
@@ -11931,6 +11931,26 @@ Strip ansi codes from a string.
 stripAnsi('\u001b[4mcake\u001b[0m'); // -> 'cake'
 ```
 
+## stripBom 
+
+Strip UTF-8 byte order mark.
+
+<details>
+<summary>Type Definition</summary>
+<pre>
+<code class="language-typescript">function stripBom(str: string): string;</code>
+</pre>
+</details>
+
+|Name  |Desc           |
+|------|---------------|
+|str   |String to strip|
+|return|Result string  |
+
+```javascript
+stripBom('\uFEFFlicia'); // -> 'licia'
+```
+
 ## stripCmt 
 
 Strip comments from source code.

diff --git a/DOC_CN.md b/DOC_CN.md
@@ -11922,6 +11922,26 @@ stringifyAll(function test() {}); // -> '{"value":"function test() {}","type":"F
 stripAnsi('\u001b[4mcake\u001b[0m'); // -> 'cake'
 ```
 
+## stripBom
+
+清除 UTF-8 BOM。
+
+<details>
+<summary>类型定义</summary>
+<pre>
+<code class="language-typescript">function stripBom(str: string): string;</code>
+</pre>
+</details>
+
+|参数名|说明|
+|-----|---|
+|str|源字符串|
+|返回值|目标字符串|
+
+```javascript
+stripBom('\uFEFFlicia'); // -> 'licia'
+```
+
 ## stripCmt
 
 清除源码中的注释。

diff --git a/cspell.json b/cspell.json
@@ -396,6 +396,7 @@
     "stringify",
     "stringifyAll",
     "stripAnsi",
+    "stripBom",
     "stripCmt",
     "stripColor",
     "stripHtmlTag",

diff --git a/i18n/stripBom.md b/i18n/stripBom.md
@@ -0,0 +1,8 @@
+## CN
+
+清除 UTF-8 BOM。
+
+|参数名|说明|
+|-----|---|
+|str|源字符串|
+|返回值|目标字符串|
diff --git a/index.json b/index.json
@@ -6171,6 +6171,19 @@
             "browser"
         ]
     },
+    "stripBom": {
+        "dependencies": [],
+        "description": "Strip UTF-8 byte order mark.",
+        "env": [
+            "node",
+            "browser",
+            "miniprogram"
+        ],
+        "test": [
+            "node",
+            "browser"
+        ]
+    },
     "stripCmt": {
         "dependencies": [],
         "description": "Strip comments from source code.",

diff --git a/src/stripBom.js b/src/stripBom.js
@@ -0,0 +1,26 @@
+/* Strip UTF-8 byte order mark.
+ *
+ * |Name  |Desc           |
+ * |------|---------------|
+ * |str   |String to strip|
+ * |return|Result string  |
+ */
+
+/* example
+ * stripBom('\uFEFFlicia'); // -> 'licia'
+ */
+
+/* module
+ * env: all
+ */
+
+/* typescript
+ * export declare function stripBom(str: string): string;
+ */
+
+exports = function(str) {
+    if (str.charCodeAt(0) === 0xfeff) {
+        return str.slice(1);
+    }
+    return str;
+};
diff --git a/test/stripBom.js b/test/stripBom.js
@@ -0,0 +1 @@
+test(['\uFEFFlicia', 'licia']);