# unplugin-keep-polite

> keep polite by plugin

Latest version **0.2.4** (published 2022-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install unplugin-keep-polite
pnpm add unplugin-keep-polite
yarn add unplugin-keep-polite
bun add unplugin-keep-polite
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2022-12-25 |
| First published | 2022-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | tangdaoyuan <1197633750@qq.com> (https://github.com/tangdaoyuan/) |
| Maintainers | sugerroadsource |
| Keywords | unplugin, keep, polite, unplugin-keep-polite |

## Links

- npm: https://www.npmjs.com/package/unplugin-keep-polite
- Repository: https://github.com/tangdaoyuan/unplugin-keep-polite
- Homepage: https://github.com/tangdaoyuan/unplugin-keep-polite#readme
- Issues: https://github.com/tangdaoyuan/unplugin-keep-polite/issues
- npm.io page: https://npm.io/package/unplugin-keep-polite

## Dependencies (5)

- [install](https://npm.io/package/install.md) ^0.13.0
- [unplugin](https://npm.io/package/unplugin.md) ^1.0.0
- [picocolors](https://npm.io/package/picocolors.md) ^1.0.0
- [magic-string](https://npm.io/package/magic-string.md) ^0.27.0
- [impolite-word](https://npm.io/package/impolite-word.md) ^0.0.5

## Recent versions

- 0.2.4 (latest) — 2022-12-25
- 0.2.2 — 2022-09-12
- 0.2.1 — 2022-08-07
- 0.1.1 — 2022-07-16
- 0.1.0 — 2022-06-14
- 0.0.7 — 2022-06-13
- 0.0.6 — 2022-06-13
- 0.0.5 — 2022-06-13
- 0.0.4 — 2022-06-05
- 0.0.2 — 2022-05-01

## README

# unplugin-keep-polite

>  Warning you impolite words in the development console for Vite, Webpack, and Rollup

## Install

```bash
npm i unplugin-keep-polite --save-dev
```

## Usage
  
<details open>
  <summary>Vite</summary>

```ts
import unPluginPolite from 'unplugin-keep-polite'
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    // ...
    unPluginPolite.vite(),
  ],
  // ...
})
```
</details>

<details>
  <summary>Webpack</summary>

```ts
import unPluginPolite from 'unplugin-keep-polite'

export default {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js',
  },
  plugins: [unPlugin.webpack()],
}
```
</details>

<details>
  <summary>Rollup</summary>

```ts
import { defineConfig } from 'rollup'
import unPluginPolite from 'unplugin-keep-polite'

export default defineConfig({
  input: 'src/index.ts',
  output: {
    file: 'dist/bundle.js',
    format: 'cjs',
  },
  plugins: [
    unPluginPolite.rollup(),
  ],
})
```
</details>



## Options

### autoReplace

  - Auto-replace impolite words
  - Type: Boolean
  - Default: `false`

### replacer
  
  - Replace impolite words
  - Type: String
  - Default: `true`

### customDict
  
  - Custom dictionary for impolite words
  - Type: String[] | { path: string }
  - Default: `undefined`
  - Example: `{ path: 'dict.json' }`

### extraDict

  - Add extra dictionary for impolite words
  - Type: String[]
  - Default: `[]`
  - Example: `[]`

---
_Source: https://npm.io/package/unplugin-keep-polite · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._