Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/huruji/eruda-webpack-plugin

A webpack plugin of eruda to help you develop mobile app
https://github.com/huruji/eruda-webpack-plugin

debug debugging-tools eruda webpack webpack-plugin webpack3 webpack4

Last synced: 2 months ago
JSON representation

A webpack plugin of eruda to help you develop mobile app

Awesome Lists containing this project

README

        

English | [中文](./README_CN.md)
[![NPM](https://nodei.co/npm/eruda-webpack-plugin.png)](https://npmjs.org/package/eruda-webpack-plugin)

# eruda-webpack-plugin
A webpack plugin of [eruda](https://github.com/liriliri/eruda) to help you develop mobile app

## How to use

```js
npm i --save-dev eruda-webpack-plugin
```

```js
// webpack.config.js
const ErudaWebpackPlugin = require('eruda-webpack-plugin')
const HtmlWebpackPlugin = require('html-webpack-plugin')

const config = {
devServer: {
contentBase: path.join(__dirname, 'dist'),
port: 1000
},
mode: "development",
plugins: [
new HtmlWebpackPlugin({
template: path.resolve(__dirname, 'index.html')
}),
new ErudaWebpackPlugin({
entry: /index\.js$/
})
]
}
```

Open `http://localhost:1000` in your browser, you can use `eruda` to debug your mobile app

## Using eruda's plugin

```js
new ErudaWebpackPlugin({
plugins: ['fps', 'timing']
})
```

## Options

### injectOnlyOnce (make sure your npm package version > `1.5.0`)

Ensure `eruda` and it's plugins will be injected only once. You can drink a cup of coffe instead of write the regex of `entry` option.

**Default value: `true`**

```js
new ErudaWebpackPlugin({
injectOnlyOnce: true
})
```
### force

`eruda-webpack-plugin` only works in `development` mode, if you need it in other modes, you can set `force` as `true`

**Default value: `false`**

```js
new ErudaWebpackPlugin({
force: true
})
```

### tool

Choose which eruda's tools you want, by default all will be added.

```js
new ErudaWebpackPlugin({
tool: ['console', 'elements']
})
```

### plugins

add eruda's plugin

```js
new ErudaWebpackPlugin({
plugins: ['fps', 'timing']
})
```

### entry

the assets which should inject `eruda` instance

all `.js` assets will be injected by default

```js
new ErudaWebpackPlugin({
entry: [/index\.js$/, /page1\.js$/]
})
```

### filters

the assets which don't need inject `eruda` instance

this option is contrary to `entry`

```js
new ErudaWebpackPlugin({
filters: [/subpage\.js$/]
})
```