/beacon-for-ibm-dotcom

Beacon for IBM.com is an audit tool for various compliance checks for IBM.com pages.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

@ibmdotcom/beacon

Beacon for IBM.com analyzes web pages for compliance with IBM.com web standards, the IBM Design Language, and best practices.

Beacon for IBM.com leverages Google Lighthouse to perform specific audits on apps, sites, and pages. This ensures that users can have the best experience when visiting our sites. Please visit web standards and Carbon for IBM.com for more information on designing and developing for IBM.com.

Getting started

npm i @ibmdotcom/beacon

If you prefer Yarn, use the following command instead:

yarn add @ibmdotcom/beacon

Usage

beacon -u https://www.ibm.com

By default, the results are written to an HTML file in the root directory. Since Beacon is powered by Lighthouse, there are a plenty of built-in CLI options available to customize the output.

Note: Beacon for IBM.com uses custom audits to ensure compliance with IBM.com web standards and is meant to be used on IBM.com sites only. For general web audits please use Google Lighthouse, which is available as an npm package and built-in Chrome extension.

Options

$ beacon --help

beacon -u <url> [options]

URL:
  --url, -u       URL to audit [required]

Output:
  --output, -o    Output format. Supports 'html', 'json', 'csv'. [Default: 'html']
  --raw, -r       Output results in raw format.

A full list of available audits can be seen here.