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

Files

Lucien Shaw e461208bf9 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.0 KiB

Raw Blame History

order, icon

order	icon
1	iconoir:developer

開発を開始

Github Pull Request プロセス概要

プログラミングの仕方がわからないので、JSONファイルやドキュメントなどを少し変更したいのですが、どうすればいいですか？

「パラスちゃん」も理解できるGitHubのPull Requestの使用ガイドへようこそ（純WebサイトのPRチュートリアル）

プログラミングの仕方を知っていますが、GitHub/C++/...... に触れたことがありません、どうすればいいですか？

かなり前にフォークした場合は、まず自分のリポジトリの 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環境が必要（インストール方法は各自検索）
（tools/maadeps-download.py はプロジェクトルートに配置）
```
python tools/maadeps-download.py
```
開発環境の設定
- Visual Studio 2022 Community をインストール時、C++ によるデスクトップ開発 と .NET デスクトップ開発 を選択必須
MAA.sln をダブルクリックで開き、Visual Studio にプロジェクトを自動ロード
VS の設定
- 上部設定バーで RelWithDebInfo x64 を選択（Release ビルド/ARM プラットフォームの場合は不要）
- MaaWpfGui 右クリック → プロパティ → デバッグ → ネイティブデバッグを有効化（C++ Core へのブレークポイント設定可能）
これで自由に改造開発を始められます
一定量の変更ごにコミット（メッセージ記入必須）
Git 未経験者は dev ブランチ直接変更ではなく新規ブランチ作成推奨：
```
git branch your_own_branch
git checkout your_own_branch
```
これで dev の更新影響を受けずに開発可能
開発完了後、変更をリモートリポジトリへプッシュ：
```
git push origin dev
```
MAA メインリポジトリで Pull Request を提出（master ではなく dev ブランチを指定）
上流リポジトリの更新を同期する場合：
1. 上流リポジトリを追加：
```
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
```
2. 更新を取得：
```
git fetch upstream
```
3. リベース（推奨）またはマージ：
```
git rebase upstream/dev
```
  または
```
git merge
```
4. ステップ7、8、9、10 を繰り返し

::: tip Visual Studio 起動後、Git 操作は「Git 変更」画面からコマンドライン不要で可能 :::

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で、 Tools-Optionsで 'clang-format'を検索します。
clang-formatサポートを有効にする をクリックし、下の カスタムのclang-format.exeファイルを使用する を選択し、最初取得した 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.0 KiB Raw Blame History Unescape Escape