✨ feat(husky): add git hooks

add husky add zhlint format & lint everything now we can run `docs:zhlint` to format Chinese docs also automatically run before commiting changes
GlobeMC · Oct 20, 2023 · 79b3cd3 · 79b3cd3
1 parent 83be511
commit 79b3cd3
Show file tree

Hide file tree

Showing 23 changed files with 1,306 additions and 13 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo "running docs:eslint"
+pnpm run docs:eslint
+echo "running docs:zhling"
+pnpm run docs:zhlint
+echo "running docs:format"
+pnpm run docs:format
diff --git a/.zhlintignore b/.zhlintignore
@@ -0,0 +1 @@
+docs/.vitepress
diff --git a/.zhlintrc b/.zhlintrc
@@ -0,0 +1,6 @@
+{
+  "preset": "markdown",
+  "rules": {
+    " unifiedPunctuation": "traditonal"
+  }
+}
diff --git a/docs/analyzer.md b/docs/analyzer.md
@@ -21,13 +21,15 @@ import Analyzer from './.vitepress/theme/components/Analyzer.vue'
 ---
 
 :::tip 帮助
+
 - **分析日志之前请确保你使用的是最新版启动器。**
 - 如分析模块长时间未响应请刷新页面重试。
 - 如果分析工具提供的解决方案无效，或者本工具还未收录您遇到的错误时，请在页面下方留言。
 - 本工具仍在起步阶段，我们会不断优化用户体验。
 :::
 
 :::warning 隐私声明
+
 - 所有文件的分析仅会在本地进行，仅会有部分错误信息被上传到云端。
 :::
 

diff --git a/docs/basis.md b/docs/basis.md
@@ -115,3 +115,13 @@ A：要对 `Minecraft` 的游戏错误 / 崩溃进行处理，您首先要对游
 
 **本文档所提供的方案仅供参考，您操作造成的问题由您自行承担！！！**
 :::
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/client/index.md b/docs/client/index.md
@@ -105,3 +105,12 @@ Minecraft 客户端，是 Minecraft 游戏本身一大组成部分。通俗来
 得到了崩溃日志，就可以处理崩溃了。在接下来的文档中，有针对于 Mod 问题、系统问题、原版问题的解决方案，您可以对照日志自行参考解决。
 
 最后，希望我们能帮助您成功解决问题，祝您游玩愉快！
+
+
+
+
+
+
+
+
+
diff --git a/docs/client/mods.md b/docs/client/mods.md
@@ -27,7 +27,7 @@ Unsupported class file major version
 
 | 关键词                                                 | 解决方案                                |
 | ------------------------------------------------------ | --------------------------------------- |
-| `no such method: sun.misc.Unsafe.defineAnonymousClass` | Java 版本过高，降低 Java 版本至 [Java 8u312](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) 或者 [Java 11.0.13](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/11.0.13%2B8/bellsoft-jre11.0.13+8-windows-amd64-full.msi) |
+| `no such method: sun.misc.Unsafe.defineAnonymousClass` | Java 版本过高，降低 Java 版本至 [Java 8u312](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) 或者 [Java 11.0.13](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/11.0.13%2B8/bellsoft-jre11.0.13+8-windows-amd64-full.msi) |
 
 附 Java 版本查询列表
 
@@ -65,7 +65,7 @@ Unsupported class file major version
 :::
 
 :::details 其他 Java 获取方法
