MusicBrainz 用户脚本集项目教程

1. 项目目录结构及介绍

本项目包含了一系列用于增强 MusicBrainz 功能的用户脚本。以下是项目的目录结构及其简要说明：

mb-userscripts/
├── .github/             # GitHub 工作流和模板
├── build/              # 构建脚本和配置文件
├── configs/            # 配置文件
├── lib/                # 公共库和模块
├── src/                # 用户脚本的源代码
├── tests/              # 单元测试和测试用例
├── .browserslistrc      # 浏览器兼容性配置
├── .eslintrc.cjs       # ESLint 配置文件
├── .gitattributes       # Git 属性配置
├── .gitignore          # Git 忽略文件列表
├── LICENSE             # 项目许可证
├── README.md           # 项目说明文件
├── babel.config.cjs    # Babel 配置文件
├── jest.config.cjs     # Jest 配置文件
├── package-lock.json   # 包版本锁定文件
├── package.json        # 项目包配置文件
└── tsconfig.json       # TypeScript 配置文件

• .github/：包含 GitHub Actions 工作流和相关模板。
• build/：包含项目构建过程中使用的脚本和配置文件。
• configs/：包含项目的配置文件。
• lib/：包含项目依赖的公共库和模块。
• src/：包含用户脚本的源代码，是项目的主要开发区域。
• tests/：包含项目的单元测试和测试用例。
• .browserslistrc：定义项目支持的浏览器列表。
• .eslintrc.cjs：配置 ESLint 代码检查工具。
• .gitattributes：配置 Git 处理文件的属性。
• .gitignore：指定 Git 忽略的文件和目录。
• LICENSE：项目使用的许可证信息。
• README.md：项目的说明文件，包含项目信息和使用说明。
• babel.config.cjs：配置 Babel 代码转译器。
• jest.config.cjs：配置 Jest 测试框架。
• package-lock.json：记录项目依赖的精确版本。
• package.json：项目的包配置文件，包含项目信息和脚本。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 src/ 目录下的 .ts 或 .js 文件。这些文件包含了用户脚本的主要逻辑，用于增强 MusicBrainz 的功能。例如，mb_blind_votes.user.js 文件可能是用于隐藏编辑和投票者详情的脚本。

启动文件通常包含以下部分：

• 用户脚本元数据：定义脚本名称、描述、匹配的 URL 等信息。
• 主体逻辑：脚本的核心功能实现。
• 事件监听器：监听页面加载或用户交互事件。

3. 项目的配置文件介绍

项目的配置文件主要位于 configs/ 目录下，用于定义项目的通用设置。以下是一些重要的配置文件及其作用：

• eslintrc.cjs：ESLint 配置文件，用于定义代码风格和检查规则。
• jest.config.cjs：Jest 配置文件，用于配置单元测试的环境和规则。
• tsconfig.json：TypeScript 配置文件，用于指定 TypeScript 编译选项。

这些配置文件确保了代码的一致性和项目的可维护性。