@mogzol/webpackbar 7.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,223 @@
+# Fork of [@unjs/webpackbar](https://github.com/unjs/webpackbar)
+
+This fork includes two improvements over the original v7.0.0 from unjs:
+
+- Fix line counting so that the bar doesn't get duplicated when log lines wrap ([#164](https://github.com/unjs/webpackbar/issues/164))
+- Add a `keepOnBottom` config option to keep the bar on the bottom of the log output instead of the
+  top ([#97](https://github.com/unjs/webpackbar/issues/97))
+
+Other than that it is identical to the unjs version.
+
+---
+
+<!-- automd:badges packagephobia -->
+
+[![npm version](https://img.shields.io/npm/v/@mogzol/webpackbar)](https://npmjs.com/package/@mogzol/webpackbar)
+[![npm downloads](https://img.shields.io/npm/dm/@mogzol/webpackbar)](https://npm.chart.dev/@mogzol/webpackbar)
+[![install size](https://badgen.net/packagephobia/install/@mogzol/webpackbar)](https://packagephobia.com/result?p=@mogzol/webpackbar)
+
+<!-- /automd -->
+
+<div align="center">
+  <!-- replace with accurate logo e.g from https://worldvectorlogo.com/ -->
+  <img width="200" height="200" hspace="25"  src="./assets/logo.svg">
+  <a href="https://webpack.js.org/">
+    <img width="200" height="200" hspace="25" src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon-square-big.svg">
+  </a>
+  <p>Elegant ProgressBar and Profiler for [Webpack](https://webpack.js.org/) and [Rspack](https://rspack.dev/). </p>
+</div>
+
+✔ Display elegant progress bar while building or watch
+
+✔ Support of multiple concurrent builds (useful for SSR)
+
+✔ Pretty print filename and loaders
+
+✔ Windows compatible
+
+✔ Fully customizable using reporters
+
+✔ Advanced build profiler
+
+<div align="center">
+<br>
+<img src="./assets/screen1.png" width="600px">
+<p>Multi progress bars</p>
+<br>
+</div>
+
+<div align="center">
+<br>
+<img src="./assets/screen2.png" width="600px">
+<p>Build Profiler</p>
+<br>
+</div>
+
+<h2 align="center">Getting Started</h2>
+
+To begin, you'll need to install `webpackbar`:
+
+<!-- automd:pm-i -->
+
+```sh
+# ✨ Auto-detect
+npx nypm install @mogzol/webpackbar
+
+# npm
+npm install @mogzol/webpackbar
+
+# yarn
+yarn add @mogzol/webpackbar
+
+# pnpm
+pnpm install @mogzol/webpackbar
+
+# bun
+bun install @mogzol/webpackbar
+
+# deno
+deno install @mogzol/webpackbar
+```
+
+<!-- /automd -->
+
+Then add the reporter as a plugin to your webpack config (make sure `webpack` peer dependency is installed).
+
+**`webpack.config.mjs`**
+
+```js
+import WebpackBar from "webpackbar";
+
+export default {
+  entry: "./src/entry.js",
+  plugins: [
+    new WebpackBar({
+      /* options */
+    }),
+  ],
+};
+```
+
+For using with [Rspack](https://rspack.dev/), you can use `webpackbar/rspack` (make sure `@rspack/core` peer dependency is installed).
+
+**`rspack.config.mjs`**:
+
+```js
+import WebpackBar from "webpackbar/rspack";
+
+export default {
+  entry: "./src/entry.js",
+  plugins: [
+    new WebpackBar({
+      /* options */
+    }),
+  ],
+};
+```
+
+<h2 align="center">Options</h2>
+
+### `name`
+
+- Default: `webpack`
+
+Name.
+
+### `color`
+
+- Default: `green`
+
+Primary color (can be HEX like `#xxyyzz` or a web color like `green`).
+
+### `profile`
+
+- Default: `false`
+
+Enable profiler.
+
+### `fancy`
+
+- Default: `true` when not in CI or testing mode.
+
+Enable bars reporter.
+
+### `basic`
+
+- Default: `true` when running in minimal environments.
+
+Enable a simple log reporter (only start and end).
+
+### `reporter`
+
+Register a custom reporter.
+
+### `reporters`
+
+- Default: `[]`
+
+Register an Array of your custom reporters. (Same as `reporter` but array)
+
+<h2 align="center">Custom Reporters</h2>
+
+Webpackbar comes with a fancy progress-bar out of the box.
+But you may want to show progress somewhere else or provide your own.
+
+For this purpose, you can provide one or more extra reporters using `reporter` and `reporters` options.
+
+**NOTE:** If you plan to provide your own reporter, don't forget to setting `fancy` and `basic` options to false to prevent conflicts.
+
+A reporter should be instance of a class or plain object and functions for special hooks. It is not necessary to implement all functions, webpackbar only calls those that exists.
+
+**Simple logger:**
+
+```js
+const logger = {
+  start(context) {
+    // Called when (re)compile is started
+  },
+  change(context) {
+    // Called when a file changed on watch mode
+  },
+  update(context) {
+    // Called after each progress update
+  },
+  done(context) {
+    // Called when compile finished
+  },
+  progress(context) {
+    // Called when build progress updated
+  },
+  allDone(context) {
+    // Called when _all_ compiles finished
+  },
+  beforeAllDone(context) {},
+  afterAllDone(context) {},
+};
+```
+
+`context` is the reference to the plugin. You can use `context.state` to access status.
+
+**Schema of `context.state`:**
+
+```js
+{
+  start, progress, message, details, request, hasErrors;
+}
+```
+
+<h2 align="center">License</h2>
+
+[MIT](./LICENSE)
+
+<!-- Refs -->
+
+[standard-js-src]: https://flat.badgen.net/badge/code%20style/standard/green
+[standard-js-href]: https://standardjs.com
+[npm-version-src]: https://flat.badgen.net/npm/v/webpackbar/latest
+[npm-version-href]: https://npmjs.com/package/webpackbar
+[npm-downloads-src]: https://flat.badgen.net/npm/dm/webpackbar
+[npm-downloads-href]: https://npmjs.com/package/webpackbar
+[package-phobia-src]: https://flat.badgen.net/packagephobia/install/webpackbar
+[package-phobia-href]: https://packagephobia.now.sh/result?p=webpackbar
+[checks-src]: https://flat.badgen.net/github/checks/nuxt-contrib/webpackbar/master
+[checks-href]: https://github.com/nuxt-contrib/webpackbar/actions

package/dist/rspack.cjs

@@ -0,0 +1,39 @@
+'use strict';
+
+const rspack = require('@rspack/core');
+const plugin = require('./shared/webpackbar.67d03d0b.cjs');
+require('std-env');
+require('pretty-time');
+require('node:path');
+require('ansis');
+require('consola');
+require('node:process');
+require('string-width');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const rspack__default = /*#__PURE__*/_interopDefaultCompat(rspack);
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class WebpackBarProgressPlugin extends rspack__default.ProgressPlugin {
+  constructor(options) {
+    super((percent, message, ...details) => {
+      if (this.webpackbar) {
+        this.webpackbar.updateProgress(percent, message, details);
+      }
+    });
+    __publicField(this, "webpackbar");
+    this.webpackbar = new plugin.WebpackBar(options);
+  }
+  apply(compiler) {
+    super.apply(compiler);
+    this.webpackbar.apply(compiler);
+  }
+}
+
+module.exports = WebpackBarProgressPlugin;

package/dist/rspack.d.cts

@@ -0,0 +1,12 @@
+import rspack from '@rspack/core';
+import { W as WebpackBar, a as WebpackBarOptions } from './shared/webpackbar.28dc8790.cjs';
+export { R as Reporter, S as State } from './shared/webpackbar.28dc8790.cjs';
+import 'webpack';
+
+declare class WebpackBarProgressPlugin extends rspack.ProgressPlugin {
+    webpackbar: WebpackBar;
+    constructor(options?: WebpackBarOptions);
+    apply(compiler: any): void;
+}
+
+export { WebpackBarOptions, WebpackBarProgressPlugin as default };

package/dist/rspack.d.mts

@@ -0,0 +1,12 @@
+import rspack from '@rspack/core';
+import { W as WebpackBar, a as WebpackBarOptions } from './shared/webpackbar.28dc8790.mjs';
+export { R as Reporter, S as State } from './shared/webpackbar.28dc8790.mjs';
+import 'webpack';
+
+declare class WebpackBarProgressPlugin extends rspack.ProgressPlugin {
+    webpackbar: WebpackBar;
+    constructor(options?: WebpackBarOptions);
+    apply(compiler: any): void;
+}
+
+export { WebpackBarOptions, WebpackBarProgressPlugin as default };

package/dist/rspack.d.ts

@@ -0,0 +1,12 @@
+import rspack from '@rspack/core';
+import { W as WebpackBar, a as WebpackBarOptions } from './shared/webpackbar.28dc8790.js';
+export { R as Reporter, S as State } from './shared/webpackbar.28dc8790.js';
+import 'webpack';
+
+declare class WebpackBarProgressPlugin extends rspack.ProgressPlugin {
+    webpackbar: WebpackBar;
+    constructor(options?: WebpackBarOptions);
+    apply(compiler: any): void;
+}
+
+export { WebpackBarOptions, WebpackBarProgressPlugin as default };

package/dist/rspack.mjs

@@ -0,0 +1,33 @@
+import rspack from '@rspack/core';
+import { W as WebpackBar } from './shared/webpackbar.07fec22c.mjs';
+import 'std-env';
+import 'pretty-time';
+import 'node:path';
+import 'ansis';
+import 'consola';
+import 'node:process';
+import 'string-width';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class WebpackBarProgressPlugin extends rspack.ProgressPlugin {
+  constructor(options) {
+    super((percent, message, ...details) => {
+      if (this.webpackbar) {
+        this.webpackbar.updateProgress(percent, message, details);
+      }
+    });
+    __publicField(this, "webpackbar");
+    this.webpackbar = new WebpackBar(options);
+  }
+  apply(compiler) {
+    super.apply(compiler);
+    this.webpackbar.apply(compiler);
+  }
+}
+
+export { WebpackBarProgressPlugin as default };