# vite-plugin-simple-vconsole

> [vConsole](https://github.com/Tencent/vConsole) plugin for vite, support both `MPA` and `SPA`.

Latest version **0.1.13** (published 2024-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install vite-plugin-simple-vconsole
pnpm add vite-plugin-simple-vconsole
yarn add vite-plugin-simple-vconsole
bun add vite-plugin-simple-vconsole
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.13 |
| Published | 2024-03-05 |
| First published | 2022-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | heflyaway |

## Links

- npm: https://www.npmjs.com/package/vite-plugin-simple-vconsole
- npm.io page: https://npm.io/package/vite-plugin-simple-vconsole

## Recent versions

- 0.1.13 (latest) — 2024-03-05
- 0.1.12 — 2024-03-05
- 0.1.11 — 2022-10-18
- 0.1.10 — 2022-03-03
- 0.1.9 — 2022-03-03
- 0.1.8 — 2022-03-03
- 0.1.7 — 2022-03-03

## README

# vite-plugin-simple-vconsole [![npm](https://img.shields.io/npm/v/vite-plugin-simple-vconsole.svg)](https://npmjs.com/package/vite-plugin-simple-vconsole)

[vConsole](https://github.com/Tencent/vConsole) plugin for vite, support both `MPA` and `SPA`.

## Install
```shell
yarn add vite-plugin-simple-vconsole -D
# or
npm i vite-plugin-simple-vconsole -D
```

## Example

See [example](./example/)


```shell
cd example

# yarn
yarn
yarn dev

# pnpm
pnpm i
pnpm dev
```

## Usage

```js
// vite.config.js
import vConsolePlugin from 'vite-plugin-simple-vconsole'

export default {
  plugins: [
    vConsolePlugin({
      enable: true,
    }),
  ]
}
```

```ts
interface VConsolePluginOptions {
    enable?: boolean;
    src?: string; // cdn url, default is https://unpkg.com/vconsole@latest/dist/vconsole.min.js
    theme?: 'light' | 'dark';
    injectTo?: 'head' | 'body'; // default 'head'
}
```

## Options
### enable
- **Type:** `boolean`
- **Default:** `false`

### src
- **Type:** `string`
- **Default:** `'https://unpkg.com/vconsole@latest/dist/vconsole.min.js'`

this script will be injected to body of the entry html

### theme
- **Type:** `'light' | 'dark'`
- **Default:** `'light'`

vConosle theme

---
_Source: https://npm.io/package/vite-plugin-simple-vconsole · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._