-从官网下载并手动安装 Java: [Java 8](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) | [JDK 17+](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
+从官网下载并手动安装 Java: [Java 8](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) | [JDK 17+](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
 
 获取 (Java 9+) 且已存档的 JDK 包: <https://bell-sw.com/pages/downloads/#downloads>
 :::
@@ -497,3 +497,12 @@ java.lang.NoSuchMethodError: net.minecraft.launchwrapper.ITweaker.injectIntoClas
 
 TRANSFORMER/net.optifine/net.optifine.reflect.Reflector.<clinit>(Reflector.java
 ```
+
+
+
+
+
+
+
+
+
diff --git a/docs/client/shared.md b/docs/client/shared.md
@@ -11,3 +11,12 @@
 ```
 Manually triggered debug crash
 ```
+
+
+
+
+
+
+
+
+
diff --git a/docs/client/system.md b/docs/client/system.md
@@ -90,7 +90,7 @@ Could not reserve enough space
 :::
 
 :::details 其他 Java 获取方法
-从官网下载并手动安装 Java: [Java 8](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) | [JDK 17+](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
+从官网下载并手动安装 Java: [Java 8](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi) | [JDK 17+](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
 
 获取 (Java 9+) 且已存档的 JDK 包: <https://bell-sw.com/pages/downloads/#downloads)>
 :::
@@ -122,7 +122,7 @@ OpenJ9 is incompatible
 :::
 
 :::details 其他 Java 获取方法
-从官网下载并手动安装 Java: [Java 8](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi | [JDK 17+](https://ghproxy.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
+从官网下载并手动安装 Java: [Java 8](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/8u312%2B7/bellsoft-jre8u312+7-windows-amd64-full.msi | [JDK 17+](https://cdn.crashmc.com/https://github.com/bell-sw/Liberica/releases/download/17.0.1%2B12/bellsoft-jdk17.0.1+12-windows-amd64.msi)
 
 获取 (Java 9+) 且已存档的 JDK 包: <https://bell-sw.com/pages/downloads/#downloads>
 :::
@@ -219,3 +219,12 @@ class io.github.reserveword.imblocker.IMBlocker$RegistryEvents
 ```
 
 解决方案：将游戏路径中的非 ASCII 字符去掉
+
+
+
+
+
+
+
+
+
diff --git a/docs/client/vanilla.md b/docs/client/vanilla.md
@@ -107,7 +107,7 @@ java.lang.IllegalStateException: failed to create a child event loop
 2. 如您安装了 McAfee（及其衍生产品）或 Outpost Security，尝试卸载该软件并再次重新启动游戏。
 3. 如您没有防病毒安全软件，尝试在 Microsoft Defender 中的 “防火墙和网络保护” 中关闭 “专用网络保护”。
 4. 关闭您的加速器或 VPN。
-5. 前往 Oracle 官网下载最新版 Java，并将该 Java 设置为游戏 Java。
+5. 前往 Bellsoft 官网下载最新版 Java，并将该 Java 设置为游戏 Java。
 
 :::details 常见的第三方启动器设置版本 Java 功能位置
 
@@ -163,4 +163,4 @@ netsh int ipv6 reset reset.log
 请注意，重复此办法打开存档数次后，存档将愈加难以成功进入。
 :::
 
-进入游戏后，重复尝试进入存档，通常会有很大概率在第二次成功打开存档。
+进入游戏后，重复尝试进入存档，通常会有很大概率在第二次成功打开存档。。。。。。。。。。
diff --git a/docs/contribute/contributing.md b/docs/contribute/contributing.md
@@ -66,3 +66,12 @@ contributors: [用户名, 用户名, 用户名]
 - 请一定要使用 GitHub 用户名署名，否则我们无法获取您的头像。
 - 上述代码中所使用的均为英文半角逗号！
 :::
+
+
+
+
+
+
+
+
+
diff --git a/docs/contribute/contributors.md b/docs/contribute/contributors.md
@@ -16,3 +16,12 @@ GlobeMC 河豚分析是一个 2023 年 7 月底成立的崩溃日志分析组织
 此处列出了本文档的所有贡献者，感谢他们为文档作出的贡献。
 
 <VPTeamMembers size="small" :members="members" />
+
+
+
+
+
+
+
+
+
diff --git a/docs/contribute/crash-report.md b/docs/contribute/crash-report.md
@@ -9,3 +9,12 @@ contributors: [bingling-sama]
 :::info 注意
 在提交崩溃报告时，您首先要在 [GitHub](https://github.com) 网站注册一个帐号，以便我们对问题的后续跟踪。
 :::
+
+
+
+
+
+
+
+
+
diff --git a/docs/index.md b/docs/index.md
@@ -47,3 +47,13 @@ features:
 title: CrashMC
 titleTemplate: 为一般玩家编写的 Minecraft 崩溃分析指南
 ---
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/mixin.md b/docs/mixin.md
@@ -61,3 +61,13 @@ org.spongepowered.asm.mixin.injection.throwables.InvalidInjectionException: @At(
 删除掉其中任意一个模组
 
 ### Mod 版本 / Mod 所适用的 Minecraft 版本错误
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/hybrid.md b/docs/server/hybrid.md
@@ -7,3 +7,12 @@
 ## Bukkit & Forge
 
 ## Bukkit & Fabric
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/index.md b/docs/server/index.md
@@ -17,3 +17,12 @@
 一般而言，最新的日志文件在 `logs\latest.log`，而崩溃报告在 `crash-reports` 目录下。
 
 得到日志文件后，就可以根据后续的文档处理崩溃了。您也可以使用[崩溃分析工具](https://crashmc.com/analyzer.html)，将日志文件打包成 zip 并上传尝试分析。祝您成功解决问题！
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/mods.md b/docs/server/mods.md
@@ -36,3 +36,12 @@ Failed to load class net.coderbot.iris.Iris
 ## NeoForge
 
 待补充
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/plugins.md b/docs/server/plugins.md
@@ -32,3 +32,12 @@ java.lang.RuntimeException: Server attempted to load chunk saved with newer vers
 ### BungeeCord 及其衍生服务端
 
 ### Velocity 及其衍生服务端
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/shared.md b/docs/server/shared.md
@@ -23,3 +23,12 @@ You need to agree to the EULA in order to run the server. Go to eula.txt for mor
 ```
 Perhaps a server is already running on that port?
 ```
+
+
+
+
+
+
+
+
+
diff --git a/docs/server/vanilla.md b/docs/server/vanilla.md
@@ -3,3 +3,12 @@
 :::info WIP
 即将到来
 :::
+
+
+
+
+
+
+
+
+
diff --git a/package.json b/package.json
@@ -4,8 +4,10 @@
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
     "docs:format": "prettier --write .",
-    "docs:lint": "eslint --ignore-path .gitignore --ext .ts,.vue \"docs/.vitepress/**/*.{ts,vue}\"",
-    "docs:tsc": "tsc --noEmit --module es2022 --skipDefaultLibCheck"
+    "docs:eslint": "eslint --ignore-path .gitignore --ext .ts,.vue \"docs/.vitepress/**/*.{ts,vue}\" --fix",
+    "docs:zhlint": "zhlint docs/**/*.md --fix",
+    "docs:tsc": "tsc --noEmit --module es2022 --skipDefaultLibCheck",
+    "prepare": "husky install"
   },
   "name": "mccrash-docs",
   "version": "0.0.0",
@@ -21,14 +23,16 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier-vue": "^4.2.0",
     "eslint-plugin-vue": "^9.17.0",
+    "husky": "^8.0.3",
     "prettier": "^3.0.2",
     "sass": "^1.68.0",
     "tslib": "^2.6.1",
     "vite-plugin-pwa": "^0.16.4",
     "vitepress": "1.0.0-rc.20",
     "vue": "^3.3.4",
     "vue-eslint-parser": "^9.3.1",
-    "workbox-window": "^7.0.0"
+    "workbox-window": "^7.0.0",
+    "zhlint": "^0.7.1"
   },
   "keywords": [
     "Minecraft",