docs(plugins): update plugin developer docs wrt NODE_PATH #10028
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
paulirish
requested review from
brendankenny and
patrickhulce
as code owners
| `\`${moduleIdentifier}\`. | ||
| Tried to require() from these locations: | ||
| ${__dirname} | ||
| ${cwdPath}`; |
There was a problem hiding this comment.
we might also spit out NODE_PATH, if it is set. L175 tries all of that.
There was a problem hiding this comment.
Sounds good. I started this but i'm going to split into a separate PR because NODE_PATH from the node side starts to get pretty complex.
|
oops 👀 |
connorjclark
approved these changes
Nov 26, 2019
patrickhulce
approved these changes
Nov 26, 2019
docs/plugins.md
Outdated
| @@ -231,6 +231,8 @@ The following artifacts are available for use in the audits of Lighthouse plugin | |||
|
|
|||
| While Lighthouse has more artifacts with information about the page than are in this list, those artifacts are considered experimental and their structure or existence could change at any time. Only use artifacts not on the list above if you are comfortable living on the bleeding edge and can tolerate unannounced breaking changes. | |||
|
|
|||
| If you're interested in other data not mentioned here, please file an issue. We'd love to help. | |||
There was a problem hiding this comment.
Suggested change
| If you're interested in other data not mentioned here, please file an issue. We'd love to help. | |
| If you're interested in other page information not mentioned here, please file an issue. We'd love to help. |
maybe? data just felt a bit weird 🤷♂
| 2. Install the plugin as a (peer) dependency, parallel to `lighthouse`. | ||
| 3. Run `npx -p lighthouse lighthouse https://example.com --plugins=lighthouse-plugin-example --view` | ||
| 1. Install `lighthouse` (v5+) and the plugin `lighthouse-plugin-example`, likely as `devDependencies`. | ||
| * `npm install -D lighthouse lighthouse-plugin-example` |
There was a problem hiding this comment.
TIL -D isn't just yarn
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.
followup from #9997 which recommended NODE_ENV but meant to recommend NODE_PATH.
Also some error message formatting
closes #9950 #9948