Convert plugin to ESM and split large files #533
Merged
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
👷 Deploy Preview for plugin-lighthouse processing.
|
jackbrewer
commented
Jan 17, 2023
| const { getSettings } = require('./settings'); | ||
| const { getBrowserPath, runLighthouse } = require('./lighthouse'); | ||
| const { formatResults } = require('./format'); | ||
| import chalk from 'chalk'; |
There was a problem hiding this comment.
This is the main file where functions were cut from
jackbrewer
commented
Jan 17, 2023
| jest.spyOn(console, 'warn').mockImplementation(() => {}); | ||
| jest.mock('chalk', () => { | ||
| jest.unstable_mockModule('chalk', () => { |
There was a problem hiding this comment.
Jest isn't quite there with ESM. Mocking a module being one outstanding pain point. Based on a few recommendations, we use this module-specific mock (available since Jest v27), then lazy import the file we want to test after the mock is in place.
There was a problem hiding this comment.
[dust] It might be nice to add this link in a wee comment here, in case anyone wonders in future!
aitchiss
approved these changes
Jan 18, 2023
| jest.spyOn(console, 'warn').mockImplementation(() => {}); | ||
| jest.mock('chalk', () => { | ||
| jest.unstable_mockModule('chalk', () => { |
There was a problem hiding this comment.
[dust] It might be nice to add this link in a wee comment here, in case anyone wonders in future!
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.
This PR starts modernising the plugin by switching to ES Modules, and splitting some of the larger files into smaller discrete function files. In theory, there are no functional changes, but a lot of files have been touched.
These changes should allow easier test authoring, and allows us to switch out
expressfornetlify devin a more controlled way.Using ESM is the recommended Netlify way: https://docs.netlify.com/integrations/build-plugins/create-plugins/#es-modules.
Example site deploy using modernized version:
netlify/netlify-plugin-lighthouse#jbr/modernizingSummary of changes
index.jsto standalone directoriesrequiretoimport/exportimportfiles directly e.g.src/directory/index.js(to match the spec) rather than importingsrc/directorydirectly and relying on Babels's file resolving. Happy to change this in future if we find additional uses for transpiling.Test plan
yarn localBEGIN_COMMIT_OVERRIDE
chore: internal refactor to use ES modules #533
END_COMMIT_OVERRIDE