npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

foghorn

v1.1.1

Published

A CLI tool to generate, compare, and analyze Lighthouse reports, ideal for performance tracking and CI/CD integration

Downloads

19

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sonalp17sonalp17

Keywords

Readme

Foghorn

Lighthouse Report Generator

This project generates Lighthouse reports for specified URLs and provides a comparison with previous reports.

Prerequisites

  • Bun (v1.1.21 or later)
  • Node.js (v14 or later, for Lighthouse)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/lighthouse-report-generator.git
cd lighthouse-report-generator

  2. Install dependencies:

    bun install

Usage

To generate a Lighthouse report for a URL:

bun index.js -u https://example.com

Replace https://example.com with the URL you want to analyze.

Project Structure

  • index.js: Main entry point of the application
  • reportGenerator.js: Handles report generation and comparison
  • reportStorage.js: Manages storage and retrieval of reports
  • templates/report.ejs: EJS template for the HTML report

Configuration

You can modify the following files to customize the report generation:

  • reportStorage.js: Adjust the BASE_DIR constant to change the directory where reports are stored
  • templates/report.ejs: Modify the HTML template to change the report layout

Output

The script generates two files for each run:

  1. An HTML report: test-output/<domain>/html/report-<timestamp>.html
  2. A JSON report: test-output/<domain>/json/report-<timestamp>.json

The HTML report includes:

  • Current scores
  • A comparison chart of the last 5 reports
  • A table comparing the last 5 reports

Troubleshooting

If you encounter any issues:

  1. Ensure you have the latest version of Bun installed
  2. Check that all dependencies are correctly installed
  3. Verify that you have the necessary permissions to write to the test-output directory

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.