# webpack-jarvis-zh

**Repository Path**: weizhaokun/webpack-jarvis-zh

## Basic Information

- **Project Name**: webpack-jarvis-zh
- **Description**: 这是webpack-jarvis的中文化界面版本
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-08
- **Last Updated**: 2021-10-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## ScreenShot

![截图](https://gitee.com/weizhaokun/webpack-jarvis-zh/raw/master/dist/assets/ScreenShot.png)



## Installation

```
$ npm i -D webpack-jarvis-zh
```

In your webpack config file:

```js
const Jarvis = require("webpack-jarvis-zh");

/* the rest of your webpack configs */

plugins: [
  new Jarvis({
    port: 1337 // optional: set a port
  })
];
```
## for vue-cli user:
```js
//in vue.config.js
var Jarvis = require('webpack-jarvis-zh')

module.exports = {
    configureWebpack: {
        plugins: [new Jarvis()]
      }
}
```

In your browser open:

```
localhost:1337
```

and you are all set!

## Options

Options are (optionally) passed in to the constructor

```javascript
new Jarvis(options);
```

### `options.port`

Type: `Number`<br>
Default: `1337`

The Jarvis dashboard will open on a localhost server at this port.

### `options.host`

Type: `String`<br>
Default: `localhost`

The Jarvis dashboard will attach to this host, e.g. `0.0.0.0`.

## `options.watchOnly`

Type: `Boolean`<br>
Default: `true`

If set to false, then Jarvis will also run for non-watch builds, and keep running after the build completes.

## `options.packageJsonPath`

Type: `String`<br>
Default: `process.cwd()`

Jarvis will look inside this directory for your package.json.

## Help & Contribute

Setting up the dev environment

Install Dependencies:

```
$ npm install
```

Run Jarvis in your browser, Jarvis root:

```
$ npm run watch
```

Finally, open a browser to `http://localhost:1337`!


#### Notes:

This is a chinese version webpack-jarvis