Socket
Socket
Sign inDemoInstall

@sum.cumo/lighthouse-keeper

Package Overview
Dependencies
7
Maintainers
7
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @sum.cumo/lighthouse-keeper

CLI tool for running Google’s Lighthouse checks


Version published
Weekly downloads
1
Maintainers
7
Install size
61.1 MB
Created
Weekly downloads
 

Readme

Source

CircleCI

Lighthouse Keeper

Lighthouse Keeper makes it easier to run specific Lighthouse audits on a set of URLs.

Installation

npm install --save-dev @sum.cumo/lighthouse-keeper

Google Chrome

You need a Chrome installation in order to be able to use Lighthouse.

Usage

With JSON or JS config file

lighthouse-keeper --config path/to/config.js[on]
Options

These are the possible options for the configuration file:

OptionDescriptionDefault
extendsname of a predefined set of configurationsoptional
urlsarray of URLs to scan[]
extendedInfodisplay extended info of the auditfalse by default. If the audit is not satisfied extendInfo turns true
allAuditsindicates if all audits should be evaluatedfalse
onlyAuditsarray of audit keys to evaluate (see below)[]
skipAuditsarray of audit keys to be skipped (see below)[]
scoresobject of minimum scores per category (see below) to obtain{}
auditPassThresholdThreshold of the score to pass an audit (0 - 1)0.75

There is a predefined set of options called 'recommended. This looks like this:

skipAudits: [
  "uses-webp-images",
  "hreflang",
  "installable-manifest",
  "without-javascript",
]
Example
{
  "extends": "recommended",
  "urls": [
    "https://www.example.com/"
  ],
  "scores": {
    "performance": 90,
    "accessibility": 90,
    "best-practices": 90,
    "seo": 80
  },
  "onlyAudits": [
    "performance",
    "accessibility",
    "best-practices",
    "seo"
  ],
  "skipAudits": [
    "uses-responsive-images",
    "uses-webp-images",
    "meta-description"
  ],
  "extendedInfo": true
}

(Reasoning behind this sample config.)

Without config file

lighthouse-keeper --url https://www.example.com --audits accesskeys,uses-http2 --scores seo:90,best-practices:10

These are the possible options for the CLI:

OptionDescriptionMandatory
urlthe URL to scanyes
auditslist of audits that should be evaluated (see below)no
skiplist of audits that should be skipped (see below)no
scoreslist of minimum scores per category to obtain (see below)no
showauditsonly show the available auditsno

List entries must be separated by comma.

Categories

Category IDDescription
accessibilityThese checks highlight opportunities to improve the accessibility of your web app. Only a subset of accessibility issues can be automatically detected so manual testing is also encouraged.
best-practicesWe’ve compiled some recommendations for modernizing your web app and avoiding performance pitfalls.
performanceThese encapsulate your web app’s current performance and opportunities to improve it.
pwaThese checks validate the aspects of a Progressive Web App, as specified by the baseline PWA Checklist.
seoThese checks ensure that your page is optimized for search engine results ranking. There are additional factors Lighthouse does not check that may affect your search ranking. Learn more.

Audits

If you want to see a list of all available audits, run

lighthouse-keeper --url https://www.example.com/ --showaudits

The url is actually irrelevant for the list, but needed for running Lighthouse to parse the response.

Please have in mind that there are audits like screenshot-thumbnails which can’t be validated. These audits are marked with a in the audits list and with (?) in the result.

License

Copyright 2018 sum.cumo GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


Learn more about sum.cumo and work on open source projects, too!

Keywords

FAQs

Last updated on 13 Aug 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc