https://github.com/matthieulemoine/unused-webpack-plugin

A webpack plugin to find unused modules/source files.
https://github.com/matthieulemoine/unused-webpack-plugin

plugin unused webpack

Last synced: 3 days ago
JSON representation

A webpack plugin to find unused modules/source files.

• Host: GitHub
• URL: https://github.com/matthieulemoine/unused-webpack-plugin
• Owner: MatthieuLemoine
• Created: 2017-10-07T15:45:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T08:19:33.000Z (about 2 years ago)
• Last Synced: 2024-12-13T20:11:38.720Z (10 days ago)
• Topics: plugin, unused, webpack
• Language: JavaScript
• Size: 1.08 MB
• Stars: 197
• Watchers: 2
• Forks: 19
• Open Issues: 39
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# UnusedWebpackPlugin [![CircleCI](https://circleci.com/gh/MatthieuLemoine/unused-webpack-plugin.svg?style=svg)](https://circleci.com/gh/MatthieuLemoine/unused-webpack-plugin)

A webpack plugin to find unused modules/source files.

![unused-webpack-plugin](images/with-root.png)

## Install

```

npm i --dev unused-webpack-plugin

```

## Usage

```javascript

const path = require('path');

const UnusedWebpackPlugin = require('unused-webpack-plugin');

module.exports = {

  // webpack configuration

  plugins: [

    ...otherPlugins,

    new UnusedWebpackPlugin({

      // Source directories

      directories: [path.join(__dirname, 'src')],

      // Exclude patterns

      exclude: ['*.test.js'],

      // Root directory (optional)

      root: __dirname,

    }),

  ],

};

```

## Options

- `directories` : array of directories where to look for unused source files.

- `exclude` : array of exclude patterns when looking for unused source files.

- `root` : root directory that will be use to display relative paths instead of absolute ones (see below)

- `failOnUnused`: whether or not the build should fail if unused files are found (defaults to `false`)

- `useGitIgnore`: whether or not to respect `.gitignore` file (defaults to `true`)

With root

![With root](images/with-root.png)

Without root

![Without root](images/without-root.png)

## Related

If you're not using webpack, check out [remnants](https://github.com/MatthieuLemoine/remnants).