Skip to content

Document new performance budgets feature #435

Closed
@TheLarkInn

Description

@TheLarkInn

Now that most of the details are stamped out for webpack/webpack#3350 (review), we need to ensure that we are documenting the new configuration features, as well as specify what they represent.

Here is the schema for the new information:

    "performance": {
      "description": "Configuration for web performance recommendations.",
      "additionalProperties": false,
      "properties": {
        "hints": {
          "description": "Turn hints on or off",
          "type": "boolean"
        },
        "maxInitialChunkSize": {
          "description": "Total size of all initial chunks (in bytes)",
          "type": "number"
        },
        "maxAssetSize": {
          "description": "Filesize limit (in bytes) when exceeded, that webpack will provide performance hints",
          "type": "number"
        },
        "errorOnHint": {
          "description": "Throw errors instead of warnings when performance hints are found",
          "type": "boolean"
        }
      },
      "type": "object"
    }

Performance property:
Default recommendations about web practice and performance.

Reference webpack/webpack#3216 for more details.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions