{"id":15598260,"url":"https://github.com/boneskull/gauge-webpack-plugin","last_synced_at":"2025-08-17T05:31:49.845Z","repository":{"id":66095372,"uuid":"69760459","full_name":"boneskull/gauge-webpack-plugin","owner":"boneskull","description":"Progress bar for Webpack built on Gauge supporting multiple targets","archived":false,"fork":false,"pushed_at":"2016-10-01T20:00:00.000Z","size":2,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-29T22:36:55.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boneskull.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-01T19:58:05.000Z","updated_at":"2016-10-27T08:22:27.000Z","dependencies_parsed_at":"2023-04-18T14:00:37.524Z","dependency_job_id":null,"html_url":"https://github.com/boneskull/gauge-webpack-plugin","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fgauge-webpack-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fgauge-webpack-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fgauge-webpack-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boneskull%2Fgauge-webpack-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boneskull","download_url":"https://codeload.github.com/boneskull/gauge-webpack-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230092729,"owners_count":18171715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T01:33:15.312Z","updated_at":"2024-12-17T09:26:14.450Z","avatar_url":"https://github.com/boneskull.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gauge-webpack-plugin\n\n\u003e Progress bar for Webpack built on [Gauge] supporting multiple targets\n\n[![asciicast](https://asciinema.org/a/1aosdrhxdnqzcz958n51fzhq3.png)](https://asciinema.org/a/1aosdrhxdnqzcz958n51fzhq3?autoplay=1)\n\n## Install\n\n```shell\n$ npm install -D webpack gauge-webpack-plugin\n```\n\n## Usage\n\nThis plugin supports multiple webpack targets, and all options of [Gauge].\n\n### Basic\n\n```\nconst GaugePlugin = require('gauge-webpack-plugin');\n```\n\nIn your Webpack config, add `GaugePlugin()` to your `plugins` property:\n\n```js\nplugins: [\n  GaugePlugin()\n]\n```\n\nThis will display a simple progress bar suitable for your terminal.  \n\n\u003e Note: Instantiating the plugin with `new` is not required.\n\n### Custom Section\n\n```js\nplugins: [\n  GaugePlugin('my webpack build')\n]\n```\n\nThis will display a progress bar with a *[section](https://www.npmjs.com/package/gauge#gaugeshowsection--status-completed)* of \"my webpack build\".  \n\n### Gauge Options\n\n```js\nplugins: [\n  GaugePlugin({\n    write: process.stdout\n  })\n]\n````\n\nThe above will write gauge to the `process.stdout` stream instead of the default `progress.stderr` stream.\n \n```js\nplugins: [\n  GaugePlugin('my webpack build', {\n    write: process.stdout,\n    theme: 'ASCII'\n  })\n]\n```\n\nThe above combines a custom section with a custom stream, and forces the \"ASCII\" Gauge theme.\n\n### Multiple Targets\n\nIf your Webpack config exports an *Array* of objects, then you're generating multiple targets (which happens in parallel).  \n\n#### Basic\n\n```js\nconst GaugePlugin = require('gauge-webpack-plugin');\n\nmodule.exports = [\n  {\n    // ...\n    plugins: [\n      GaugePlugin('electron build')\n    ]\n    // ...\n  },\n  {\n    // ...\n    plugins: [\n      GaugePlugin('web build')\n    ]\n    // ...\n  }\n];\n```\n\n#### Custom Gauge Options in Multiple Targets\n\nSince only one progress bar can be displayed at once (reliably), the `Gauge` object itself is a singleton.  If you need to use custom Gauge options (***not** custom section names*), then you should configure the plugin up-front, like this:\n\n```js\nconst GaugePlugin = require('gauge-webpack-plugin');\n\nGaugePlugin({\n  write: process.stdout\n});\n\nmodule.exports = [\n  {\n    // ...\n    plugins: [\n      GaugePlugin('electron build')\n    ]\n    // ...\n  },\n  {\n    // ...\n    plugins: [\n      GaugePlugin('web build')\n    ]\n    // ...\n  }\n];\n```\n\nBoth targets will \"inherit\" the Gauge options from the first call to the plugin.\n\n## License\n\n:copyright: 2016 [Christopher Hiller](https://boneskull.com).  Licensed MIT. \n\n[Gauge]: https://www.npmjs.com/package/gauge\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboneskull%2Fgauge-webpack-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboneskull%2Fgauge-webpack-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboneskull%2Fgauge-webpack-plugin/lists"}