feat: format code

chaxus · Oct 31, 2023 · 8f4dcd3 · 8f4dcd3
1 parent 4875430
commit 8f4dcd3
Show file tree

Hide file tree

Showing 52 changed files with 1,545 additions and 1,532 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 dist
-assets
+assets
+report
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "lint:fix": "eslint --cache --fix",
     "lint:prettier": "prettier --check --cache .",
     "format": "prettier --write --cache .",
-    "cpd":"jscpd --pattern packages/**/*.ts"
+    "cpd": "jscpd --pattern packages/**/*.ts"
   },
   "homepage": "https://chaxus.github.io/ran/",
   "keywords": [],

diff --git a/packages/docs/.vitepress/config.ts b/packages/docs/.vitepress/config.ts
@@ -102,15 +102,24 @@ export default defineConfig({
             { text: '过滤对象', link: '/src/ranuts/utils/filterObj.md' },
             { text: '统计执行时间', link: '/src/ranuts/utils/task.md' },
             { text: '字符串转xml', link: '/src/ranuts/utils/str2xml.md' },
-            { text: '图片转base64', link: '/src/ranuts/utils/convertImageToBase64.md' },
+            {
+              text: '图片转base64',
+              link: '/src/ranuts/utils/convertImageToBase64.md',
+            },
             { text: 'OCR文字识别`', link: '/src/ranuts/utils/ocr.md' },
           ],
         },
         {
           text: '文件',
           items: [
-            { text: '查询一个文件的详细信息', link: '/src/ranuts/file/watchFile.md' },
-            { text: '读取目录下的文件名称', link: '/src/ranuts/file/readDir.md' },
+            {
+              text: '查询一个文件的详细信息',
+              link: '/src/ranuts/file/watchFile.md',
+            },
+            {
+              text: '读取目录下的文件名称',
+              link: '/src/ranuts/file/readDir.md',
+            },
             { text: '监听文件是否改变', link: '/src/ranuts/file/watchFile.md' },
             { text: '读取文件内容', link: '/src/ranuts/file/readFile.md' },
             { text: '追加文件内容', link: '/src/ranuts/file/appendFile.md' },
@@ -126,7 +135,10 @@ export default defineConfig({
         {
           text: 'mime type',
           items: [
-            { text: '通过文件后缀获取mime type', link: '/src/ranuts/mimeType/mimeType.md' },
+            {
+              text: '通过文件后缀获取mime type',
+              link: '/src/ranuts/mimeType/mimeType.md',
+            },
           ],
         },
       ],

diff --git a/packages/docs/src/ranuts/file/appendFile.md b/packages/docs/src/ranuts/file/appendFile.md
@@ -8,20 +8,16 @@
 
 - Promise
 
-| 参数   | 说明           | 类型      | 描述                         |
-| ------ | -------------- | --------- | ---------------------------- |
-| success | 是否追加成功 | `boolean` | true 追加成功 false 追加失败 |
-| data | 追加失败的原因，添加成功后的文件内容 | `any` |  |
+| 参数    | 说明                                 | 类型      | 描述                         |
+| ------- | ------------------------------------ | --------- | ---------------------------- |
+| success | 是否追加成功                         | `boolean` | true 追加成功 false 追加失败 |
+| data    | 追加失败的原因，添加成功后的文件内容 | `any`     |                              |
 
 ### Options
 
-| 参数     | 说明                           | 类型     | 默认值    |
-| -------- | ------------------------------ | -------- | --------- |
-| path     | 文件路径，需要追加的文件       | `string` | undefined |
-| content | 需要追加的内容 | `string` | 无     |
-
-
-## Example 
-
-
+| 参数    | 说明                     | 类型     | 默认值    |
+| ------- | ------------------------ | -------- | --------- |
+| path    | 文件路径，需要追加的文件 | `string` | undefined |
+| content | 需要追加的内容           | `string` | 无        |
 
+## Example
diff --git a/packages/docs/src/ranuts/file/fileInfo.md b/packages/docs/src/ranuts/file/fileInfo.md
@@ -1,26 +1,22 @@
 # QueryFileInfo
 
-查询一个文件的详细信息，一般用于区分文件还是目录，可以通过返回的data来判断（data.isDirectory()）
+查询一个文件的详细信息，一般用于区分文件还是目录，可以通过返回的 data 来判断（data.isDirectory()）
 
 ## API
 
 ### Return
 
 - Promise
 
-| 参数   | 说明           | 类型      | 描述                         |
-| ------ | -------------- | --------- | ---------------------------- |
-| success | 是否检查成功 | `boolean` | true 成功 false 失败 |
-| data | 文件的信息，或者错误的原因 | `Stats` |  |
+| 参数    | 说明                       | 类型      | 描述                 |
+| ------- | -------------------------- | --------- | -------------------- |
+| success | 是否检查成功               | `boolean` | true 成功 false 失败 |
+| data    | 文件的信息，或者错误的原因 | `Stats`   |                      |
 
 ### Options
 
-| 参数     | 说明                           | 类型     | 默认值    |
-| -------- | ------------------------------ | -------- | --------- |
-| path     | 文件路径，需要检查的文件路径       | `string` | undefined |
-
-
-## Example 
-
-
+| 参数 | 说明                         | 类型     | 默认值    |
+| ---- | ---------------------------- | -------- | --------- |
+| path | 文件路径，需要检查的文件路径 | `string` | undefined |
 
+## Example
diff --git a/packages/docs/src/ranuts/file/readDir.md b/packages/docs/src/ranuts/file/readDir.md
@@ -8,19 +8,15 @@
 
 - Promise
 
-| 参数   | 说明           | 类型      | 描述                         |
-| ------ | -------------- | --------- | ---------------------------- |
+| 参数   | 说明                 | 类型    | 描述           |
+| ------ | -------------------- | ------- | -------------- |
 | result | 目录下所有文件的数组 | `array` | 传入函数的参数 |
 
 ### Options
 
-| 参数     | 说明                           | 类型     | 默认值    |
-| -------- | ------------------------------ | -------- | --------- |
+| 参数    | 说明        | 类型     | 默认值         |
+| ------- | ----------- | -------- | -------------- |
 | options | { dirPath } | `object` | 传入函数的参数 |
-| dirPath | 文件的路径 | `Stats` |  |
-
-
-## Example 
-
-
+| dirPath | 文件的路径  | `Stats`  |                |
 
+## Example
diff --git a/packages/docs/src/ranuts/file/readFile.md b/packages/docs/src/ranuts/file/readFile.md
@@ -8,8 +8,8 @@
 
 - Promise
 
-| 参数   | 说明           | 类型      | 描述                         |
-| ------ | -------------- | --------- | ---------------------------- |
+| 参数 | 说明           | 类型      | 描述                         |
+| ---- | -------------- | --------- | ---------------------------- |
 | data | 文件是否被改变 | `boolean` | true 文件改变 false 文件没变 |
 
 ### Options
@@ -19,6 +19,4 @@
 | path     | 文件路径，需要监听的文件       | `string` | undefined |
 | interval | 监听文件改变的时间，单位毫秒。 | `number` | `20`      |
 
-
-## Example 
-
+## Example
diff --git a/packages/docs/src/ranuts/file/writeFile.md b/packages/docs/src/ranuts/file/writeFile.md
@@ -8,14 +8,14 @@
 
 - Promise
 
-| 参数   | 说明           | 类型      | 描述                         |
-| ------ | -------------- | --------- | ---------------------------- |
-| success | 是否写入成功 | `boolean` | true 成功 false 失败 |
-| data | 写入失败的原因，添加成功后的文件内容和文件路径 | `any` |  |
+| 参数    | 说明                                           | 类型      | 描述                 |
+| ------- | ---------------------------------------------- | --------- | -------------------- |
+| success | 是否写入成功                                   | `boolean` | true 成功 false 失败 |
+| data    | 写入失败的原因，添加成功后的文件内容和文件路径 | `any`     |                      |
 
 ### Options
 
-| 参数     | 说明                           | 类型     | 默认值    |
-| -------- | ------------------------------ | -------- | --------- |
-| path     | 文件路径，需要追加的文件       | `string` | undefined |
-| content | 需要追加的内容 | `string` | 无     |
+| 参数    | 说明                     | 类型     | 默认值    |
+| ------- | ------------------------ | -------- | --------- |
+| path    | 文件路径，需要追加的文件 | `string` | undefined |
+| content | 需要追加的内容           | `string` | 无        |
diff --git a/packages/docs/src/ranuts/index.md b/packages/docs/src/ranuts/index.md
@@ -2,16 +2,16 @@
 
 ## 方法列表
 
-| 方法          | 说明                               | 详细内容  |
-| ------------- | ---------------------------------- | --------- |
-| writeFile     | 写入文件                           | [writeFile](./file//writeFile.md) |
-| readFile      | 读取文件                           | [readFile](./file//readFile.md)     |
-| readDir       | 读取目录，获取目录下所有文件的名字 | [readDir](./file//readDir.md)     |
-| watchFile     | 观察文件的内容是否发生变化         | [watchFile](./file//watchFile.md)     |
-| queryFileInfo | 查询文件信息                       | [queryFileInfo](./file//fileInfo.md)     |
-| filterObj     | 过滤对象                           | [filterObj](./utils//filterObj.md)     |
-| EventEmitter  | 发布订阅类                         | [EventEmitter](./mode//subscribe.md)     |
-| str2Xml       | 字符串转成`xml`                    | [str2Xml](./utils//str2xml.md)     |
-| getMime       | 根据文件格式后缀获取 mime type     | [getMime](./mimeType/mimeType.md)     |
-| getCookie     | 获取指定cookie的值     | [writeFile](./utils/getCookie.md)     |
-| formatJson     | 格式化JSON     | [formatJson](./utils/formatJson.md)     |
+| 方法          | 说明                               | 详细内容                             |
+| ------------- | ---------------------------------- | ------------------------------------ |
+| writeFile     | 写入文件                           | [writeFile](./file//writeFile.md)    |
+| readFile      | 读取文件                           | [readFile](./file//readFile.md)      |
+| readDir       | 读取目录，获取目录下所有文件的名字 | [readDir](./file//readDir.md)        |
+| watchFile     | 观察文件的内容是否发生变化         | [watchFile](./file//watchFile.md)    |
+| queryFileInfo | 查询文件信息                       | [queryFileInfo](./file//fileInfo.md) |
+| filterObj     | 过滤对象                           | [filterObj](./utils//filterObj.md)   |
+| EventEmitter  | 发布订阅类                         | [EventEmitter](./mode//subscribe.md) |
+| str2Xml       | 字符串转成`xml`                    | [str2Xml](./utils//str2xml.md)       |
+| getMime       | 根据文件格式后缀获取 mime type     | [getMime](./mimeType/mimeType.md)    |
+| getCookie     | 获取指定 cookie 的值               | [writeFile](./utils/getCookie.md)    |
+| formatJson    | 格式化 JSON                        | [formatJson](./utils/formatJson.md)  |
diff --git a/packages/docs/src/ranuts/mimeType/mimeType.md b/packages/docs/src/ranuts/mimeType/mimeType.md
@@ -6,25 +6,25 @@
 
 ### Return
 
-| 参数     | 说明     | 类型                                     |
-| -------- | -------- | ---------------------------------------- |
-| `string`   | 返回`mime type` | `string`           |
+| 参数     | 说明            | 类型     |
+| -------- | --------------- | -------- |
+| `string` | 返回`mime type` | `string` |
 
 ### Options
 
-| 参数                    | 说明                     | 类型      | 默认值 |
-| ---------------------- | ----------------------- | --------- | ------ |
-| ext                    | 文件后缀格式             | `string`  | 无    |
+| 参数 | 说明         | 类型     | 默认值 |
+| ---- | ------------ | -------- | ------ |
+| ext  | 文件后缀格式 | `string` | 无     |
 
 ## Example
 
 ```js
-import { getMime } from 'ranuts'
+import { getMime } from 'ranuts';
 
-const result = getMime('.pptx')
-console.log(result)
+const result = getMime('.pptx');
+console.log(result);
 // 'application/vnd.openxmlformats-officedocument.presentationml.presentation
-const res = getMime('.txt')
-console.log(result)
+const res = getMime('.txt');
+console.log(result);
 // text/plain
 ```
diff --git a/packages/docs/src/ranuts/mode/subscribe.md b/packages/docs/src/ranuts/mode/subscribe.md
@@ -6,12 +6,12 @@
 
 ### Methods
 
-| 方法                    | 参数                     | 说明      | 默认值 |
-| ---------------------- | ----------------------- | --------- | ------ |
-| on                     | 订阅事件                  | 订阅事件，传入参数事件名，回调函数  | 无    |
-| once                   | 订阅一次事件，传入参数事件名，回调函数          | 订阅一次事件，触发一次后不再会触发 | 无    |
-| off                   | 取消订阅事件，传入参数事件名，回调函数          | 取消订阅事件 | 无    |
-| emit                   | 触发事件，需要事件名          | 触发事件 | 无    |
+| 方法 | 参数                                   | 说明                               | 默认值 |
+| ---- | -------------------------------------- | ---------------------------------- | ------ |
+| on   | 订阅事件                               | 订阅事件，传入参数事件名，回调函数 | 无     |
+| once | 订阅一次事件，传入参数事件名，回调函数 | 订阅一次事件，触发一次后不再会触发 | 无     |
+| off  | 取消订阅事件，传入参数事件名，回调函数 | 取消订阅事件                       | 无     |
+| emit | 触发事件，需要事件名                   | 触发事件                           | 无     |
 
 ## Example
 
@@ -31,7 +31,7 @@ subscribe.on('event', () => {
 // 订阅事件3
 const eventThree = () => {
   console.log(3);
-}
+};
 subscribe.on('event', eventThree);
 // 订阅事件4，需要传递参数
 subscribe.on('event', (num) => {
@@ -42,11 +42,10 @@ subscribe.emit('event', 4);
 // console.log(1) console.log(2) console.log(3) console.log(4)
 
 // 取消事件三
-subscribe.off('event', eventThree)
+subscribe.off('event', eventThree);
 
 // 订阅一次，触发一次自动取消
-subscribe.once('other',()=>{
-    console.log(5)
-})
-
+subscribe.once('other', () => {
+  console.log(5);
+});
 ```
diff --git a/packages/docs/src/ranuts/utils/convertImageToBase64.md b/packages/docs/src/ranuts/utils/convertImageToBase64.md
@@ -21,9 +21,9 @@
 ## Example
 
 ```js
-import { convertImageToBase64 } from 'ranuts'
+import { convertImageToBase64 } from 'ranuts';
 
-convertImageToBase64(file).then(res=>{
-    console.log(result) 
-})
+convertImageToBase64(file).then((res) => {
+  console.log(result);
+});
 ```
diff --git a/packages/docs/src/ranuts/utils/filterObj.md b/packages/docs/src/ranuts/utils/filterObj.md
@@ -6,32 +6,31 @@
 
 ### Return
 
-| 参数     | 说明     | 类型                                     |
-| -------- | -------- | ---------------------------------------- |
-| `Object`   | 返回的一个对象 | `Object`           |
+| 参数     | 说明           | 类型     |
+| -------- | -------------- | -------- |
+| `Object` | 返回的一个对象 | `Object` |
 
 ### Options
 
-| 参数                    | 说明                     | 类型      | 默认值 |
-| ---------------------- | ----------------------- | --------- | ------ |
-| obj                    | 需要过滤的对象             | `object`  | 无    |
-| list                   | 需要过滤的熟悉数组          | `array` | 无    |
+| 参数 | 说明               | 类型     | 默认值 |
+| ---- | ------------------ | -------- | ------ |
+| obj  | 需要过滤的对象     | `object` | 无     |
+| list | 需要过滤的熟悉数组 | `array`  | 无     |
 
 ## Example
 
 ```js
-import { filterObj } from 'ranuts'
+import { filterObj } from 'ranuts';
 
 const obj = {
-    name:'chaxus',
-    age:10,
-    address:'spark'
-}
+  name: 'chaxus',
+  age: 10,
+  address: 'spark',
+};
 
-const result = filterObj(obj,['name','address'])
+const result = filterObj(obj, ['name', 'address']);
 
-console.log(result) 
+console.log(result);
 
 // { age:10 }
-
 ```
-Original file line number
+Diff line change
@@ -1,2 +1,3 @@
     dist
-    assets
+    assets
+    report