Skip to content

This Node.js package provides a comprehensive solution for crawling websites and scoring each page using Google's Lighthouse tool. Starting from a specified URL, it traverses the site, analyzes each page for performance, accessibility, SEO, and more, and generates a consolidated report of the results.

Notifications You must be signed in to change notification settings

anvil-solutions/lighthouse-crawler

Repository files navigation

Lighthouse Crawler

Usage

To install the package, run the following command in your terminal:

npm install --dev github:anvil-solutions/lighthouse-crawler

To use the package in your project, you can follow the example below:

npx lighthouse-crawler --help

Development

Run npm install in the project's root directory to install all required dependencies. Additionally, make sure you have npm (Node Package Manager) and Node.js installed on your system before running this command.

Linting

To maintain code quality and adhere to coding standards, you can use linting tools in your project's root directory. Follow the instructions below for each language.

npm run lint

JavaScript Linting

Run the following commands in your project's root directory to utilize ESLint and TypeScript:

npm run eslint
npm run tsc

CSS Linting

Run the following commands in your project's root directory to utilize Stylelint:

npm run stylelint

Testing

To ensure your code is functioning correctly and to catch any potential issues early, you can use the following command to run tests using Vitest:

npm run test

About

This Node.js package provides a comprehensive solution for crawling websites and scoring each page using Google's Lighthouse tool. Starting from a specified URL, it traverses the site, analyzes each page for performance, accessibility, SEO, and more, and generates a consolidated report of the results.

Topics

Resources

Stars

Watchers

Forks