webpack/schemas/plugins/ProgressPlugin.json

Packs ECMAScript/CommonJs/AMD modules for the browser. Allows you to split your codebase into multiple bundles, which can be loaded on demand. Supports loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

{
  "definitions": {
    "HandlerFunction": {
      "description": "Function that executes for every progress step.",
      "instanceof": "Function",
      "tsType": "import('../../lib/ProgressPlugin').HandlerFn"
    },
    "ProgressPluginOptions": {
      "description": "Options object for the ProgressPlugin.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "activeModules": {
          "description": "Show active modules count and one active module in progress message.",
          "type": "boolean"
        },
        "dependencies": {
          "description": "Show dependencies count in progress message.",
          "type": "boolean"
        },
        "dependenciesCount": {
          "description": "Minimum dependencies count to start with. For better progress calculation. Default: 10000.",
          "type": "number"
        },
        "entries": {
          "description": "Show entries count in progress message.",
          "type": "boolean"
        },
        "estimatedTime": {
          "description": "Show estimated time remaining based on build progress. Default: false.",
          "type": "boolean"
        },
        "handler": {
          "description": "Function that executes for every progress step.",
          "oneOf": [
            {
              "$ref": "#/definitions/HandlerFunction"
            }
          ]
        },
        "modules": {
          "description": "Show modules count in progress message.",
          "type": "boolean"
        },
        "modulesCount": {
          "description": "Minimum modules count to start with. For better progress calculation. Default: 5000.",
          "type": "number"
        },
        "percentBy": {
          "description": "Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.",
          "enum": ["entries", "modules", "dependencies", null]
        },
        "phaseTimings": {
          "description": "Show a timing breakdown for each build phase when the build completes. Default: false.",
          "type": "boolean"
        },
        "profile": {
          "description": "Collect profile data for progress steps. Default: false.",
          "enum": [true, false, null]
        },
        "progressBar": {
          "description": "Generate progress bar. `\"auto\"` enables it only for interactive terminals. Default: false.",
          "anyOf": [
            {
              "enum": ["auto"]
            },
            {
              "type": "boolean"
            },
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "color": {
                  "description": "Color used for the filled portion of the bar.",
                  "type": "string"
                },
                "name": {
                  "description": "Name shown before the progress bar.",
                  "type": "string"
                },
                "width": {
                  "description": "Width of the progress bar in characters. Default: 25.",
                  "type": "number",
                  "minimum": 1
                }
              }
            }
          ]
        }
      }
    }
  },
  "title": "ProgressPluginArgument",
  "anyOf": [
    {
      "$ref": "#/definitions/ProgressPluginOptions"
    },
    {
      "$ref": "#/definitions/HandlerFunction"
    }
  ]
}