sitespeed:sitespeed

Full name:

ch.ledcom.maven:sitespeed-maven-plugin:0.0.2-SNAPSHOT:sitespeed

Description:

Generate a SiteSpeed.io report. At the moment this Mojo is a simple wrapper around the sitespeed.io bash script.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
phantomJSPath File - Path to the PhantomJS directory.
User property is: siteSpeed.phantomJSPath.
siteSpeedPath File - Path to the SiteSpeed.io directory.
User property is: siteSpeed.siteSpeedPath.
url URL - The start url for the test.
User property is: siteSpeed.url.

Optional Parameters

Name Type Since Description
crawlDepth int - Crawl depth, default is 1.
Default value is: 1.
User property is: siteSpeed.crawlDepth.
maxHeap int - The memory heap size for the java applications.
Default value is: 1024.
User property is: siteSpeed.maxHeap.
nbProcesses int - The number of processes that will analyze pages.
Default value is: 5.
User property is: siteSpeed.nbProcesses.
outputDir File - The result base directory.
Default value is: ${project.build.directory}/sitespeed-result.
User property is: siteSpeed.outputDir.
outputFormat String - The output format, always output as html but you can add images (img).
User property is: siteSpeed.outputFormat.
proxy String - The proxy host & protocol: proxy.soulgalore.com:80.
User property is: siteSpeed.proxy.
proxyType String - The proxy type.
Default value is: http.
User property is: siteSpeed.proxyType.
rulesetVersion String - Which ruleset to use, default is the latest sitespeed.io version.
User property is: siteSpeed.rulesetVersion.
skipUrls String - Skip urls that contains this in the path.
User property is: siteSpeed.skipUrls.
userAgent String - The user agent.
Default value is: Mozilla/6.0.
User property is: siteSpeed.userAgent.
viewport String - The view port, the page viewport size WidthxHeight, like 400x300.
Default value is: 1280x800.
User property is: siteSpeed.viewPort.
yslowFile String - The compiled yslow file.
Default value is: dependencies/yslow-3.1.4-sitespeed.js.
User property is: siteSpeed.yslowFile.
zip boolean - Create a tar zip file of the result files.
Default value is: false.
User property is: siteSpeed.zip.

Parameter Details

crawlDepth:

Crawl depth, default is 1.
  • Type: int
  • Required: No
  • User Property: siteSpeed.crawlDepth
  • Default: 1

maxHeap:

The memory heap size for the java applications.
  • Type: int
  • Required: No
  • User Property: siteSpeed.maxHeap
  • Default: 1024

nbProcesses:

The number of processes that will analyze pages.
  • Type: int
  • Required: No
  • User Property: siteSpeed.nbProcesses
  • Default: 5

outputDir:

The result base directory.
  • Type: java.io.File
  • Required: No
  • User Property: siteSpeed.outputDir
  • Default: ${project.build.directory}/sitespeed-result

outputFormat:

The output format, always output as html but you can add images (img).
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.outputFormat

phantomJSPath:

Path to the PhantomJS directory.
  • Type: java.io.File
  • Required: Yes
  • User Property: siteSpeed.phantomJSPath

proxy:

The proxy host & protocol: proxy.soulgalore.com:80.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.proxy

proxyType:

The proxy type.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.proxyType
  • Default: http

rulesetVersion:

Which ruleset to use, default is the latest sitespeed.io version.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.rulesetVersion

siteSpeedPath:

Path to the SiteSpeed.io directory.
  • Type: java.io.File
  • Required: Yes
  • User Property: siteSpeed.siteSpeedPath

skipUrls:

Skip urls that contains this in the path.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.skipUrls

url:

The start url for the test.
  • Type: java.net.URL
  • Required: Yes
  • User Property: siteSpeed.url

userAgent:

The user agent.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.userAgent
  • Default: Mozilla/6.0

viewport:

The view port, the page viewport size WidthxHeight, like 400x300.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.viewPort
  • Default: 1280x800

yslowFile:

The compiled yslow file.
  • Type: java.lang.String
  • Required: No
  • User Property: siteSpeed.yslowFile
  • Default: dependencies/yslow-3.1.4-sitespeed.js

zip:

Create a tar zip file of the result files.
  • Type: boolean
  • Required: No
  • User Property: siteSpeed.zip
  • Default: false