Lighthouse CI 项目使用指南

1. 项目目录结构及介绍

Lighthouse CI 是一个用于持续集成环境中运行 Lighthouse 的工具集。以下是项目的目录结构及其介绍：

lighthouse-ci/
├── docs/
│   ├── getting-started.md
│   └── ...
├── packages/
│   ├── cli/
│   ├── server/
│   └── ...
├── scripts/
│   └── ...
├── types/
│   └── ...
├── .browserslistrc
├── .eslintrc.js
├── .eslintrc.tests.js
├── .eslintrc.ui.js
├── .gitignore
├── .lighthouserc.js
├── .prettierrc
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── jest.config.js
├── lerna.json
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构说明

• docs/: 包含项目的文档文件，如 getting-started.md，提供了项目的入门指南。
• packages/: 包含项目的各个子包，如 cli 和 server，分别用于命令行工具和服务器端功能。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• types/: 包含 TypeScript 类型定义文件。
• .browserslistrc: 配置文件，用于指定项目支持的浏览器范围。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .eslintrc.tests.js: 针对测试文件的 ESLint 配置。
• .eslintrc.ui.js: 针对 UI 组件的 ESLint 配置。
• .gitignore: Git 忽略文件配置。
• .lighthouserc.js: Lighthouse CI 的配置文件。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• jest.config.js: Jest 测试框架的配置文件。
• lerna.json: Lerna 配置文件，用于多包管理。
• package.json: Node.js 项目的配置文件，包含依赖和脚本。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 包管理器的锁定文件。

2. 项目启动文件介绍

Lighthouse CI 项目的主要启动文件是 packages/cli/src/bin.js，它负责处理命令行接口的启动和执行。以下是启动文件的简要介绍：

packages/cli/src/bin.js

• 功能: 该文件是 Lighthouse CI 命令行工具的入口文件，负责解析命令行参数并调用相应的功能模块。
• 使用方法: 通过命令行运行 lhci 命令时，系统会调用该文件来执行相应的操作。

3. 项目配置文件介绍

Lighthouse CI 的配置文件是 .lighthouserc.js，它用于定义项目的配置选项。以下是配置文件的详细介绍：

.lighthouserc.js

• 功能: 该文件用于配置 Lighthouse CI 的行为，包括收集 Lighthouse 报告、上传报告、设置断言等。
• 配置示例:

module.exports = {
  ci: {
    collect: {
      staticDistDir: './public', // 静态文件目录
      url: ['http://localhost:3000'], // 要测试的 URL
      numberOfRuns: 5, // 运行 Lighthouse 的次数
    },
    upload: {
      target: 'temporary-public-storage', // 报告上传目标
    },
    assert: {
      assertions: {
        'categories:performance': ['warn', { minScore: 0.9 }], // 性能分数断言
        'categories:accessibility': ['error', { minScore: 1 }], // 可访问性分数断言
      },
    },
  },
};

配置项说明

• collect: 配置 Lighthouse 报告的收集选项，如静态文件目录、测试 URL 和运行次数。
• upload: 配置报告上传的目标，如临时公共存储。
• assert: 配置断言规则，用于在 CI 过程中检查 Lighthouse 报告的结果。

通过以上配置，可以灵活地控制 Lighthouse CI 的行为，确保项目在持续集成过程中能够自动运行 Lighthouse 并生成报告。