npmpackage.info

Gathering detailed insights and metrics for webpack-deadcode-plugin

Other packages similar to webpack-deadcode-plugin

@types/webpack-deadcode-plugin

0.1.5

TypeScript definitions for webpack-deadcode-plugin

terser-webpack-plugin

5.3.10

Terser plugin for webpack

html-webpack-plugin

5.6.3

Simplifies creation of HTML files to serve your webpack bundles

mini-css-extract-plugin

2.9.2

extracts CSS into separate files

Gathering detailed insights and metrics for webpack-deadcode-plugin

webpack-deadcode-plugin

Webpack plugin to detect unused files and unused exports in used files

0.1.17

352

MIT

JavaScript

8,121,065 2.1

Installations

npm install webpack-deadcode-plugin

Pull Requests

Open

1

Total

44

Closed

24

Merged

19

Issues

Open

8

Total

21

Closed

13

Releases

Support webpack 5

0.1.13

Published on 29 May 2021

0.1.10

Published on 27 Jan 2019

0.1.4

Published on 30 May 2018

View all 3 releases

Developer

MQuy

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=6.11.5

Typescript Support

No

Node Version

16.14.2

NPM Version

8.5.0 Statistics

352 Stars

93 Commits

16 Forks

5 Watching

3 Branches

12 Contributors

Updated on 03 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

8,121,065

Last day

8.6%

13,959

Compared to previous day

Last week

17.6%

68,131

Compared to previous week

Last month

16.9%

266,302

Compared to previous month

Last year

27.6%

2,456,137

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chalk fast-glob

Peer Dependencies

webpack

Versions

Webpack Deadcode Plugin

Webpack plugin to detect unused files and unused exports in used files

Installation

Via npm:

1$ npm install webpack-deadcode-plugin --save-dev

Via yarn:

1$ yarn add -D webpack-deadcode-plugin

output

Usage

The plugin will report unused files and unused exports into your terminal but those are not part of your webpack build process, therefore, it will not fail your build (warning you). Simple add into your webpack config as follows:

✍️ If you use babel-loader, you have to set modules: false to make it works

1# in .babelrc
2{
3  "presets": [
4    ["env", { modules: false }]
5  ]
6}
7
8# or in webpack.config.js -> module/rules
9{
10  loader: 'babel-loader',
11  options: {
12    presets: [
13      ['env', { modules: false }]
14    ]
15  }
16}

Webpack 3

1const DeadCodePlugin = require('webpack-deadcode-plugin');
2
3const webpackConfig = {
4  ...
5  plugins: [
6    new DeadCodePlugin({
7      patterns: [
8        'src/**/*.(js|jsx|css)',
9      ],
10      exclude: [
11        '**/*.(stories|spec).(js|jsx)',
12      ],
13    })
14  ]
15}

Webpack 4

1const DeadCodePlugin = require('webpack-deadcode-plugin');
2
3const webpackConfig = {
4  ...
5  optimization: {
6    usedExports: true,
7  },
8  plugins: [
9    new DeadCodePlugin({
10      patterns: [
11        'src/**/*.(js|jsx|css)',
12      ],
13      exclude: [
14        '**/*.(stories|spec).(js|jsx)',
15      ],
16    })
17  ]
18}

Using non-existent css class names

To detect using non-existent class names in your codebase, you have to use es6-css-loader instead of style-loader/mini-css-extract-plugin. They are quite similiar in term of api except es6-css-loader supports to detect non-existent css class names.

non-existent css class names

You can check samples folder, how to to config webpack-deadcode-plugin and es6-css-loader.

Typescript

Using with typescript loader (ts-loader, awesome-typescript-loader), if you enable transpileOnly/happyPackMode, output might be not correct due to this issue. In case of incorrect output, the workaround solution is disabling transpileOnly, it will slow down webpack compiling time.

✍ Under some circumstances and production mode, if your output displays incorrect unused files, we encourage switching to awesome-typescript-loader.

Configuration

1new DeadCodePlugin(options);

options.patterns (default: `["**/."]`)

The array of patterns to look for unused files and unused export in used files. Directly pass to fast-glob

options.exclude (default: `[]`)

The array of patterns to not look at.

options.context

Current working directory for patterns above. If you don't set it explicitly, your webpack context will be used.

options.failOnHint (default: `false`)

Deadcode does not interrupt the compilation by default. If you want to cancel the compilation, set it true, it throws a fatal error and stops the compilation.

options.detectUnusedFiles (default: `true`)

Whether to run unused files detection or not.

options.detectUnusedExport (default: `true`)

Whether to run unused export detection or not.

options.log (default: `"all"`)

"all": show all messages.

"unused": only show messages when there are either unused files or unused export.

"none": won't show unused files or unused export messages in the terminal, it can keep terminal clean when set exportJSON to true

options.exportJSON (default: `false`)

false: won't create deadcode.json for the unused files and unused export.

true: create deadcode.json for the unused files and unused export at the root of the project.

You can set exportJSON to a specific path, and it will generate deadcode.json in that path.

1new DeadCodePlugin({
2  patterns: ["*.(js|css)"],
3  exclude: ["**/node_modules/**"],
4  log: "none",
5  exportJSON: "./analysis"
6}),

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

52 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6

Score

2.1

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to webpack-deadcode-plugin

Other packages similar to webpack-deadcode-plugin

webpack-deadcode-plugin

Installations

Pull Requests

1

44

24

19

Issues

8

21

13

Releases

Developer

MQuy

Developer Guide

CommonJS

>=6.11.5

No

16.14.2

8.5.0

Statistics

Languages

Total Downloads

8,121,065

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Webpack Deadcode Plugin

Installation

Usage

Using non-existent css class names

Typescript

Configuration

options.patterns (default: ["**/*.*"])

options.exclude (default: [])

options.context

options.failOnHint (default: false)

options.detectUnusedFiles (default: true)

options.detectUnusedExport (default: true)

options.log (default: "all")

options.exportJSON (default: false)

10

10

3

0

0

0

0

0

0

0

2.1

/10

options.patterns (default: `["**/."]`)

options.exclude (default: `[]`)

options.failOnHint (default: `false`)

options.detectUnusedFiles (default: `true`)

options.detectUnusedExport (default: `true`)

options.log (default: `"all"`)

options.exportJSON (default: `false`)