Skip to content
Test your site using Lighthouse and Observatory
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib
test
.gitignore
.travis.yml
LICENSE
README.md
index.js
package-lock.json
package.json
renovate.json

README.md

Build Status js-standard-style

webquality

Check your site using Lighthouse and Observatory

This will measure performance, accessibility, best practices, SEO and security.

If your score is 90+ in all categories you probably have happy users. If not: do better :-)

Usage

Supply the url to a webpage and wait for results.

Depending on your site tests typically will run for 10 - 20 seconds.

(async () => {
  const wq = require('@alheimsins/webquality')
  const results = await wq('https://www.alheimsins.net')
  console.log(results)
})()

returns

[
  {
    "id": "performance",
    "title": "Performance",
    "score": 100
  },
  {
    "id": "accessibility",
    "title": "Accessibility",
    "description": "These checks highlight opportunities to [improve the accessibility of your web app](https://developers.google.com/web/fundamentals/accessibility). Only a subset of accessibility issues can be automatically detected so manual testing is also encouraged.",
    "score": 60,
    "manualDescription": "These items address areas which an automated testing tool cannot cover. Learn more in our guide on [conducting an accessibility review](https://developers.google.com/web/fundamentals/accessibility/how-to-review)."
  },
  {
    "id": "best-practices",
    "title": "Best Practices",
    "score": 92
  },
  {
    "id": "seo",
    "title": "SEO",
    "description": "These 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](https://support.google.com/webmasters/answer/35769).",
    "score": 90,
    "manualDescription": "Run these additional validators on your site to check additional SEO best practices."
  },
  {
    "id": "observatory",
    "title": "Security",
    "score": 0,
    "grade": "F",
    "description": "The Mozilla Observatory teaches you how to configure your sites safely and securely. https://observatory.mozilla.org"
  }
]

Throws error if any of the tests fails.

Development

If you need to see the logs you can add debug to your environment.

(async () => {
  process.env.debug = true
  const wq = require('@alheimsins/webquality')
  const results = await wq('https://www.alheimsins.net')
  console.log(results)
})()

License

MIT

You can’t perform that action at this time.