@perfsee/esbuild
Advanced tools
@perfsee/esbuildPerfsee esbuild plugin used to collect bundle information and analyze.
const { PerfseePlugin } = require('@perfsee/esbuild')
// Do not use buildAsync
require('esbuild').build({
// ...
plugins: [PerfseePlugin(options)],
// ...
})
optionsinterface Options {
/**
* Your project ID on Perfsee platform.
*
* **Required if you want ot upload the build to Perfsee platform for further analysis.**
*/
project?: string
/**
* Give a uniq name for the bundled artifact.
*
* This option will be very useful when there are multiple builds in a single commit(in single CI progress)
*
* Because the comparison with historical builds is based on `Entrypoint`, and if multiple builds
* emit same entrypoint names, we can't detect which entrypoint is the correct one to be compared.
*
* e.g. `build-1/main` and `build-2/main` are more confusing then `landing/main` and `customers/main`.
*
* @default 'main'
*/
artifactName?: string
/**
* Enable analysis and audit right after bundle emitted.
*
* With this option being `true`, perfsee will output bundle analyzed result in-place in CI workflow,
* or start a server which serves html report viewer in non-CI environment.
*
* It would slow down the progress if enabled.
*
* @environment `PERFSEE_AUDIT`
*
* @default false
* @default true // "in CI environment"
*/
enableAudit?: boolean
/**
* Used to customize project's own bundle auditing logic.
*
* Return `true` means this bundle should pass auditing, `false` to fail.
*
* Only used when `enableAudit` is true.
*
* @default (score) => score >= 80
*/
shouldPassAudit?: (score: number, result: BundleResult) => Promise<boolean> | boolean
/**
* Fail the progress if bundle audit not pass and exit with non-zero code.
*
* set to `true` to fail the CI pipeline.
*
* @default false
*/
failIfNotPass?: boolean
/**
* Authentication token used for uploading build to remote server.
* will also read from env `PERFSEE_TOKEN` if not provided.
*
* @environment `PERFSEE_TOKEN`
*/
token?: string
/**
* Server options used to start local report viewer
*/
serverOptions?: {
/**
* Port the local report server will listen on
*
* @default 8080
*/
port?: number
/**
* Host of the local report server
*
* @default '127.0.0.1'
*/
host?: string
/**
* Path of the static files used to render report.
*
* Unless you want to change the default report viewer, otherwise leave it undefined.
*/
publicPath?: string
}
}
1.3.0 (2023-02-27)
artifactName by bundle results (fe4fe35)FAQs
perfsee esbuild plugin
The npm package @perfsee/esbuild receives a total of 0 weekly downloads. As such, @perfsee/esbuild popularity was classified as not popular.
We found that @perfsee/esbuild demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.