lighthouse-batch-parallel

> :warning: Running Lighthouse concurrently would skew Performamce Score according to this reply from Lighthouse team, be careful of giving workersNum argument when the accuracy of performance score is important.

This is a module to help collecting website's Lighthouse audit data in batches.

You can require this module in your own project, get the report data stream in CSV, JS Object or JSON format and handle the stream by yourself, or you can just use the cli-tool which is also provided to generate the report file.

It has the capability to monitor multiple websites in parallel which can accelerate the collecting process when the target URLs are in plenty, but please be aware of the warning. You can decide how many workers working at the same time, every worker would launch an independent headless Chrome browser.

Usage

npm:

$ npm i lighthouse-batch-parallel

yarn:

$ yarn add lighthouse-batch-parallel

#### Example

``js
const { lighthouseBatchParallel } = require('lighthouse-batch-parallel');

const targetWebsites = [
{
Device: 'mobile',
URL: 'https://www.npmjs.com/package/lighthouse-batch-parallel'
},
{
Device: 'desktop',
URL: 'https://www.npmjs.com/package/lighthouse-batch-parallel'
},
];

const customAuditsConfig = {
'first-contentful-paint': 'First Contentful Paint',
'first-meaningful-paint': 'First Meaningful Paint',
'speed-index': 'Speed Index',
};

const lighthouseAuditing = lighthouseBatchParallel({
input: {
stream: targetWebsites,
},
customAudits: { stream: customAuditsConfig },
throttling: 'applied3G',
outputFormat: 'jsObject',
workersNum: 2,
});

let reports = [];

lighthouseAuditing.on('data', ({ data }) => {
reports.push(data);
});

lighthouseAuditing.on('error', ({ error }) => {
console.log(error);
});

lighthouseAuditing.on('end', () => {
console.log(reports);
console.log(reports[0].audits);
});
`
Output of example above:
`js
// console.log(reports);
[
{
Device: 'mobile',
URL: 'https://www.npmjs.com/package/react-carousel-slider',
audits: {
performance: [Object],
accessibility: [Object],
'best-practices': [Object],
seo: [Object],
pwa: [Object],
'first-contentful-paint': [Object],
'first-meaningful-paint': [Object],
'speed-index': [Object]
}
},
{
Device: 'desktop',
URL: 'https://www.npmjs.com/package/react-carousel-slider',
audits: {
performance: [Object],
accessibility: [Object],
'best-practices': [Object],
seo: [Object],
pwa: [Object],
'first-contentful-paint': [Object],
'first-meaningful-paint': [Object],
'speed-index': [Object]
}
}
]

// console.log(reports[0].audits);
{
performance: { title: 'Performance', score: 0.42 },
accessibility: { title: 'Accessibility', score: 0.78 },
'best-practices': { title: 'Best-practices', score: 1 },
seo: { title: 'SEO', score: 1 },
pwa: { title: 'PWA', score: 0.31 },
'first-contentful-paint': { title: 'First Contentful Paint', score: '2.7 s' },
'first-meaningful-paint': { title: 'First Meaningful Paint', score: '4.2 s' },
'speed-index': { title: 'Speed Index', score: '5.9 s' }
}
`

---

#### lighthouseBatchParallel(parameters)
* parameters