npm package: @johfe/perfsee-webpack
Description: perfsee webpack plugin
Latest version: 1.13.1

# `@johfe/perfsee-webpack`

Perfsee webpack plugin used to collect bundle information and analyze.

[Repo](https://github.com/perfsee/perfsee) | [Docs](https://perfsee.com/docs)

## Usage

```ts
const { PerfseePlugin } = require('@johfe/perfsee-webpack')

export default {
  ...
  plugins: [
    new PerfseePlugin(options)
  ]
}
```

### `options`

```ts
interface 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

  /**
   * Options for output bundle report static html file.
   * Only used when `enableAudit` is true.
   */
  reportOptions?: {
    /**
     * Automatically open report in default browser.
     *
     * @default true
     */
    openBrowser?: boolean

    /**
     * Path to bundle report file that will be generated.
     * It can be either an absolute path or a path relative to a bundle output directory.
     *
     * By default the report will be output in the cache directory.
     */
    fileName?: string
  }

  /**
   * Used to modify the webpack stats file prcessed by perfsee plugin before uploading.
   *
   * Return undefined means skipping uploading.
   */
  processStats?: (stats: PerfseeReportStats) => undefined | PerfseeReportStats

  /**
   * Rules(audits) apply to this artifact
   *
   * Notice: Functions only works in local testing (when `enableAudit` is set to true).
   *
   * @default ['default']
   */
  rules?: (string | Audit)[]

  /**
   * Whether to include auxiliary files to the bundle result.
   *
   * @default false
   */
  includeAuxiliary?: boolean
}
```