We updated the scripting documentation to be generated directly from Browsertime (using JSDoc). This makes the documentation so much easier to navigate. It's not 100% perfect yet so please feel free to send PRs with updates :)
The new version of Browsertime also adds code completion/IntelliSense support. Read here on how to set it up. Make sure to start your scripting like this:
/**
* @param {import('browsertime').BrowsertimeContext} context
* @param {import('browsertime').BrowsertimeCommands} commands
*/
export default async function (context, commands) {
};
Added
- Update to Browsertime 21.0.0:
- Upgraded to Geckodriver 0.34.0 #2049.
- Collect CPU consumption for Firefox. Turn that on with
--firefox.powerConsumption true
and includingpower
as a geckoProfilerParams.features #2046. - Added more commands for mouse click on text #2054.
- Updated AndroidCommand so you can run shell on your Android device as root #2055.
- If you mark a test as failure, the exit code from Browsertime will be 1. If the exitCode is set in scripting, we use that and will not change that #2057.
- Generate documentation for scripting using JSDoc #2059.
- Make it easy to use Seleniums action API. Get access to the new command using commands.action.getActions() and chain the action. #2061
- Make sure the visual metrics files are inlcuded in the Docker file #2053.
- Removing QVH from the npm package (used for iPhone video recording but not working) #2051
- Removing visual metrics test images from the npm package #2050.
- Removed the Chromedriver fix that was needed when Chrome for testing broke testing on Chrome :D #2045.
- Refactor of commands/context object to prepare for supporting JSDoc and a little TypeScript to add code completion/IntelliSense in editors #2047.
- Updated documentation for scripting with better JSDoc #204.
- The code for getting Interaction to next paint was broken. This PR fixes it, make the code cleaner and gives more attribution #2060.
- If you use
process.exitCode
in your scripting, it will be respected by sitespeed.io and exit with that exit code #4044.
Fixed
- If a run is markedAsFailure in your Browsertime script, sitespeed.io exits with an error code #4047.