Skip to content

Commit

Permalink
docs(configuration): update description of extends property (#11488)
Browse files Browse the repository at this point in the history
  • Loading branch information
danieleloscozzese committed Oct 5, 2020
1 parent 069364e commit 054722a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ lighthouse('https://example.com/', {port: 9222}, config);
| categories | <code>Object&#124;undefined</code> |
| groups | <code>Object&#124;undefined</code> |

### `extends: string|boolean|undefined`
### `extends: "lighthouse:default"|boolean|undefined`

The extends property controls if your configuration should inherit from the default Lighthouse configuration. [Learn more.](#config-extension)
The `extends` property controls if your configuration should inherit from the default Lighthouse configuration. [Learn more.](#config-extension)

Both the values `"lighthouse:default"` and `true` will enable inheritance, while `false` and `undefined` will not.

#### Example
```js
Expand Down Expand Up @@ -197,7 +199,7 @@ The groups property controls how to visually group audits within a category. For

The stock Lighthouse configurations can be extended if you only need to make small tweaks, such as adding an audit or skipping an audit, but wish to still run most of what Lighthouse offers. When adding the `extends: 'lighthouse:default'` property to your config, the default passes, audits, groups, and categories will be automatically included, allowing you modify settings or add additional audits to a pass.

Please note that you can only extend from `lighthouse:default` using the `extends` property. Other internal configs found in the [lighthouse-core/config](https://github.com/GoogleChrome/lighthouse/tree/master/lighthouse-core/config) directory can be used by importing the config object from file reference, or by using the [`--preset`](https://github.com/GoogleChrome/lighthouse#cli-options) CLI flag.
Please note that the `extends` property only supports extension of `lighthouse:default`. Other internal configs found in the [lighthouse-core/config](https://github.com/GoogleChrome/lighthouse/tree/master/lighthouse-core/config) directory can be used by importing the config object from file reference, or by using the [`--preset`](https://github.com/GoogleChrome/lighthouse#cli-options) CLI flag.

See [more examples below](#more-examples) to view different types of extensions in action.

Expand Down

0 comments on commit 054722a

Please sign in to comment.