# vite-plugin-strip-comments

[![Coverage Status](https://coveralls.io/repos/github/thednp/vite-plugin-strip-comments/badge.svg)](https://coveralls.io/github/thednp/vite-plugin-strip-comments)
[![ci](https://github.com/thednp/vite-plugin-strip-comments/actions/workflows/ci.yml/badge.svg)](https://github.com/thednp/vite-plugin-strip-comments/actions/workflows/ci.yml)
[![NPM Version](https://img.shields.io/npm/v/vite-plugin-strip-comments.svg)](https://www.npmjs.com/package/vite-plugin-strip-comments)
[![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-strip-comments.svg)](http://npm-stat.com/charts.html?package=vite-plugin-strip-comments)

A very simple Vite plugin for stripping comments in your production code. Some comments just don't get removed no matter what minify options you set, especially `/* istanbul ignore */` flags. Keep in mind this is experimental, please **use with caution**.

> NOTES
- this plugin should be compatible with rollup, rolldown, tsup and tsdown as well.
- make sure to disable other plugins or options to strip comment to prevent overprocessing and long build times.

## Install

```bash
pnpm install -D vite-plugin-strip-comments
```

```bash
yarn add -D vite-plugin-strip-comments
```

```bash
npm install -D vite-plugin-strip-comments
```

```bash
deno add -D npm:vite-plugin-strip-comments@latest
```

## Usage

### Configuration
```ts
// vite.config.ts
// tsdown.config.ts
// rolldown.config.ts
import { defineConfig } from "vite"; // or tsdown | rolldown
import strip from 'vite-plugin-strip-comments';

export default defineConfig({
  plugins: [
    // ... other plugins
    strip(),
    // using default configuration
  ],
});
```

### Options

* `type`: "none" | "keep-jsdoc" | "keep-legal" (default) - changes the behavior of the transform function
  * **none** removes all comments
  * **keep-legal** remove all commments except those which contain `@copyright`, `@legal` or `@license`, a very good practice to allow open source to shine yes?
  * **keep-jsdoc** remove all commments except legal (described above) and JSDoc
* `enforce`: "pre" (default) | "post" - determines where in the compilation pipeline the plugin should work;

## Contributions
* Found a problem, [report](https://github.com/thednp/vite-plugin-strip-comments/issues) the problem. Thank you!
* Found a fix? Clone, install, apply fix and commit. Thank you!


## License
**vite-plugin-strip-comments** is released under the [MIT License](https://github.com/thednp/vite-plugin-strip-comments/blob/master/LICENSE).