schemas/plugins/ProgressPlugin.json - main - githubmirror/webpack

schemas/plugins/ProgressPlugin.json
103 строки3 KB
Alexander Akait
feat: built-in build progress (infrastructureLogging.progress) and ProgressPlugin enhancements (#21352)
07 июл 2026, 20:06
07 июл 2026, 20:06628a948
{
  "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"
    }
  ]
}