Lighthouse-Coddle

This package allows you to easily run performance tests on your web apps using Lighthouse

Installation

npm i --save-dev lighthouse-coddle
# or if you're using yarn
yarn add -D lighthouse-coddle

Usage

In your project's Package.json file, and the script:

"scripts": {
    "performance-test": "lighthouse http://127.0.0.1:3000/ --view --preset=desktop --output=json --output-path=./report.json && performance-test 0.9"
  },

The above command provided is a shell command that runs Lighthouse against a web application running on http://127.0.0.1:3000/ The --preset=desktop flag specifies that the test should be run with the desktop configuration, you can use --preset=mobile for the mobile configuration and the --output=json flag specifies that the report should be saved in JSON format. The --output-path=./report.json flag specifies that the report should be saved in the current directory with the name "report.json".

The command also includes performance-test 0.9, the 0.9 is configurable, meaning that you can change it to any other value as per your requirement. If the performance score is less than the threshold, the script will output a message indicating that the performance test failed and exits with a non-zero exit code, which will prevent the commit from proceeding if the performance test fails.

Using with Pre-commit

Add a configuration for the pre-commit hook in your package.json file. You can do this by adding a "pre-commit" key in your package.json file:

{
    "pre-commit": [
       "performance-test"
    ]
}

Make sure that performance-test script is defined in your package.json file