docs: add json docs

docs/.vitepress/config.ts

@@ -9,6 +9,7 @@ import {
   mathItems,
   utilItems,
   fileItems,
+  jsonItems,
 } from './items'
 
 function withI18n(items: { link: string; text: string }[], locale: 'zh') {
@@ -77,6 +78,10 @@ export default defineConfig({
             text: '工具',
             items: withI18n(utilItems, 'zh'),
           },
+          {
+            text: 'JSON',
+            items: withI18n(jsonItems, 'zh'),
+          },
         ],
 
         docFooter: {
@@ -139,6 +144,10 @@ export default defineConfig({
         text: 'Util',
         items: utilItems,
       },
+      {
+        text: 'JSON',
+        items: jsonItems,
+      },
     ],
 
     socialLinks: [{ icon: 'github', link: 'https://github.com/varletjs/rattail' }],

docs/.vitepress/items/index.ts

@@ -7,3 +7,4 @@ export * from './function'
 export * from './math'
 export * from './util'
 export * from './file'
+export * from './json'

docs/.vitepress/items/json.ts

@@ -0,0 +1,4 @@
+export const jsonItems = [
+  { text: 'tryParseJSON', link: '/json/try-parse-JSON' },
+  { text: 'prettyJSONObject', link: '/json/pretty-JSON-object' },
+]

docs/json/pretty-JSON-object.md

@@ -0,0 +1,33 @@
+# prettyJSONObject
+
+Formats a `JSON` object with indentation for easy readability.
+
+### Usage
+
+```ts
+import { prettyJSONObject } from 'rattail'
+
+const jsonObject = { key: 'value', nested: { key: 'nestedValue' } }
+const pretty = prettyJSONObject(jsonObject)
+console.log(pretty)
+/*
+{
+  "key": "value",
+  "nested": {
+    "key": "nestedValue"
+  }
+}
+*/
+```
+
+### Arguments
+
+| Arg          | Type     | Defaults |
+| ------------ | -------- | -------- |
+| `jsonObject` | `object` |          |
+
+### Return
+
+| Type     |
+| -------- |
+| `string` |

docs/json/try-parse-JSON.md

@@ -0,0 +1,29 @@
+# tryParseJSON
+
+Attempts to parse a `JSON` string. If parsing fails, returns `undefined`.
+
+### Usage
+
+```ts
+import { tryParseJSON } from 'rattail'
+
+const jsonString = '{"key": "value"}'
+const parsed = tryParseJSON(jsonString)
+console.log(parsed) // { key: "value" }
+
+const invalidJsonString = '{"key": value}'
+const invalidParsed = tryParseJSON(invalidJsonString)
+console.log(invalidParsed) // undefined
+```
+
+### Arguments
+
+| Arg    | Type     | Defaults |
+| ------ | -------- | -------- |
+| `json` | `string` |          |
+
+### Return
+
+| Type                  |
+| --------------------- |
+| `object \| undefined` |

docs/zh/element/classes.md

@@ -0,0 +1,23 @@
+# classes
+
+根据给定条件生成类名列表，或直接返回类名。
+
+### 使用
+
+```ts
+import { classes } from 'rattail'
+
+const classList = classes('active', [true, 'visible', 'hidden'])
+```
+
+### 参数
+
+| 参数      | 类型      | 默认值 |
+| --------- | --------- | ------ |
+| `classes` | `Classes` |        |
+
+### 返回值
+
+| 类型    |
+| ------- |
+| `any[]` |

docs/zh/json/pretty-JSON-object.md

@@ -0,0 +1,33 @@
+# prettyJSONObject
+
+格式化 `JSON` 对象，增加缩进以便于阅读。
+
+### 使用
+
+```ts
+import { prettyJSONObject } from 'rattail'
+
+const jsonObject = { key: 'value', nested: { key: 'nestedValue' } }
+const pretty = prettyJSONObject(jsonObject)
+console.log(pretty)
+/*
+{
+  "key": "value",
+  "nested": {
+    "key": "nestedValue"
+  }
+}
+*/
+```
+
+### 参数
+
+| 参数         | 类型     | 默认值 |
+| ------------ | -------- | ------ |
+| `jsonObject` | `object` |        |
+
+### 返回值
+
+| 类型     |
+| -------- |
+| `string` |

docs/zh/json/try-parse-JSON.md

@@ -0,0 +1,29 @@
+# tryParseJSON
+
+尝试解析 `JSON` 字符串。如果解析失败，返回 `undefined`。
+
+### 使用
+
+```ts
+import { tryParseJSON } from 'rattail'
+
+const jsonString = '{"key": "value"}'
+const parsed = tryParseJSON(jsonString)
+console.log(parsed) // { key: "value" }
+
+const invalidJsonString = '{"key": value}'
+const invalidParsed = tryParseJSON(invalidJsonString)
+console.log(invalidParsed) // undefined
+```
+
+### 参数
+
+| 参数   | 类型     | 默认值 |
+| ------ | -------- | ------ |
+| `json` | `string` |        |
+
+### 返回值
+
+| 类型                  |
+| --------------------- |
+| `object \| undefined` |