Lighthouse 开源项目使用教程

1. 项目的目录结构及介绍

lighthouse/
├── bin/
│   └── lighthouse.js
├── config/
│   ├── default.json
│   └── production.json
├── src/
│   ├── audits/
│   ├── core/
│   ├── gather/
│   ├── report/
│   └── index.js
├── package.json
└── README.md

• bin/: 包含项目的启动文件。
• config/: 包含项目的配置文件。
• src/: 包含项目的主要源代码，分为多个子目录：
  • audits/: 包含各种审计模块。
  • core/: 包含核心功能模块。
  • gather/: 包含数据收集模块。
  • report/: 包含报告生成模块。
  • index.js: 项目的入口文件。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件位于 bin/lighthouse.js。这个文件是整个项目的入口点，负责初始化配置、加载必要的模块，并启动审计过程。

#!/usr/bin/env node

const lighthouse = require('../src/index.js');
const config = require('../config/default.json');

lighthouse.run(config)
  .then(report => {
    console.log(report);
  })
  .catch(err => {
    console.error(err);
  });

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含 default.json 和 production.json 两个文件。

• default.json: 默认配置文件，包含基本的配置选项，如审计的网站地址、性能指标等。

{
  "url": "https://example.com",
  "performance": true,
  "accessibility": true,
  "best-practices": true,
  "seo": true,
  "pwa": true
}

• production.json: 生产环境配置文件，可以覆盖默认配置，例如增加更多的审计项或调整性能指标。

{
  "url": "https://production.example.com",
  "performance": {
    "score": 0.9
  },
  "accessibility": true,
  "best-practices": true,
  "seo": true,
  "pwa": true
}

通过这些配置文件，用户可以根据不同的环境和需求调整 Lighthouse 的运行参数。