mirror of
https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
synced 2026-07-16 01:40:46 +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>
182 lines
6.5 KiB
Python
182 lines
6.5 KiB
Python
import argparse
|
||
import json
|
||
import os
|
||
import re
|
||
from pathlib import Path
|
||
|
||
|
||
def sort_tasks(res: dict[str, any]):
|
||
classified_lists = {
|
||
"UseSupportUnit...": [],
|
||
"...@UseSupportUnit...": [],
|
||
"Roguelike...": [],
|
||
"Roguelike@...": [],
|
||
"Phantom@Roguelike...": [],
|
||
"Mizuki@Roguelike...": [],
|
||
"Sami@Roguelike...": [],
|
||
"Sarkaz@Roguelike...": [],
|
||
"...@Roguelike...": [],
|
||
"Reclamation...": [],
|
||
"Reclamation@...": [],
|
||
"Fire@Reclamation...": [],
|
||
"Tales@RA...": [],
|
||
"...@Reclamation...": [],
|
||
}
|
||
unclassified_list = []
|
||
|
||
classify_rules: list[tuple[str, list]] = [
|
||
(r"^UseSupportUnit", classified_lists["UseSupportUnit..."]),
|
||
(r"^(\w+)@UseSupportUnit", classified_lists["...@UseSupportUnit..."]),
|
||
(r"^Roguelike@", classified_lists["Roguelike@..."]),
|
||
(r"^Roguelike", classified_lists["Roguelike..."]),
|
||
(r"^Phantom@Roguelike", classified_lists["Phantom@Roguelike..."]),
|
||
(r"^Mizuki@Roguelike", classified_lists["Mizuki@Roguelike..."]),
|
||
(r"^Sami@Roguelike", classified_lists["Sami@Roguelike..."]),
|
||
(r"^Sarkaz@Roguelike", classified_lists["Sarkaz@Roguelike..."]),
|
||
(r"^(\w+)@Roguelike", classified_lists["...@Roguelike..."]),
|
||
(r"^Reclamation@", classified_lists["Reclamation@..."]),
|
||
(r"^Reclamation", classified_lists["Reclamation..."]),
|
||
(r"^Fire@Reclamation", classified_lists["Fire@Reclamation..."]),
|
||
(r"^Tales@RA", classified_lists["Tales@RA..."]),
|
||
(r"^(\w+)@Reclamation", classified_lists["...@Reclamation..."]),
|
||
(r"", unclassified_list),
|
||
]
|
||
|
||
for k in res.keys():
|
||
for rule, target_list in classify_rules:
|
||
if re.search(rule, k):
|
||
target_list.append(k)
|
||
break
|
||
|
||
return {
|
||
k: res[k]
|
||
for k in unclassified_list
|
||
+ sum([sorted(target_list) for target_list in classified_lists.values()], [])
|
||
}
|
||
|
||
|
||
def raise_on_duplicate_keys(pairs):
|
||
"""检查重复键,存在时抛出 ValueError"""
|
||
seen = {}
|
||
for key, value in pairs:
|
||
if key in seen:
|
||
raise ValueError(f"Duplicate key detected: {repr(key)}")
|
||
seen[key] = value
|
||
return seen
|
||
|
||
|
||
# 示例JSON数据(包含重复键)
|
||
json_str = '{"name": "Alice", "age": 30, "name": "Bob"}'
|
||
|
||
|
||
def main(cn_base_path, global_resources):
|
||
|
||
cn_tasks = {}
|
||
cn_order = {}
|
||
# 使用 Path 处理路径,确保跨平台兼容
|
||
cn_base_path = Path(cn_base_path)
|
||
for root, dirs, files in os.walk(cn_base_path):
|
||
for file in files:
|
||
if not file.endswith(".json"): # 判断是否为 JSON 文件
|
||
continue
|
||
file_path = Path(root) / file
|
||
with open(file_path, "r", encoding="utf8") as f:
|
||
cn_tasks[file_path.relative_to(cn_base_path)] = json.load(
|
||
f, object_pairs_hook=raise_on_duplicate_keys
|
||
)
|
||
|
||
for task_path, task in cn_tasks.items():
|
||
cn_tasks[task_path] = sort_tasks(task)
|
||
cn_order[task_path] = list(task.keys())
|
||
|
||
for task_path, tasks in cn_order.items():
|
||
for task_path1, tasks1 in cn_order.items():
|
||
if task_path == task_path1:
|
||
continue
|
||
for task in tasks:
|
||
if task in tasks1:
|
||
raise ValueError(
|
||
f"Duplicate task found: {task_path} and {task_path1} have the same task '{task}'"
|
||
)
|
||
|
||
for task_path, task in cn_tasks.items():
|
||
cn_tasks[task_path] = sort_tasks(task)
|
||
cn_order[task_path] = list(task.keys())
|
||
with open(cn_base_path / task_path, "w", encoding="utf8", newline="\n") as f:
|
||
json.dump(task, f, ensure_ascii=False, indent=4)
|
||
|
||
print(
|
||
"CN:",
|
||
str(sum(len(tasks) for tasks in cn_order.values())).rjust(4, " "),
|
||
"tasks",
|
||
)
|
||
|
||
for server, path in global_resources.items():
|
||
overseas_path = Path(path)
|
||
count = 0
|
||
|
||
for root, dirs, files in os.walk(overseas_path):
|
||
for file in files:
|
||
if not file.endswith(".json"): # 判断是否为 JSON 文件
|
||
continue
|
||
file_path = Path(root) / file
|
||
relative_path = file_path.relative_to(overseas_path)
|
||
with open(file_path, "r", encoding="utf8") as f:
|
||
tasks = json.load(f, object_pairs_hook=raise_on_duplicate_keys)
|
||
|
||
base_order = cn_order.get(relative_path, [])
|
||
base_tasks = cn_tasks.get(relative_path, {})
|
||
|
||
tasks = {
|
||
k: {
|
||
x: tasks[k][x]
|
||
for x in sorted(
|
||
tasks[k].keys(),
|
||
key=lambda x: (
|
||
list(base_tasks[k].keys()).index(x)
|
||
if k in base_tasks and x in base_tasks[k]
|
||
else -1
|
||
),
|
||
)
|
||
}
|
||
for k in sorted(
|
||
tasks.keys(),
|
||
key=lambda k: base_order.index(k) if k in base_order else -1,
|
||
)
|
||
}
|
||
|
||
with open(file_path, "w", encoding="utf8", newline="\n") as f:
|
||
json.dump(tasks, f, ensure_ascii=False, indent=4)
|
||
count += len(tasks)
|
||
print(server + ":", str(count).rjust(4, " "), "tasks")
|
||
|
||
|
||
if __name__ == "__main__":
|
||
parser = argparse.ArgumentParser(description="Sort tasks in JSON files.")
|
||
parser.add_argument("--cn", type=str, help="Path to the CN tasks JSON file.")
|
||
parser.add_argument(
|
||
"--overseas",
|
||
type=str,
|
||
help="Comma-separated paths to the global tasks JSON files in the format 'EN:path,JP:path,KR:path,TW:path'.",
|
||
)
|
||
args = parser.parse_args()
|
||
|
||
resource_dir = Path(__file__).parents[2] / "resource"
|
||
cn_task_path = args.cn if args.cn else resource_dir / "tasks"
|
||
|
||
default_global_resources = {
|
||
"EN": resource_dir / "global/YoStarEN/resource/tasks",
|
||
"JP": resource_dir / "global/YoStarJP/resource/tasks",
|
||
"KR": resource_dir / "global/YoStarKR/resource/tasks",
|
||
"TW": resource_dir / "global/txwy/resource/tasks",
|
||
}
|
||
|
||
global_resources = default_global_resources
|
||
if args.overseas:
|
||
global_resources = {
|
||
k: Path(v)
|
||
for k, v in (item.split(":") for item in args.overseas.split(","))
|
||
}
|
||
|
||
main(cn_task_path, global_resources)
|