mirror of
https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
synced 2026-07-16 17:57:01 +08:00
格式化工具部分: 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>
93 lines
2.8 KiB
Python
93 lines
2.8 KiB
Python
# WHAT DOES THIS TOOL DO?
|
|
#
|
|
# This tool sorts the global json files so that they are in the same order as
|
|
# the ZH ones. This way, it is easier to find the attributes, see what is
|
|
# missing, etc.
|
|
#
|
|
# USAGE
|
|
#
|
|
# 1. Install Python
|
|
# 2. Run "$python match_json.py xxx" in the terminal where xxx is the desired
|
|
# server name i.e. YoStarJP/YoStarEN/YoStarKR/txwy
|
|
# 3. The json file will be updated in-place
|
|
#
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
from collections import OrderedDict
|
|
|
|
server_list = {
|
|
"YoStarJP": ["yostarjp", "jp", "日", "日服"],
|
|
"YoStarEN": ["yostaren", "en", "美", "美服", "國際", "國際服"],
|
|
"YoStarKR": ["yostarkr", "kr", "韓", "韓服"],
|
|
"txwy": ["txwy", "繁中", "繁中服"],
|
|
}
|
|
|
|
# Get the server name from argument
|
|
try:
|
|
# server_name = YoStarJP
|
|
server_name = None
|
|
for listed_server in server_list:
|
|
server_name = (
|
|
listed_server
|
|
if (not server_name)
|
|
and sys.argv[1].casefold() in server_list[listed_server]
|
|
else server_name
|
|
)
|
|
if server_name not in server_list:
|
|
raise
|
|
except Exception:
|
|
server_name = None
|
|
while not server_name:
|
|
print("Enter one and only one server name:", ", ".join(server_list))
|
|
t = input()
|
|
for listed_server in server_list:
|
|
server_name = (
|
|
listed_server
|
|
if (not server_name) and t.casefold() in server_list[listed_server]
|
|
else server_name
|
|
)
|
|
|
|
cur_dir = os.path.dirname(os.path.abspath(__file__))
|
|
proj_dir = os.path.join(cur_dir, "../../")
|
|
|
|
# File name of the json
|
|
# NOTE: You may change this to e.g. recruitment.json
|
|
# This is hardcoded because tasks.json is the most likely modified one
|
|
try:
|
|
json_name = sys.argv[2]
|
|
except IndexError:
|
|
json_name = "tasks.json"
|
|
|
|
zh_json_file = os.path.join(proj_dir, "resource", json_name)
|
|
gl_json_file = os.path.join(
|
|
proj_dir, "resource", "global", server_name, "resource", json_name
|
|
)
|
|
|
|
# For test purpose
|
|
# gl_json_file = os.path.join(cur_dir, "test.json")
|
|
|
|
with open(zh_json_file, "r", encoding="utf-8") as zh_fh:
|
|
zh_json = json.load(zh_fh)
|
|
|
|
with open(gl_json_file, "r", encoding="utf-8") as gl_fh:
|
|
gl_json = json.load(gl_fh)
|
|
|
|
# Sort the global json object by the order of the ZH one
|
|
# Keys not found in ZH json will be put at the end (should not happen though)
|
|
LAST_POSITIONS = 1e10
|
|
key_order = {k: v for v, k in enumerate(zh_json)}
|
|
gl_json_new = OrderedDict(
|
|
sorted(gl_json.items(), key=lambda i: key_order.get(i[0], LAST_POSITIONS))
|
|
)
|
|
|
|
with open(gl_json_file, "wb") as gl_fh:
|
|
t = json.dumps(gl_json_new, indent=4, ensure_ascii=False)
|
|
gl_fh.write(bytes(t, "utf-8"))
|
|
print(
|
|
"successfully sorted",
|
|
os.path.join("resource", "global", server_name, "resource", json_name),
|
|
"by the order in ZH json file",
|
|
)
|