docs: 使用 AutoCorrect 格式化文档 (#165)

st1020 · web-flow · commit 51ed2e410353 · 2025-04-20T18:23:09.000+08:00
diff --git a/.github/workflows/lint-other.yml b/.github/workflows/lint-other.yml
@@ -32,12 +32,19 @@ jobs:
 
       - run: pnpm run eslint
 
-  zhlint:
+  markdownlint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
       - name: Setup Node
         uses: ./.github/actions/setup-node
 
-      - run: pnpm run zhlint
+      - run: pnpm run markdownlint
+
+  autocorrect:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: huacnlee/autocorrect-action@main
diff --git a/alicebot/adapter/__init__.py b/alicebot/adapter/__init__.py
@@ -87,7 +87,7 @@ async def safe_run(self) -> None:
     async def run(self) -> None:
         """适配器运行方法，适配器开发者必须实现该方法。
 
-        适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+        适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
         """
         raise NotImplementedError
 
diff --git a/alicebot/bot.py b/alicebot/bot.py
@@ -478,7 +478,7 @@ async def handle_event(
         handle_get: bool = True,
         show_log: bool = True,
     ) -> None:
-        """被适配器对象调用，根据优先级分发事件给所有插件，并处理插件的 `stop` 、 `skip` 等信号。
+        """被适配器对象调用，根据优先级分发事件给所有插件，并处理插件的 `stop`、`skip` 等信号。
 
         此方法不应该被用户手动调用。
 
@@ -812,7 +812,7 @@ def _load_plugins_from_dirs(self, *dirs: Path) -> None:
 
         Args:
             *dirs: 储存包含插件的模块的模块路径。
-                例如：`pathlib.Path("path/of/plugins/")` 。
+                例如：`pathlib.Path("path/of/plugins/")`。
         """
         dir_list = [str(x.resolve()) for x in dirs]
         logger.info("Loading plugins from dirs", dirs=", ".join(map(str, dir_list)))
@@ -828,7 +828,7 @@ def load_plugins_from_dirs(self, *dirs: Path) -> None:
 
         Args:
             *dirs: 储存包含插件的模块的模块路径。
-                例如：`pathlib.Path("path/of/plugins/")` 。
+                例如：`pathlib.Path("path/of/plugins/")`。
         """
         self._extend_plugin_dirs.extend(dirs)
         self._load_plugins_from_dirs(*dirs)
diff --git a/alicebot/exceptions.py b/alicebot/exceptions.py
@@ -1,7 +1,7 @@
 """AliceBot 异常。
 
-下列是 AliceBot 运行过程中可能会抛出的异常。这些异常大部分不需要用户处理， AliceBot 会自动捕获并处理。
-对于适配器开发者，所有适配器抛出的异常都应该继承自 `AdapterException` 。
+下列是 AliceBot 运行过程中可能会抛出的异常。这些异常大部分不需要用户处理，AliceBot 会自动捕获并处理。
+对于适配器开发者，所有适配器抛出的异常都应该继承自 `AdapterException`。
 """
 
 __all__ = [
diff --git a/alicebot/message.py b/alicebot/message.py
@@ -483,7 +483,7 @@ def values(self) -> ValuesView[Any]:
 
     @override
     def items(self) -> ItemsView[str, Any]:
-        """返回由 `data` 字典项 (`(键, 值)` 对) 组成的一个新视图。"""
+        """返回由 `data` 字典项 (`(键，值)` 对) 组成的一个新视图。"""
         return self.data.items()
 
     def is_text(self) -> bool:
diff --git a/alicebot/utils.py b/alicebot/utils.py
@@ -163,8 +163,8 @@ def samefile(path1: StrOrBytesPath, path2: StrOrBytesPath) -> bool:
     """一个 `os.path.samefile` 的简单包装。
 
     Args:
-        path1: 路径1。
-        path2: 路径2。
+        path1: 路径 1。
+        path2: 路径 2。
 
     Returns:
         如果两个路径是否指向相同的文件或目录。
diff --git a/docs/api/adapter/apscheduler/index.md b/docs/api/adapter/apscheduler/index.md
@@ -45,7 +45,7 @@ APScheduler 配置类，将在适配器被加载时被混入到机器人主配
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
diff --git a/docs/api/adapter/cqhttp/index.md b/docs/api/adapter/cqhttp/index.md
@@ -65,9 +65,9 @@ CQHTTP 配置类，将在适配器被加载时被混入到机器人主配置中
 
   - **NetworkError** - 网络错误。
 
-  - **ApiNotAvailable** - API 请求响应 404， API 不可用。
+  - **ApiNotAvailable** - API 请求响应 404，API 不可用。
 
-  - **ActionFailed** - API 请求响应 failed， API 操作失败。
+  - **ActionFailed** - API 请求响应 failed，API 操作失败。
 
   - **ApiTimeout** - API 请求响应超时。
 
@@ -131,7 +131,7 @@ CQHTTP 配置类，将在适配器被加载时被混入到机器人主配置中
 
   - **message\_type** (_Literal\['private', 'group'\]_) - 消息类型。应该是 "private" 或者 "group"。
 
-  - **id\_** (_int_) - 发送对象的 ID， QQ 号码或者群号码。
+  - **id\_** (_int_) - 发送对象的 ID，QQ 号码或者群号码。
 
 - **Returns**
 
diff --git a/docs/api/adapter/dingtalk/index.md b/docs/api/adapter/dingtalk/index.md
@@ -71,7 +71,7 @@ DingTalk 配置类，将在适配器被加载时被混入到机器人主配置
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
diff --git a/docs/api/adapter/index.md b/docs/api/adapter/index.md
@@ -70,7 +70,7 @@ Type: _~ConfigT_
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
diff --git a/docs/api/adapter/mirai/event/notice.md b/docs/api/adapter/mirai/event/notice.md
@@ -98,7 +98,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupBotEvent`
 
-Bot 在群里的权限被改变. 操作人一定是群主
+Bot 在群里的权限被改变。操作人一定是群主
 
 - **Attributes**
 
@@ -138,7 +138,7 @@ Bot 被取消禁言
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupBotEvent`
 
-Bot加入了一个新群
+Bot 加入了一个新群
 
 - **Attributes**
 
@@ -340,7 +340,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
-成员被踢出群 (该成员不是Bot)
+成员被踢出群 (该成员不是 Bot)
 
 - **Attributes**
 
@@ -352,7 +352,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
-成员主动离群 (该成员不是Bot)
+成员主动离群 (该成员不是 Bot)
 
 - **Attributes**
 
@@ -390,7 +390,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
-成员权限改变的事件 (该成员不是Bot)
+成员权限改变的事件 (该成员不是 Bot)
 
 - **Attributes**
 
@@ -404,7 +404,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
-群成员被禁言事件 (该成员不是Bot)
+群成员被禁言事件 (该成员不是 Bot)
 
 - **Attributes**
 
@@ -418,7 +418,7 @@ Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
 Bases: `alicebot.adapter.mirai.event.notice.GroupMemberEvent`
 
-群成员被取消禁言事件 (该成员不是Bot)
+群成员被取消禁言事件 (该成员不是 Bot)
 
 - **Attributes**
 
diff --git a/docs/api/adapter/mirai/event/request.md b/docs/api/adapter/mirai/event/request.md
@@ -90,7 +90,7 @@ Bases: `alicebot.adapter.mirai.event.request.RequestEvent`
 
 Bases: `alicebot.adapter.mirai.event.request.RequestEvent`
 
-用户入群申请 (Bot需要有管理员权限)
+用户入群申请 (Bot 需要有管理员权限)
 
 - **Attributes**
 
diff --git a/docs/api/adapter/mirai/index.md b/docs/api/adapter/mirai/index.md
@@ -125,7 +125,7 @@ Mirai 配置类，将在适配器被加载时被混入到机器人主配置中
 
   - **message\_type** (_Literal\['private', 'friend', 'group'\]_) - 消息类型。应该是 "private", "friend" 或者 "group"。其中 "private" 和 "friend" 相同。
 
-  - **target** (_int_) - 发送对象的 ID， QQ 号码或者群号码。
+  - **target** (_int_) - 发送对象的 ID，QQ 号码或者群号码。
 
   - **quote** (_Optional\[int\]_) - 引用的消息的 `messageId`。默认为 `None`，不引用任何消息。
 
diff --git a/docs/api/adapter/onebot/index.md b/docs/api/adapter/onebot/index.md
@@ -67,9 +67,9 @@ OneBot 配置类，将在适配器被加载时被混入到机器人主配置中
 
   - **NetworkError** - 网络错误。
 
-  - **ApiNotAvailable** - API 请求响应 404， API 不可用。
+  - **ApiNotAvailable** - API 请求响应 404，API 不可用。
 
-  - **ActionFailed** - API 请求响应 failed， API 操作失败。
+  - **ActionFailed** - API 请求响应 failed，API 操作失败。
 
   - **ApiTimeout** - API 请求响应超时。
 
@@ -134,7 +134,7 @@ OneBot 配置类，将在适配器被加载时被混入到机器人主配置中
   - **message\_type** (_Union\[Literal\['private', 'group'\], str\]_) - 消息类型。
   可以为 "private", "group" 或扩展的类型，和消息事件的 `detail_type` 字段对应。
 
-  - **id\_** (_str_) - 发送对象的 ID， QQ 号码或者群号码。
+  - **id\_** (_str_) - 发送对象的 ID，QQ 号码或者群号码。
 
 - **Returns**
 
diff --git a/docs/api/adapter/telegram/index.md b/docs/api/adapter/telegram/index.md
@@ -68,7 +68,7 @@ Telegram 适配器配置
 
   - **NetworkError** - 网络错误。
 
-  - **ActionFailed** - API 请求响应 failed， API 操作失败。
+  - **ActionFailed** - API 请求响应 failed，API 操作失败。
 
 ### _async method_ `handle_response(self, request)` {#TelegramAdapter-handle-response}
 
@@ -106,7 +106,7 @@ Telegram 适配器配置
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
diff --git a/docs/api/adapter/utils.md b/docs/api/adapter/utils.md
@@ -22,7 +22,7 @@ Bases: `alicebot.adapter.Adapter`
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
@@ -86,7 +86,7 @@ WebSocket 客户端适配器示例。
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
@@ -130,7 +130,7 @@ HTTP 服务端适配器示例。
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
@@ -208,7 +208,7 @@ WebSocket 服务端适配器示例。
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
@@ -310,7 +310,7 @@ WebSocket 适配器示例。
 
 适配器运行方法，适配器开发者必须实现该方法。
 
-适配器运行过程中保持保持运行，当此方法结束后， AliceBot 不会自动重新启动适配器。
+适配器运行过程中保持保持运行，当此方法结束后，AliceBot 不会自动重新启动适配器。
 
 - **Returns**
 
diff --git a/docs/api/exceptions.md b/docs/api/exceptions.md
@@ -2,7 +2,7 @@
 
 AliceBot 异常。
 
-下列是 AliceBot 运行过程中可能会抛出的异常。这些异常大部分不需要用户处理， AliceBot 会自动捕获并处理。
+下列是 AliceBot 运行过程中可能会抛出的异常。这些异常大部分不需要用户处理，AliceBot 会自动捕获并处理。
 对于适配器开发者，所有适配器抛出的异常都应该继承自 `AdapterException` 。
 
 ## _class_ `EventException` {#EventException}
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -120,9 +120,9 @@ implement default like this::
 
 - **Arguments**
 
-  - **path1** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径1。
+  - **path1** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径 1。
 
-  - **path2** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径2。
+  - **path2** (_Union\[str, bytes, PathLike\[str\], PathLike\[bytes\]\]_) - 路径 2。
 
 - **Returns**
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -216,7 +216,7 @@ sidebar: auto
 ### Features
 
 - **bot:** 修改热更新文件修改相关日志 ([3d587b3](https://github.com/AliceBotProject/alicebot/commit/3d587b3d7557956b5e46a6475e11888c6b88e8c6))
-- **utils:** 修改 load_module_from_name() 函数的行为，保证只会引发 ImportError、 LoadModuleError 和 KeyboardInterrupt 异常 ([54af514](https://github.com/AliceBotProject/alicebot/commit/54af514144236adad80e62953a311011fb784755))
+- **utils:**修改 load_module_from_name() 函数的行为，保证只会引发 ImportError、LoadModuleError 和 KeyboardInterrupt 异常 ([54af514](https://github.com/AliceBotProject/alicebot/commit/54af514144236adad80e62953a311011fb784755))
 
 ## [0.5.0](https://github.com/AliceBotProject/alicebot/compare/v0.4.0...v0.5.0) (2022-08-21)
 
diff --git a/docs/guide/adapters/cqhttp-adapter.md b/docs/guide/adapters/cqhttp-adapter.md
@@ -20,29 +20,29 @@ CQHTTP 协议适配器是 OneBot v11 协议 (原 CKYU 平台的 CQHTTP 协议) 
 
 ```yaml
 account:
-  uin: 机器人QQ号
+  uin: 机器人 QQ 号
   password: '机器人密码'
 
 message:
   # 上报数据类型
   # 注意：此处必须是 array
   post-format: array
 
-# 连接服务列表，下面的反向WS和正向WS请只选择一个
+# 连接服务列表，下面的反向 WS 和正向 WS 请只选择一个
 servers:
-  # 反向WS设置
+  # 反向 WS 设置
   - ws-reverse:
-      # 反向WS Universal 地址
+      # 反向 WS Universal 地址
       universal: ws://127.0.0.1:8080/cqhttp/ws
       # 重连间隔 单位毫秒
       reconnect-interval: 3000
       middlewares:
         <<: *default # 引用默认中间件
-  # 正向WS设置
+  # 正向 WS 设置
   - ws:
-      # 正向WS服务器监听地址
+      # 正向 WS 服务器监听地址
       host: 127.0.0.1
-      # 正向WS服务器监听端口
+      # 正向 WS 服务器监听端口
       port: 6700
       middlewares:
         <<: *default # 引用默认中间件
diff --git a/package.json b/package.json
@@ -17,7 +17,6 @@
     "docs:serve": "vitepress serve docs",
     "changelog": "conventional-changelog -p angular -i docs/changelog.md -s -r 0",
     "markdownlint": "markdownlint-cli2 '{*.md,docs/guide/**/*.md,packages/**/*.md}'",
-    "zhlint": "zhlint '{README.md,docs/guide/**/*.md,packages/**/*.md}'",
     "pyright": "pyright",
     "prettier": "prettier -c .",
     "prettier:fix": "prettier -w .",
@@ -43,8 +42,7 @@
     "prettier": "^3.5.3",
     "pyright": "^1.1.399",
     "typescript-eslint": "^8.30.1",
-    "vue-eslint-parser": "^10.1.3",
-    "zhlint": "^0.8.2"
+    "vue-eslint-parser": "^10.1.3"
   },
   "pnpm": {
     "peerDependencyRules": {
diff --git a/packages/alicebot-adapter-cqhttp/alicebot/adapter/cqhttp/__init__.py b/packages/alicebot-adapter-cqhttp/alicebot/adapter/cqhttp/__init__.py
diff --git a/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/__init__.py b/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/__init__.py
diff --git a/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/event/notice.py b/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/event/notice.py
diff --git a/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/event/request.py b/packages/alicebot-adapter-mirai/alicebot/adapter/mirai/event/request.py
diff --git a/packages/alicebot-adapter-onebot/alicebot/adapter/onebot/__init__.py b/packages/alicebot-adapter-onebot/alicebot/adapter/onebot/__init__.py
diff --git a/packages/alicebot-adapter-telegram/alicebot/adapter/telegram/__init__.py b/packages/alicebot-adapter-telegram/alicebot/adapter/telegram/__init__.py
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
