# useless-files-clean-webpack-plugin

**Repository Path**: zRainy/useless-files-clean-webpack-plugin

## Basic Information

- **Project Name**: useless-files-clean-webpack-plugin
- **Description**: 查询（删除）项目中未使用文件的webpack插件，支持多个版本，详情请查看版本支持清单
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-01-30
- **Last Updated**: 2023-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# useless-files-clean-webpack-plugin

查询（删除）项目中未使用文件的 webpack 插件，支持多个版本，详情请查看版本支持清单,适用于使用 webpack 构建的工程项目。

## 安装

```
 npm i useless-files-webpack-plugin -d
```

## 使用

`webpack.config.js` #webpack 配置文件

```
const UselessFilesCleanWebpackPlugin = require('useless-files-clean-webpack-plugin')
module.exports = {
    plugins: [
        new UselessFilesCleanWebpackPlugin({
            root: './',
            out: './',
            clean: false,
            exclude: ['*.gitignore', 'node_modules'],
            log:'console'
        })
    ]
}
```

`options`
| 名称 | 参数 |是否必填|默认值| 介绍 |
| ---- | ---- | ---- | ---- | ---- |
| root | string | 是 | 无 |文件根目录，查询内部所有文件，判断文件是否存在于依赖中 |
| out | string | 是 | 无 | 输出全部文件列表、依赖文件列表、未使用文件列表的目录 |
| clean | boolean | 否 | false | 是否删除未使用文件 |
| exclude | array | 否 | [] | 排除的文件，支持输出传入多个 minimatch 匹配模式 |
| log | string | 否 |  无（不输出） | 指定输出方式（console or file），配合此项你可以清楚知道插件为你做了什么，同时可以在开发环境关闭clean的情况下及时知道那些文件时未使用的 |

## 版本支持

已适配 webpack@1x 到 5x

## 维护

此项目会长期维护，后续会增加各种版本的组件版本，有感兴趣可以共同维护；

所有反馈请通过 github 的 issue；

如果觉得对你有帮助请给作者一个 star。