Yomitan 项目教程

1. 项目目录结构及介绍

Yomitan 项目的目录结构如下：

yomitan/
├── benches/
├── dev/
├── dl/
├── docs/
├── ex/
├── img/
├── resources/
├── test/
├── types/
├── .env
├── .eslintignore
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .htmlvalidate.json
├── .htmlvalidateignore
├── .lycheeignore
├── .prettierignore
├── .stylelintignore
├── .stylelintrc.json
├── CODEOWNERS
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── build.bat
├── build.sh
├── jsconfig.json
├── package-lock.json
├── package.json
├── playwright.config.js
├── shell.nix
├── vitest.config.js

目录介绍

• benches/: 包含性能测试相关的文件。
• dev/: 开发相关的文件和脚本。
• dl/: 下载相关的文件和脚本。
• docs/: 项目文档文件。
• ex/: 示例文件或扩展文件。
• img/: 项目中使用的图片文件。
• resources/: 项目资源文件。
• test/: 测试相关的文件和脚本。
• types/: TypeScript 类型定义文件。
• .env: 环境变量配置文件。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.json: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .htmlvalidate.json: HTML 验证配置文件。
• .htmlvalidateignore: HTML 验证忽略文件配置。
• .lycheeignore: Lychee 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• .stylelintignore: Stylelint 忽略文件配置。
• .stylelintrc.json: Stylelint 配置文件。
• CODEOWNERS: 代码所有者配置文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• SECURITY.md: 安全相关说明文件。
• build.bat: Windows 平台下的构建脚本。
• build.sh: Unix/Linux 平台下的构建脚本。
• jsconfig.json: JavaScript 配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• playwright.config.js: Playwright 配置文件。
• shell.nix: Nix 配置文件。
• vitest.config.js: Vitest 配置文件。

2. 项目启动文件介绍

Yomitan 项目的启动文件主要包括以下几个：

• build.bat: Windows 平台下的构建脚本，用于启动项目的构建过程。
• build.sh: Unix/Linux 平台下的构建脚本，用于启动项目的构建过程。

这两个脚本文件是项目的主要启动文件，通过运行它们可以启动项目的构建和运行过程。

3. 项目的配置文件介绍

Yomitan 项目中有多个配置文件，以下是一些关键配置文件的介绍：

• .eslintrc.json: ESLint 配置文件，用于定义代码风格和语法检查规则。
• .stylelintrc.json: Stylelint 配置文件，用于定义 CSS/SCSS 代码风格和语法检查规则。
• jsconfig.json: JavaScript 配置文件，用于定义项目中的 JavaScript 配置选项。
• package.json: npm 包配置文件，包含了项目的依赖、脚本命令等信息。
• playwright.config.js: Playwright 配置文件，用于定义 Playwright 测试框架的配置选项。
• vitest.config.js: Vitest 配置文件，用于定义 Vitest 测试框架的配置选项。

这些配置文件是项目运行和开发过程中必不可少的，通过它们可以定制项目的各种行为和规则。