@fabernovel/heart-greenit

Heart GreenIT

Heart GreenIT is an analysis module of Heart, which analyses URLs with GreenIT.

Read more about the purpose, design and general installation of Heart.

Package manager

In the following sections, every examples are using NPM as package manager, but you can use any other you prefer: Yarn, pnpm...

Installation

1. Add the package to your project:

   npm install @fabernovel/heart-greenit
   

2. Add Heart CLI if you have not already installed it

   npm install @fabernovel/heart-cli
   

Usage

Analysis setup

The analysis setup must use the JSON format with the following keys:

{
    "url": "https://www.fabernovel.com/",
    // optional - default: 3000
    "timeout": 1000,
    // optional - default: 2
    "retry": 2,
    // optional - default: "desktop"
    // possible values: "desktop", "galaxyS9", "galaxyS20", "iPhone8", "iPhone8Plus", "iPhoneX", "iPad"
    "device": "mobile"
}

Example

Using Heart CLI

You want to analyse the https://www.fabernovel.com URL and check that the rating is at least 90

npx heart greenit --inline '{"url":"https://www.fabernovel.com"}' --threshold 90

Disclaimer

The LCA values used by GreenIT to evaluate environmental impacts are not under free license - © Frédéric Bordage

Please also refer to the mentions provided in the code files for specifics on the IP regime.