Convert plugin to ESM and split large files #533
Conversation
👷 Deploy Preview for plugin-lighthouse processing.
|
| 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
|
|
||
| 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
left a comment
aitchiss
left a comment
There was a problem hiding this comment.
Woooo this is a really quality improvement! ✨
I've run this locally and with a test site (inc with some paths that should generate lighthouse failures) and all seems to be working as before 👍
|
|
||
| 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!
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