Skip to content

Commit ad2fca4

Browse files
author
parkerziegler
committed
Deprecate Node 6 support.
1 parent 5f6e2e4 commit ad2fca4

2 files changed

Lines changed: 19 additions & 17 deletions

File tree

.travis.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
language: node_js
22

33
node_js:
4-
- "6"
54
- "8"
65
- "10"
76

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,25 @@ That's cool, but it's mostly noise and scrolly and not super helpful. This plugi
1818

1919
### Use
2020

21+
**`webpack-dashboard@^2.1.1` requires Node 8 or above.** Previous versions support down to Node 6.
22+
2123
First, import the plugin and add it to your webpack config, or apply it to your compiler:
2224

2325
```js
2426
// Import the plugin:
25-
var DashboardPlugin = require('webpack-dashboard/plugin');
27+
var DashboardPlugin = require("webpack-dashboard/plugin");
2628

2729
// If you aren't using express, add it to your webpack configs plugins section:
28-
plugins: [
29-
new DashboardPlugin()
30-
]
30+
plugins: [new DashboardPlugin()];
3131

3232
// If you are using an express based dev server, add it with compiler.apply
3333
compiler.apply(new DashboardPlugin());
3434
```
35+
3536
If using a custom port, the port number must be included in the options object here, as well as passed using the -p flag in the call to webpack-dashboard. See how below:
3637

3738
```js
38-
plugins: [
39-
new DashboardPlugin({ port: 3001 })
40-
]
39+
plugins: [new DashboardPlugin({ port: 3001 })];
4140
```
4241

4342
In the latest version, you can either run your app, and run `webpack-dashboard` independently (by installing with `npm install webpack-dashboard -g`) or run webpack-dashboard from your `package.json`. So if your dev server start script previously looked like:
@@ -55,6 +54,7 @@ You would change that to:
5554
"dev": "webpack-dashboard -- node index.js"
5655
}
5756
```
57+
5858
Now you can just run your start script like normal, except now, you are awesome. Not that you weren't before. I'm just saying. More so.
5959

6060
### Run it
@@ -64,8 +64,9 @@ Finally, start your server using whatever command you have set up. Either you ha
6464
Then, sit back and pretend you're an astronaut.
6565

6666
### Supported Operating Systems and Terminals
67+
6768
**macOS →**
68-
Webpack Dashboard works in Terminal, iTerm 2, and Hyper. For mouse events, like scrolling, in Terminal you will need to ensure *View → Enable Mouse Reporting* is enabled. This is supported in macOS El Capitan, Sierra, and High Sierra. In iTerm 2, to select full rows of text hold the <kbd>⌥ Opt</kbd> key. To select a block of text hold the <kbd>⌥ Opt</kbd> + <kbd>⌘ Cmd</kbd> key combination.
69+
Webpack Dashboard works in Terminal, iTerm 2, and Hyper. For mouse events, like scrolling, in Terminal you will need to ensure _View → Enable Mouse Reporting_ is enabled. This is supported in macOS El Capitan, Sierra, and High Sierra. In iTerm 2, to select full rows of text hold the <kbd>⌥ Opt</kbd> key. To select a block of text hold the <kbd>⌥ Opt</kbd> + <kbd>⌘ Cmd</kbd> key combination.
6970

7071
**Windows 10 →** Webpack Dashboard works in Command Prompt, PowerShell, and Linux Subsystem for Windows. Mouse events are not supported at this time, as discussed further in the documentation of the underlying terminal library we use [Blessed](https://github.com/chjj/blessed#windows-compatibility). The main log can be scrolled using the <kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>Page Up</kbd>, and <kbd>Page Down</kbd> keys.
7172

@@ -74,25 +75,27 @@ Webpack Dashboard works in Terminal, iTerm 2, and Hyper. For mouse events, like
7475
### API
7576

7677
#### webpack-dashboard (CLI)
78+
7779
##### Options
7880

79-
- `-c, --color [color]` - Custom ANSI color for your dashboard
80-
- `-m, --minimal` - Runs the dashboard in minimal mode
81-
- `-t, --title [title]` - Set title of terminal window
82-
- `-p, --port [port]` - Custom port for socket communication server
81+
- `-c, --color [color]` - Custom ANSI color for your dashboard
82+
- `-m, --minimal` - Runs the dashboard in minimal mode
83+
- `-t, --title [title]` - Set title of terminal window
84+
- `-p, --port [port]` - Custom port for socket communication server
8385

8486
##### Arguments
8587

8688
`[command]` - The command you want to run, i.e. `webpack-dashboard -- node index.js`
8789

8890
#### Webpack plugin
91+
8992
#### Options
9093

91-
- `host` - Custom host for connection the socket client
92-
- `port` - Custom port for connecting the socket client
93-
- `handler` - Plugin handler method, i.e. `dashboard.setData`
94+
- `host` - Custom host for connection the socket client
95+
- `port` - Custom port for connecting the socket client
96+
- `handler` - Plugin handler method, i.e. `dashboard.setData`
9497

95-
*Note: you can also just pass a function in as an argument, which then becomes the handler, i.e. `new DashboardPlugin(dashboard.setData)`*
98+
_Note: you can also just pass a function in as an argument, which then becomes the handler, i.e. `new DashboardPlugin(dashboard.setData)`_
9699

97100
### Local Development
98101

0 commit comments

Comments
 (0)