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>
105 lines
4.0 KiB
Markdown
105 lines
4.0 KiB
Markdown
---
|
|
order: 8
|
|
icon: iconoir:code-brackets
|
|
---
|
|
|
|
# Dedicated VSCode Extension Tutorial
|
|
|
|
- [Extension Store](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)
|
|
- [Repository](https://github.com/neko-para/maa-support-extension)
|
|
|
|
## Installation
|
|
|
|
Searching `Maa` and installing it from VSCode extensions list is recommended.
|
|
|
|
## Features
|
|
|
|
### Control Panel
|
|
|
|
A dedicated control panel is added to the left, with icon 
|
|
|
|
The major features of the extension are based on the `interface.json` configuration. Select the activated `interface.json` on the top of the control panel.
|
|
|
|
The extension has a `Maa` compatiable mode. If `src/MaaCore` folder exists inside the opened workspace, the mode will be enabled automatically.
|
|
|
|
### Semantic resource analysis
|
|
|
|
Select expected resource via the `Resource` select inside the control panel. The extension will index and diagnose resource via corresponding paths.
|
|
|
|
If you find that the editing json isn't hinted by the extension, please check if the activated resource contains it.
|
|
|
|
> The term `definitions of task / task defs` refers to key props of task objects.
|
|
>
|
|
> The term `references of task / task refs` refers to values containing task name (e.g. in `next`) in other task objects.
|
|
|
|
#### Query task defs / task refs
|
|
|
|
The extension supports Jump to task defs, Jump to task refs and View task defs.
|
|
|
|
When enabling the `Maa` compatible mode, the extension will be able to parse `template task`, supporting querying task defs and task refs in conjunction with base tasks. Images that has the same name of the task will be shown when hovering the task defs.
|
|
|
|
#### Query / open images
|
|
|
|
The extension supports open images.
|
|
|
|
When enabling the `Maa` compatible mode, the extension will be able to recursively search for the image.
|
|
|
|
#### Task completion
|
|
|
|
The extension supports autocompletion according to all known tasks.
|
|
|
|
When enabling the `Maa` compatible mode, typing `@` will trigger completion.
|
|
|
|
#### Image path completion
|
|
|
|
The extension supports autocompletion according to the path of all known images.
|
|
|
|
When enabling the `Maa` compatible mode, the extension will be able to recursively search for the image.
|
|
|
|
#### Check tasks / image paths
|
|
|
|
The extension supports scheduled scanning and diagnosing all tasks.
|
|
|
|
- Check if contains task defs with same names.
|
|
- Check if contains unknown task refs.
|
|
- Check if contains unknown image refs.
|
|
- Check if contains duplicated task refs in a single task.
|
|
|
|
#### Multiple paths resource support
|
|
|
|
The extension supports resource with multiple paths. The extension will perform logical overlapping according to specified order, thus content loaded later can reference content loaded earlier.
|
|
|
|
### Evaluate Task / Tsak List Expression (Only Maa)
|
|
|
|
Evaluating the expanded task object and the sources of each properties, and the result of the task list expression via the control panel.
|
|
|
|
### MaaPiCli feature (Only MaaFramework projects)
|
|
|
|
Scanning and selecting controllers, selecting resource, adding and manipulating tasks, and launching tasks can be done via the control panel.
|
|
|
|
### Take screenshots and crop images
|
|
|
|
Searching and launching `Maa: open crop tool` inside VSCode command panel can open `Screenshots / Crop` panel.
|
|
|
|
> Use `Ctrl+Shift+P` (`Command+Shift+P` on MacOS) to open command panel
|
|
|
|
- After selecting and connecting to the controller, use `Screencap` button to obtain screenshots
|
|
- Use `Upload` button to manually upload images.
|
|
- Hold `Ctrl` key and select cropping area
|
|
- Use wheels to zoom
|
|
- After finishing cropping, use `Download` button to save the cropping result to the folder of the topest layer of the activated resource
|
|
|
|
### Bottom status bar
|
|
|
|
#### MaaSupport \[Extension Version\]
|
|
|
|
Click to reveal control panel
|
|
|
|
#### MaaFramework \[MaaFw Version\]
|
|
|
|
Click to switch `MaaFramework` version used by the extension
|
|
|
|
> When used for the first time, the preset version will be downloaded.
|
|
>
|
|
> Search command `Maa: select fetch registry` to switch downloading source (npm / cnpm).
|