# Utilisation de lighthouse-ecoindex

Cet utilitaire en ligne de commande (cli) permet, au travers de Lighthouse, d'obtenir des rapports d'audits Green IT de votre site web. Cela pour :

• des parcours (1 parcours = 1 liste d'URL) via un fichier JSON ;
• une liste d'URLs ;
• une URL unique.

En respectant des contraintes permettant d'avoir des mesures réalistes et où les éléments des pages sont chargés (images, scripts, polices, etc.), normalisées entre chaque exécution et comparables entre les sites.

A la sortie, vous obtiendrez :

• Des rapports d'audits Lighthouse avec les audits EcoIndex et les bonnes pratiques, au format HTML et/ou JSON + un summary des résultats au format json
• Une Déclaration Environnementale de votre site – Environmental Impact Statement (EIS) – l'initiative de GreenIT.fr®, au format JSON, HTML et Markdown. Plus d'informations

# Installation de `puppeteer` et de Chrome
npx puppeteer browsers install chrome@121.0.6167.85

Si vous le désirez, vous pouvez installer le plugin via npm :

# en global
npm install -g lighthouse-plugin-ecoindex
# ou dans un projet
npm install --save-dev lighthouse-plugin-ecoindex

npx lighthouse-plugin-ecoindex <command> <options>

Commandes disponibles :

npx lighthouse-plugin-ecoindex collect <options>

Sert à lancer la collecte des audits Lighthouse et EcoIndex suivant les options passées en paramètres.

• -d, --demo : Utilise les un fichier de démonstration (voir plus bas).
• -u, --url : URL à auditer, supporte plusieurs valeurs.
• -j, --json-file : Fichier structuré, doit respecter un schéma (voir plus bas).
• -h, --extra-header : Objet de configuration supplémentaire pour Lighthouse. Chaîne JSON ou chemin vers un fichier JSON.
• -p, --output-path : Dossier de sortie.
• -o, --output : Rapporteur pour les résultats, supporte plusieurs valeurs. Choix : "json", "html", "statement". ATTENTION : "csv" n'est pas disponible.
• -a, --audit-category : Audit à exécuter, supporte plusieurs valeurs.
• --user-agent : User-Agent à utiliser pour les requêtes.
• --help : Affiche l'aide.

Génère un rapport avec le fichier de démonstration.

npx lighthouse-plugin-ecoindex collect --demo

Génère des plusieurs rapports pour de multiples parcours.

npx lighthouse-plugin-ecoindex collect --json-file ./input-file.json

Génère des rapports pour plusieurs URLs avec un user-agent spécifique.

npx lighthouse-plugin-ecoindex collect --json-file ./input-file.json --user-agent "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36 Edge/16.16299"
# ou
npx lighthouse-plugin-ecoindex collect --url https://ecoindex.fr/ --url https://www.greenit.fr/ --user-agent "lighthouse"

Génère un rapport pour une URL.

npx lighthouse-plugin-ecoindex collect --url https://ecoindex.fr/

{
  "extra-header": {
    "Cookie": "monster=blue",
    "x-men": "wolverine"
  },
  "output": ["html", "json", "statement"],
  "user-agent": "random",
  "output-path": "./reports/multi",
  "output-name": "ecoindex",
  "courses": [
    {
      "name": "Découvrir ecoindex et l'écoconception",
      "target": "Venir sur le site, le découvrir et rejoindre la communauté.",
      "course": "Attérir sur la \"Page d'accueil\", page \"Comment ça marche\", page \"Écoconception\"",
      "is-best-pages": true,
      "urls": [
        "https://www.ecoindex.fr/",
        "https://www.ecoindex.fr/comment-ca-marche/",
        "https://www.ecoindex.fr/ecoconception/"
      ]
    },
    {
      "name": "Rejoindre la communauté",
      "target": "Venir sur le site, le découvrir et rejoindre la communauté.",
      "course": "Attérir sur la \"Page d'accueil\", page \"A propos\", page \"Nous rejoindre\"",
      "is-best-pages": false,
      "urls": [
        "https://www.ecoindex.fr/",
        "https://www.ecoindex.fr/a-propos/",
        "https://www.ecoindex.fr/nous-rejoindre/"
      ]
    },
    {
      "name": "Revoir d'anciens résultats",
      "target": "Venir consulter une ancienne mesure et en relancer une nouvelle.",
      "course": "Attérir sur l'ancienne mesure (en venant depuis l'extension chrome par exemple), aller sur la page d'accueil, lancer une nouvelle mesure",
      "is-best-pages": false,
      "urls": [
        "https://www.ecoindex.fr/resultat/?id=23dfca6a-5fd6-4cf0-b899-6a2d3a597d09",
        "https://www.ecoindex.fr/"
      ]
    }
  ]
}

npx lighthouse-plugin-ecoindex convert <options>

Sert à générer la Déclaration Environnementale de votre site – Environmental Impact Statement (EIS) – l'initiative de GreenIT.fr® au format JSON, HTML et Markdown, si elle n'a pas été générée lors de la collecte.

• -i, --input-report : Fichier JSON généré par lighthouse-ecoindex.
• -p, --output-path : Dossier de sortie.
• --help : Affiche l'aide.

Convertir le(s) rapport(s) JSON généré(s) par lighthouse-ecoindex en fichier de déclaration environnementale.

npx lighthouse-plugin-ecoindex convert --input-report ./lh-export-1.json --input-report ./lh-export-2.json