Utilisation avec lighthouse CLI

Objectifs

Utiliser le plugin lighthouse-ecoindex avec le client Lighthouse CLI.

Recommandation

Comme lighthouse en mode cli ne permet pas d'utiliser le scénario de navigation Puppeteer et ne permet de lancer l'analyse que d'une seule page à fois (sans mettre à jour le fichier de configuration), il est recommandé d'utiliser le client interne fourni par le plugin.

npx lighthouse <url> --config-path=./custom-config.cjs
# equivaut à
npx lighthouse-plugin-ecoindex <command> <options>
# soit
npx lighthouse-plugin-ecoindex collect --url https://ecoindex.fr/

lighthouse-plugin-ecoindex CLI

../1-lighthouse-ecoindex-cli/

Installation

Vous devez utiliser les fichiers de configuration de Lighthouse (exemple ci-dessous) pour pouvoir utiliser le plugin lighthouse-ecoindex.

# Ajout à un projet existant
npm install lighthouse lighthouse-plugin-ecoindex --save-dev
# ou glablement
npm install -g lighthouse lighthouse-plugin-ecoindex

Utilisation

Vous devez utiliser le fichiers configuration de Lighthouse pour pouvoir utiliser le plugin lighthouse-ecoindex.

/**
 * @license
 * Copyright 2018 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */
const path = require('path')
function getGatherersPath(file) {
  return path.join(
    require.resolve('lighthouse-plugin-ecoindex-core'),
    '../gatherers/' + file,
  )
}
/** @type {LH.Config} */
module.exports = {
  formFactor: 'desktop',
  // https://github.com/GoogleChrome/lighthouse/blob/main/core/config/constants.js
  throttling: {
    rttMs: 40,
    throughputKbps: 10 * 1024,
    cpuSlowdownMultiplier: 1,
    requestLatencyMs: 0, // 0 means unset
    downloadThroughputKbps: 0,
    uploadThroughputKbps: 0,
  },
  screenEmulation: {
    mobile: false,
    width: 1920,
    height: 1080,
  },
  emulatedUserAgent: 'desktop',
  maxWaitForLoad: 60 * 1000,
  plugins: ['lighthouse-plugin-ecoindex-core'],
  disableStorageReset: true,
  preset: 'desktop',
  extends: 'lighthouse:default',
  artifacts: [
    { id: 'DOMInformations', gatherer: getGatherersPath('dom-informations') },
  ],
}

npx lighthouse <url> --config-path=./custom-config.cjs

Exemples à adapter suivant votre CI/CD

Lancer la mesure sur une URL :

npx lighthouse https://novagaia.fr --config-path=./custom-config.cjs

Projet example pour lighthouse CLI

https://github.com/cnumr/lighthouse-plugin-ecoindex/tree/main/examples/lighthouse-cli

Documentation externe des dépendances

lighthouse CLI

https://github.com/GoogleChrome/lighthouse#using-the-node-cli

Puppeteer

https://pptr.dev/