psi

psi

PageSpeed ​​Insights avec reporting

Exécutez des tests de performances sur mobile et ordinateur pour votre site déployé à l'aide de Google PageSpeed ​​Insights v5 avec des rapports clairs pour votre processus de création.

Installer

 $ npm install psi

Usage

 const psi = require ( 'psi' ) ;

( async ( ) => {
  // Get the PageSpeed Insights report
  const { data } = await psi ( 'https://theverge.com' ) ;
  console . log ( 'Speed score:' , data . lighthouseResult . categories . performance . score ) ;

  // Output a formatted report to the terminal
  await psi . output ( 'https://theverge.com' ) ;
  console . log ( 'Done' ) ;

  // Supply options to PSI and get back speed
  const data2 = await psi ( 'https://theverge.com' , {
    nokey : 'true' ,
    strategy : 'desktop'
  } ) ;
  console . log ( 'Speed score:' , data2 . data . lighthouseResult . categories . performance . score ) ;
} ) ( ) ;

Depuis PSI 2.x, nous exposons à la fois les scores de vitesse et de convivialité de PageSpeed ​​Insights. Ce dernier est basé sur des règles d'utilisabilité qui notent une page en fonction de facteurs tels que la présence d'une fenêtre d'affichage mobile raisonnable.

API

psi(url, [options])

Renvoie une promesse pour les données de réponse de Google PageSpeed ​​Insights.

URL

Type : string

URL de la page pour laquelle l'API PageSpeed ​​Insights doit générer des résultats.

choix

Type : Object

clé

Type : string
Par défaut : niveau gratuit

Lorsque vous utilisez ce module pour un processus de construction au niveau de la production, il est recommandé de s'inscrire à une clé API à partir de la Google Developer Console.

stratégie

Type : string
Par défaut : mobile
Valeurs : desktop mobile

Stratégie à utiliser lors de l'analyse de la page.

lieu

Type : string
Par défaut : en_US

Les résultats régionaux doivent être générés.

seuil

Type : number
Par défaut : 70

Score seuil pour réussir le test PageSpeed. Utile pour définir un budget de performance.

links

Type : boolean
Par défaut : false

S'il est réussi, ajoute des liens avec plus d'informations sur les opportunités. Utile pour vérifier la documentation sur les opportunités.

psi.output(url, [options])

Sortez le rapport formaté sur le terminal.

Renvoie une promesse pour les données de réponse de Google PageSpeed ​​Insights.

url et options sont les mêmes que psi() .

CLI

 $ npm install --global psi

 $ psi --help

  Usage
    $ psi <url>

  Options
    --key        Google API Key. By default the free tier is used
    --strategy   Strategy to use when analyzing the page: mobile|desktop
    --format     Output format: cli|json|tap
    --locale     Locale results should be generated in
    --threshold  Threshold score to pass the PageSpeed test

  Example
    $ psi https://addyosmani.com --strategy=mobile

Cas d'utilisation courants

Intégrer le PSI dans votre processus de construction.

Un exemple de projet Gulp utilisant PSI est disponible.

Si vous utilisez Grunt, grunt-pagespeed est une tâche de James Cryer qui utilise PSI sous le capot.

Pour tester des projets locaux, nous vous recommandons d'utiliser psi-ngrok ou ngrok .

Obtenir des pellicules

Les bandes de films sont renvoyées par l'API v5 sous forme d'URI de données, mais l'outil psi ne les expose pas sur le cli. Si vous souhaitez obtenir des séquences de films (ou des détails d'audit), vous pouvez exiger psi et les obtenir à partir de l'objet audits :

 const psi = require ( 'psi' ) ;

( async ( ) => {
  // Get the PageSpeed Insights report
  const { data } = await psi ( 'https://theverge.com' ) ;
  console . log ( data . lighthouseResult . audits [ 'screenshot-thumbnails' ] . details . items ) ;
} ) ( ) ; 

Licence

Apache-2.0 - Copyright 2015 Google Inc.