@vinnyum/site-auditor

Una envoltura optimizada alrededor de Lighthouse CI y PageSpeed Insights API, diseñada para auditar sitios web tanto en desarrollo local como en flujos de integración continua (CI/CD).

🚀 Instalación

Para instalar el auditor como dependencia de desarrollo:

npm install @vinnyum/site-auditor --save-dev

💻 Uso

La herramienta expone el comando ejecutable site-auditor.

1. Modo Local (--mode=local)

Diseñado para ejecutarse localmente después de compilar un sitio web estático. Examina los archivos compilados de la carpeta proporcionada y genera reportes interactivos en HTML.

# Ejemplo de uso en los scripts de un package.json (ej. Astro)
"audit": "astro build && site-auditor --mode=local --outDir=dist"

• --outDir: Directorio donde reside el build estático final (por defecto es dist).

2. Modo CI (--mode=ci)

Diseñado para GitHub Actions. Utiliza la API pública de PageSpeed Insights para evaluar una URL desplegada en vivo (ideal para sitios estáticos o SSR). Inyecta los resultados directamente en el resumen del workflow de GitHub (GITHUB_STEP_SUMMARY).

Variables de entorno requeridas:

• TARGET_URL: La URL del sitio en producción o staging que deseas evaluar.
• PAGESPEED_API_KEY: Tu API Key de Google Cloud para el servicio PageSpeed Insights API.

Ejemplo de Workflow en GitHub Actions:

name: Performance Audit
on:
  deployment_status:
    types: [success]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - name: Run PageSpeed Audit
        env:
          TARGET_URL: ${{ github.event.deployment_status.target_url }}
          PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
        run: npx @vinnyum/site-auditor --mode=ci

📝 Licencia

ISC