docs(config): explicitly include plugins in settings object
#11726
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As this document is referenced by LHCI, explicitly include `plugins` as a supported setting to ensure users are aware that it is supported.
jburger424
requested review from
patrickhulce
and removed request for
a team
jburger424
changed the title
plugins in settings object.plugins in settings object
patrickhulce
suggested changes
Nov 30, 2020
| @@ -81,6 +81,7 @@ For full list see [our config settings typedef](https://github.com/GoogleChrome/ | |||
| | onlyCategories | `string[]` | Includes only the specified categories in the final report. Additive with `onlyAudits` and reduces the time to audit a page. | | |||
| | onlyAudits | `string[]` | Includes only the specified audits in the final report. Additive with `onlyCategories` and reduces the time to audit a page. | | |||
| | skipAudits | `string[]` | Excludes the specified audits from the final report. Takes priority over `onlyCategories`, not usable in conjuction with `onlyAudits`, and reduces the time to audit a page. | | |||
| | plugins | `string[]` | Includes the specified plugins and corresponding audits in the report, this is additive with all above options. Refer to [plugin documentation](https://github.com/GoogleChrome/lighthouse/blob/master/docs/plugins.md) for detailed plugin information.| | |||
There was a problem hiding this comment.
doesn't plugins belong at the root of the config, not nested within settings? this section is nested under settings
maybe there's some extra work to do to make that clearer, but could just move this out to be at the correct level for now instead :)
|
Oooooh I see the LHCI section you're talking about, yeah that's kinda tricky because the LHCI Hm, maybe we address this better on the LHCI side in addition to adding it at the toplevel here? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As this document is referenced by LHCI, explicitly include
pluginsas a supported setting to ensure LHCI users are aware that plugins are supported.CC: @patrickhulce