Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to find dead code in a large react project?

In order to refactor a client-side project, i'm looking for a safe way to find (and delete) unused code.

What tools do you use to find unused/dead code in large react projects? Our product has been in development for some years, and it is getting very hard to manually detect code that is no longer in use. We do however try to delete as much unused code as possible.

Suggestions for general strategies/techniques (other than specific tools) are also appreciated.

Thank you

like image 630
Sinane Avatar asked Jan 11 '19 14:01

Sinane


People also ask

How do you find the dead code?

The quickest way to find dead code is to use a good IDE. Delete unused code and unneeded files. In the case of an unnecessary class, Inline Class or Collapse Hierarchy can be applied if a subclass or superclass is used. To remove unneeded parameters, use Remove Parameter.

Which tool can be used to identify dead code?

Tools like Eclipse, Findbugs and PMD can detect useless (or “unnecessary”) code on the micro-level by analyzing the AST (abstract syntax tree) [PMD]. Statically unreachable code: Code that is not statically referenced is a superset of “dead code”.


5 Answers

Solution:

For node projects, run the following command in your project root:

npx unimported

If you're using flow type annotations, you need to add the --flow flag:

npx unimported --flow

Source & docs: https://github.com/smeijer/unimported

Outcome: enter image description here

Background

Just like the other answers, I've tried a lot of different libraries but never had real success.

I needed to find entire files that aren't being used. Not just functions or variables. For that, I already have my linter.

I've tried deadfile, unrequired, trucker, but all without success.

After searching for over a year, there was one thing left to do. Write something myself.

unimported starts at your entry point, and follows all your import/require statements. All code files that exist in your source folder, that aren't imported, are being reported.

Note, at this moment it only scans for source files. Not for images or other assets. As those are often "imported" in other ways (through tags or via css).

Also, it will have false positives. For example; sometimes we write scripts that are meant to simplify our development process, such as build steps. Those aren't directly imported.

Also, sometimes we install peer dependencies and our code doesn't directly import those. Those will be reported.

But for me, unimported is already very useful. I've removed a dozen of files from my projects. So it's definitely worth a shot.

If you have any troubles with it, please let me know. Trough github issues, or contact me on twitter: https://twitter.com/meijer_s

like image 72
s.meijer Avatar answered Oct 26 '22 04:10

s.meijer


First of all, very good question, in large project coders usually try many lines of code test and at the end of result, hard to find the unused code.

There is two possible that must be work for you - i usually do whenever i need to remove and reduce the unused code into my project.

1st way WebStorm IDE:

If you're using the web-storm IDE for JS development or React JS / React Native or Vue js etc it's tell us and indicate us alote of mention with different color or red warning as unused code inside the editor

but it's not works in your particular scenario there is another way to remove the unused code .

2nd Way unrequired Library:

The second way to remove the unused code inside the project is unrequired library you can visit here : unrequired github

another library called depcheck under NPM & github here

Just follow their appropriate method - how to use them you will fix this unused issue easily

Hopefully that helps you

like image 44
Muhammad Umair Ghufran Avatar answered Oct 26 '22 05:10

Muhammad Umair Ghufran


Libraries such as unrequired and deadcode only support legacy code. In order to find the unused assets, to remove manually, you can use deadfile

library:https://m-izadmehr.github.io/deadfile/

  • Out of box support for ES5, ES6, React, Vue, ESM, CommonJs.
  • It supports import/require and even dynamic import.

enter image description here

It can simply find unused files, in any JS project.

Without any config, it supports ES6, React, JSX, and Vue files: enter image description here

like image 16
Moji Izadmehr Avatar answered Oct 26 '22 04:10

Moji Izadmehr


Solution for Webpack: UnusedWebpackPlugin

I work on a big front-end React project (1100+ js files) and stumbled upon the same problem: how to find out which files are unused anymore?

I've tested the next tools so far:

  • findead
  • deadfile
  • unrequired

None of them really worked. One of the reason is that we use "not standard" imports. In additional to the regular relative paths in our imports we also use paths resolved by the webpack resolve feature which basically allows us to use neat import 'pages/something' rather than cumbersome import '../../../pages/something'.

UnusedWebpackPlugin

So here is the solution I've finally come across thanks to Liam O'Boyle (elyobo) @GitHub: https://github.com/MatthieuLemoine/unused-webpack-plugin

It's a webpack plugin so it's gonna work only if your bundler is webpack.

I personaly find it good that you don't need to run it separately but instead it's built into your building process throwing warnings when something is not ok.

Our research topic: https://github.com/spencermountain/unrequired/issues/6

like image 15
Onkeltem Avatar answered Oct 26 '22 03:10

Onkeltem


My approach is an intensive use of ESlint and make it run both on IDE ad before every push.

It points out unused variables, methods, imports and so on. Webpack (which has too nice plugins for dead code detection) take care about avoiding to bundle unimported code.

like image 4
Mosè Raguzzini Avatar answered Oct 26 '22 05:10

Mosè Raguzzini