https://github.com/s00d/webpack-progress-ora-plugin

https://github.com/s00d/webpack-progress-ora-plugin

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/s00d/webpack-progress-ora-plugin
• Owner: s00d
• License: mit
• Created: 2018-05-24T11:45:50.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-30T17:36:30.000Z (over 5 years ago)
• Last Synced: 2025-03-03T02:34:00.943Z (over 1 year ago)
• Language: JavaScript
• Size: 57.6 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/s00d/webpack-progress-ora-plugin.svg?branch=master)](https://travis-ci.org/s00d/webpack-progress-ora-plugin)

[![npm version](https://badge.fury.io/js/webpack-progress-ora-plugin.svg)](https://badge.fury.io/js/webpack-progress-ora-plugin)

# webpack-progress-ora-plugin

![webpack-progress-ora-plugin](https://github.com/s00d/webpack-progress-ora-plugin/raw/master/image.gif)

## Installation

```

npm i -D webpack-progress-ora-plugin

```

## Usage

Include the following in your Webpack config.

```javascript

var WebpackProgressOraPlugin = require('webpack-progress-ora-plugin');

...

plugins: [

  new WebpackProgressOraPlugin()

]

```

## Options

Accepts almost all of the same options as [ora](https://github.com/sindresorhus/ora#options).

additional

- pattern - pattern for message(default: chalk.bold('[') + ':percent:%' + chalk.bold('] ') + chalk.cyan.bold(':text:')) 

    * params: :percent: - percent complete; :text: - build stage

- stderr_check - check stderr and show message if not exist(default: false)

- pattern_no_stderr -(default: ▒)

- clear - clear terminal after start and end build

- clear_on_update  - clear terminal when progress update

- update_render - render text every update progress

```javascript

new WebpackProgressOraPlugin({

  stderr_check: true,

  interval: 300

})

```

## License

MIT