mirror of
https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
synced 2026-07-16 01:40:46 +08:00
e461208bf9
格式化工具部分： 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>
157 lines
5.8 KiB
Markdown
157 lines
5.8 KiB
Markdown
---
|
|
order: 1
|
|
icon: iconoir:developer
|
|
---
|
|
|
|
# 개발 환경 구축
|
|
|
|
::: tip
|
|
본 페이지는 주로 PR 과정 및 MAA의 파일 포맷 요구사항을 설명합니다. MAA의 실행 로직 변경에 대한 구체적인 내용은 [프로토콜 문서](../protocol/)를 참고하세요.
|
|
:::
|
|
|
|
## Github Pull Request 진행 과정
|
|
|
|
### 프로그래밍을 잘 모르지만, json 파일과 docs 문서를 수정하고싶어요. 어떻게 해야하나요?
|
|
|
|
[웹 기반 PR 가이드](./pr-tutorial.md)를 참고하세요! (GitHub.com 웹사이트에서만 가능합니다)
|
|
|
|
### 프로그래밍을 할 줄 알지만 GitHub/C++/...에 익숙하지 않아요. 어떻게 해야 하나요?
|
|
|
|
1. 이전에 fork 한 기록이 있다면 저장소 Settings 맨 아래에서 삭제
|
|
2. [MAA 메인 저장소](https://github.com/MaaAssistantArknights/MaaAssistantArknights)에서 Fork → Create fork 클릭
|
|
3. 본인 저장소의 dev 브랜치를 서브모듈 포함 클론:
|
|
|
|
```bash
|
|
git clone --recurse-submodules <저장소 git 링크> -b dev
|
|
```
|
|
|
|
::: warning
|
|
Visual Studio 등 --recurse-submodules 미지원 Git GUI 사용 시, 클론 후 다음 실행:
|
|
|
|
```bash
|
|
git submodule update --init
|
|
```
|
|
|
|
:::
|
|
|
|
4. 사전 빌드된 외부 라이브러리 다운로드
|
|
|
|
**Python 환경 필요 (별도 설치 필요)**
|
|
|
|
```cmd
|
|
python tools/maadeps-download.py
|
|
```
|
|
|
|
5. 개발 환경 구성
|
|
- Visual Studio 2022 Community 설치 시 `C++ 데스크톱 개발` 및 `.NET 데스크톱 개발` 필수 선택
|
|
|
|
6. MAA.sln 파일 더블클릭 → Visual Studio에서 프로젝트 자동 로드
|
|
7. VS 설정
|
|
- 상단 구성에서 RelWithDebInfo x64 선택 (릴리스 빌드/ARM 플랫폼 시 생략)
|
|
- MaaWpfGui 우클릭 → 속성 → 디버그 → 네이티브 디버깅 활성화 (C++ 코어 중단점 사용 가능)
|
|
|
|
8. 이제 자유롭게 ~~개조~~ 개발 시작!
|
|
9. 주기적 커밋 (메시지 필수 작성)
|
|
Git 초보자는 dev 브랜치 대신 새 브랜치 생성 권장:
|
|
|
|
```bash
|
|
git branch your_own_branch
|
|
git checkout your_own_branch
|
|
```
|
|
|
|
dev 브랜치 업데이트 영향에서 자유로움
|
|
|
|
10. 개발 완료 후 변경사항 원격 저장소로 푸시:
|
|
|
|
```bash
|
|
git push origin dev
|
|
```
|
|
|
|
11. [MAA 메인 저장소](https://github.com/MaaAssistantArknights/MaaAssistantArknights)에서 Pull Request 제출 (master 대신 dev 브랜치 지정 필수)
|
|
12. 업스트림 저장소 변경사항 동기화 방법:
|
|
1. 업스트림 저장소 추가:
|
|
|
|
```bash
|
|
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
|
|
```
|
|
|
|
2. 변경사항 가져오기:
|
|
|
|
```bash
|
|
git fetch upstream
|
|
```
|
|
|
|
3. 리베이스(권장) 또는 병합:
|
|
|
|
```bash
|
|
git rebase upstream/dev
|
|
```
|
|
|
|
또는
|
|
|
|
```bash
|
|
git merge
|
|
```
|
|
|
|
4. 단계 7, 8, 9, 10 반복 수행
|
|
|
|
::: tip
|
|
Visual Studio 실행 시 Git 작업은 "Git 변경" 탭에서 명령어 없이 처리 가능
|
|
:::
|
|
|
|
## MAA 파일의 포매팅 요구 사항
|
|
|
|
MAA는 리포지토리의 코드 및 리소스 파일들을 아름답고 일관적으로 유지하기 위해 일련의 포매팅 도구를 사용합니다.
|
|
|
|
제출하기 전에 포맷을 지정했거나 [Pre-commit Hooks를 사용하여 자동 포매팅을 활성화](#pre-commit-hooks를-사용하여-자동-포매팅을-활성화)를 했는지 확인하세요.
|
|
|
|
현재 활성화된 포매팅 도구는 다음과 같습니다:
|
|
|
|
| 파일 유형 | 포매팅 도구 |
|
|
| --------- | --------------------------------------------------------------- |
|
|
| C++ | [clang-format](https://clang.llvm.org/docs/ClangFormat.html) |
|
|
| Json/Yaml | [Prettier](https://prettier.io/) |
|
|
| Markdown | [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) |
|
|
|
|
### Pre-commit Hooks를 사용하여 자동 포매팅을 활성화
|
|
|
|
1. Python 및 Node 환경이 컴퓨터에 설치되어 있는지 확인하세요.
|
|
|
|
2. 프로젝트 루트 디렉터리에서 다음 명령을 실행하세요.
|
|
|
|
```bash
|
|
pip install pre-commit
|
|
pre-commit install
|
|
```
|
|
|
|
pip 설치 후에도 Pre-commit을 실행할 수 없다면, PIP 설치 경로가 PATH에 추가되었는지 확인하세요.
|
|
|
|
이제, 매번 커밋할 때마다 포매팅 도구가 자동으로 실행되어 코드 형식이 규칙에 맞는지 확인합니다.
|
|
|
|
## Visual Studio에서 clang-format 사용 설정
|
|
|
|
1. clang-format 20.1.0 또는 그 이상 버전을 설치합니다.
|
|
|
|
```bash
|
|
python -m pip install clang-format
|
|
```
|
|
|
|
2. Everything 등의 도구를 사용하여 clang-format.exe의 설치 위치를 찾습니다. 참고로 Anaconda를 사용하는 경우 clang-format.exe는 YourAnacondaPath/Scripts/clang-format.exe에 설치됩니다.
|
|
|
|
3. Visual Studio에서 `도구`-`옵션`을 검색하여 `clang-format`을 클릭합니다.
|
|
4. `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++ 개발 환경을 구성하세요.
|
|
|
|
[](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights?devcontainer_path=.devcontainer%2F1%2Fdevcontainer.json)
|