unrequired - GitLite

KO | EN

gitlite — search

#python #llm #golang #go #android #machine-learning #rust #linux #docker #nodejs #awesome-list #pytorch #mcp #open-source

unrequired

(★ 106)

find unused javascript files in your project

File Explorer

Download Latest Version (.zip)

- _get-used-old.js
- bin.js
- get-all.js
- get-used.js
- index.js
- - a.js
  - b.js
  - index.js
  - missing.js
  - missing.mjs
- - a.js
  - b.json
  - index.js
  - missing.js
- - a.jsx
  - b.jsx
  - index.js
  - missing.js
- - a.js
  - b.js
  - index.js
  - mjs-missing.js
- - a.ts
  - b.ts
  - index.ts
  - missing.ts
- basic.test.js
.esformatter
.gitignore
package.json
README.md
rollup.config.js
scratch.js
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/spencermountain/unrequired

Downloads the entire project code from GitHub to your computer.

cd unrequired

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

<img src="https://img.shields.io/npm/v/unrequired.svg?style=flat-square" />

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  you may want to try the library <a href="https://github.com/smeijer/unimported">@smeijer/unimported</a> instead of this one.
  <div>it's pretty great</div>
  <hr/>
</div>

<img height="15px" src="https://user-images.githubusercontent.com/399657/68221862-17ceb980-ffb8-11e9-87d4-7b30b6488f16.png"/>

<div align="center">

<div><code>unrequired</code></div>
  <div>find unused javascript files</div>
  <div><img src="https://cloud.githubusercontent.com/assets/399657/23590290/ede73772-01aa-11e7-8915-181ef21027bc.png" /></div>

<a href="https://npmjs.org/package/unrequired">
    <img src="https://img.shields.io/npm/v/unrequired.svg?style=flat-square" />
  </a>
</div>

in a big javascript project, sometimes you can forget to delete a unused file.

`linters` and `tree-shakers` are good at finding unused **code** in a module, but they can allow you to have a whole unused file somewhere in your project.

This script follows the require graph, and compares it to the `ls` output, to find any files that are potentially not being used.

`npm install -g unrequired`

`unrequired ./path/to/my/index.js`

or from a node script:
```js
const unrequired = require('unrequired')
let result = unrequired('./tests/mjs/index.js')
console.log(result)
/*
{
  all:[ ... ],  // all javascript files from a 'ls'
  used:[ ... ], // all files in the sourcemap bundle
  unused:[],    // the diff between the two
}
*/
```

running it may be helpful in a large javascript project! who knows.

It uses [rollup](https://rollupjs.org) ⭐️

### Caveats
JSX, and other variants are not currently supported.

It atleast attempts to support `esmodules`, `.mjs files`, and some other things.

it won't catch any unrequired `.json` files.

## See Also
* [unused-webpack-plugin](https://github.com/MatthieuLemoine/unused-webpack-plugin) by Matthieu Lemoine
* [node-trucker](https://github.com/davidmfoley/node-trucker) by Dave Foley

MIT