mirror of https://github.com/MaaAssistantArknights/MaaAssistantArknights.git synced 2026-07-15 17:30:27 +08:00

Files

Lucien Shaw 14194d1118 chore: 完善容器配置及依赖安装 (#14208 )

格式化工具部分：
1. pre-commit 引入 python 的格式化工具，包括 black（代码格式化）和 isort（对“包导入顺序”的规范）
2. 允许 prettier 对文档站的 markdown 文件格式化
3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化
4. 升级了 pre-commit 的各个 hook 的版本
5. 优化了 pre-commit 的日志文本显示

容器总览部分：
1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境
2. 空环境是裸 Linux 镜像（Ubuntu），为默认环境
3. 轻量环境适合开发文档站前端
4. 全量环境适合开发 MaaCore
5. 目前，全量环境完整包含了轻量环境，轻量环境完整包含了空环境
6. 在仓库 README.md 中更新了三个环境的描述，并将链接分别设置为对应环境的创建链接
   **注意：没有修改文档站中的对应文件**
7. 在各个语言的开发指南的最后，移除了 Codespace 部分的“安装额外依赖”相关描述，且将链接设置为全量环境的创建链接
   **注意：没有添加“开发文档站”的指南和对应 codespace 的使用方式**

容器的轻量环境和全量环境共有部分：
1. 安装 black 和 isort 包
2. 调整 VS Code 设置，取消先前（对 markdown 文件单独指定 markdownlint 扩展作为格式化工具）的错误设置，现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具
3. 引入 markdown-all-in-one 扩展作为语法提示工具
4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外

容器的全量环境部分：
1. 为 tools 下的所有 python 脚本安装依赖
2. 使用 tools/maadeps-download.py 下载 maadeps，且将必要二进制文件软链接到 /usr/local/bin/
3. 使用 apt 安装 cmake 和 clangd-20，将后者通过 update-alternatives 设置为系统 clangd 的默认版本
4. 使用 cmake tools 扩展，并按照 Linux 编译方法进行配置
5. 使用 clang-format 作为 c/cpp 的格式化工具，clang-format 程序主体来自 maadeps（已经软链接到 /usr/local/bin/）
6. 使用 clangd 作为 c/cpp 的语法提示工具
7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外

其它手动调整：
1. 更新文档站的 package.json，指定 pnpm 包管理器的版本
2. 手动保证 markdown 文件中的列表前后有空行（注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题，详见：https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines ）
3. 修改了部分 markdown 文件中的 json 代码块的语法问题
   **注意：相同的问题并未全部发现，仅修改了两处**
4. 在 tools 目录中，一处 python 脚本的包名误用（本地包名和某个 pip 包重名），这里修改了相应代码
5. 在 tools 目录中，一处 python 脚本使用了弃用的包 cchardet 的问题，这里更换了推荐使用的功能相近的包并修改了相应代码

自动化脚本提交的修改：
1. 自动格式化了大量 tools 中的 python 脚本
2. 自动格式化了大量 docs 中的 markdown 文件

Commits:

* chore: pre-commit引入black和isort规范py文件

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: devcontainer添加isort扩展，排序python导入

* chore: pre-commit任务命名及更名

* style: isort fix

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: 更新pre-commit的hook版本

* fix: 模块名与第三方库重名，大忌

* chore: 容器构建时额外安装isort

* docs: md -> markdown

* chore: 容器安装python包和maadeps

* fix: 修复过时python包

* chore: 指定pnpm版本

* chore: container支持选择轻量环境

* chore: 去掉rust

* chore: add plain env

* chore: 使用clangd语言服务器

* chore: 无需单独设置markdown的格式化工具

* chore: 更新安装的clangd版本

* docs: 简易文档适配

* docs: 在仓库README中重新编排codespaces相关指引

* chore: Auto update by pre-commit hooks [skip changelog]

* style: 调整缩进

* chore: 格式化工具不用特意排除被gitignore忽略的文件

* chore: sh文件在gitattributes中单列一类

* chore: 格式化docs下的markdown文件

* chore: 暂时不修改md文件中的代码块

* style: 人为明确markdown中的部分列表相关格式

* docs: 补上部分markdown的json代码块中缺失的逗号

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: 补上tools的服务器排序相关代码中缺失的逗号

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: 使用maadeps的clangd

* build: 更新maadeps工具链版本

* style: prettier fix

* revert: 还原maadeps版本

* revert: 取消使用maadeps的clangd依赖，改用系统apt安装

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

2025-09-30 19:39:48 +08:00

5.5 KiB

Raw Blame History

order, icon

order	icon
1	iconoir:developer

開發前須知

Github Pull Request 流程簡述

我不懂寫程式，只是想改一點點 JSON 文件/文件等，要怎麼操作？

歡迎收看牛牛也能看懂的 GitHub Pull Request 使用指南（純網頁端操作 Github.com）

我會寫程式，但沒接觸過 GitHub/C++/……，要怎麼操作？

如果很久以前 Fork 過，先在自己倉庫的 Settings 裡，翻到最下面，刪除
打開 MAA 主倉庫，點擊 Fork，繼續點擊 Create fork
複製你自己倉庫下的 dev 分支到本地，並拉取子模組
```
git clone --recurse-submodules <你的倉庫的 git 連結> -b dev
```
::: warning 如果正在使用 Visual Studio 等不附帶 --recurse-submodules 參數的 Git GUI，則需在複製後再執行 git submodule update --init 以拉取子模組。 :::
下載預構建的第三方庫

需要有 Python 環境，請自行搜索 Python 安裝教學
```
python tools/maadeps-download.py
```
配置編程環境
- 下載並安裝 Visual Studio 2022 community, 安裝的時候需要選中 基於 C++ 的桌面開發 和 .NET 桌面開發。
雙擊打開 MAA.sln 文件，Visual Studio 會自動載入整個項目。
設置 VS
- VS 上方配置選擇 RelWithDebInfo x64 （如果編譯 Release 包或 ARM 平台，請忽略這步）
- 右鍵 MaaWpfGui - 屬性 - 除錯 - 啟用本地除錯（這樣就能把斷點掛到 C++ Core 那邊了）
到這裡，你就可以愉快地 ~~瞎 JB 改~~ 發電了
開發過程中，每一定數量，記得提交一個 Commit, 別忘了寫上 Message
假如你不熟悉 git 的使用，你可能想要新建一個分支進行更改，而不是直接提交在 dev 上
```
git branch your_own_branch
git checkout your_own_branch
```
這樣你的提交就能在新的分支上生長，不會受到 dev 更新的打擾
完成開發後，推送你修改過的本地分支（以 dev 為例）到遠程（Fork 的倉庫）
```
git push origin dev
```
打開 MAA 主倉庫。提交一個 Pull Request，等待管理員通過。別忘了你是在 dev 分支上修改，別提交到 master 分支去了
當 MAA 原倉庫出現更改（別人做的），你可能需要把這些更改同步到你的分支
1. 關聯 MAA 原倉庫
```
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
```
2. 從 MAA 原倉庫拉取更新
```
git fetch upstream
```
3. 變基（推薦）或者合併修改
```
git rebase upstream/dev # 變基
```
  或者
```
git merge # 合併
```
4. 重複上述 7, 8, 9, 10 中的操作

::: tip 在打開 VS 之後，和 Git 有關的操作可以不用命令行工具，直接使用 VS 自帶的“Git 更改”即可 :::

MAA 的檔案格式化要求

MAA 使用一系列的格式化工具來保證倉庫中的代碼和資源文件美觀統一，以便於維護和閱讀

請確保在提交之前已經格式化，或是啟用 Pre-commit Hooks 來進行自動格式化

目前啟用的格式化工具如下：

文件類型	格式化工具
C++	clang-format
Json/Yaml	Prettier
Markdown	markdownlint

利用 Pre-commit Hooks 自動進行程式碼格式化

確保你的電腦上有 Python 與 Node 環境

在項目根目錄下執行以下命令

pip install pre-commit
pre-commit install

如果pip安裝後依然無法運行 Pre-commit，請確認 PIP 安裝地址已被添加到 PATH

接下來，每次提交時都將會自動運行格式化工具，來確保你的代碼格式符合規範

在 Visual Studio 中啟用 clang-format

安裝 clang-format 20.1.0 或更高版本
```
python -m pip install clang-format
```
使用 Everything 等工具找到 clang-format.exe 的安裝位置。作為參考，若您使用了 Anaconda，clang-format.exe 將安裝在 YourAnacondaPath/Scripts/clang-format.exe
在 Visual Studio 工具-選項 中搜索 clang-format
點擊 啟用 ClangFormat 支持，然後選擇下面的 使用自訂 clang-format.exe 文件，選擇第 2 步找到的 clang-format.exe

然後你的 Visual Studio 就能愉快的使用支持 C++20 語法的 clang-format 啦！

你也可以使用 tools\ClangFormatter\clang-formatter.py 來直接調用你的 clang-format 來進行格式化，只需要在項目根目錄下執行：

python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore

使用 GitHub codespace 進行在線開發

創建 GitHub codespace 自動配置 C++ 開發環境

5.5 KiB Raw Blame History Unescape Escape