nuka-code
Version:
A package brought to you by the Nuka-Cola Corporation to zap away those pesky `cache`, `node_modules`, and other related files & directories.
75 lines (52 loc) • 2.73 kB
Markdown
<div align="center">
<img src="https://raw.githubusercontent.com/zrosenbauer/nuka-code/main/assets/banner.png" alt="banner for nuka-code" width="100%" />
<blockquote>
<p>
"Zap that cache!"
</p>
</blockquote>
</div>
# nuka-code
A package brought to you by the Nuka-Cola Corporation to zap away those pesky `cache`, `node_modules`, and other related files & directories.
[](https://github.com/zrosenbauer/nuka-code/actions/workflows/ci.yaml)
[](https://biomejs.dev)
## Usage
```bash
npx nuka-code --help
```
OR
```bash
npm install -g nuka-code
nuka-code --help # or nuke --help
```
## What is this?
Nuka-Code is a CLI tool that removes the need to manually remove `cache`, `node_modules`, and other related files & directories. This can replace the usage of `rimraf` or other similar tools, to clean up your project aka restore
it to a clean state (sort of like the first time you `git clone` your repo).
## What does it do?
This package will nuke (delete aka `rm -rf`) the following:
- cache (`.turbo`, `.vite`, `.next`, etc.)
- node_modules
- build artifacts (`dist`, `out`, `build`, `bundle`, etc.)
You can view a full list of globs [here](./docs/globs.md).
> [!WARNING]
> By default, Nuka-Code SHOULD NOT nuke anything important like `package-lock.json`, `src/**/*.ts`, `yarn.lock`, but as with all things, use at your own risk.
## Troubleshooting
### Oops I nuked the wrong thing...
Unless you passed in the `--force` flag, Nuka-Code will ask you for confirmation before nuking anything... so please `git commit` your changes before running `nuka-code`!
### Its not deleting everything I want it to
Please open an issue with what you want to add to the nuke list and we'll see, we also are considering adding a `nuke.config.ts` file to allow for more customization but for now simplicity is the name of the game.
## Acknowledgements
The name, content, art, and other assets are based on the wonderful Fallout universe, and the Nuka-Cola brand. This is fan-art in the form of an npm package and not intended for commercial use or profit, and is not affiliated with Bethesda Softworks or any of its affiliates.
<!-- Sponsorship footer -->
<br>
<br>
<hr>
<div align="center">
<h2>Sponsorship</h1>
<div><sup>Special thanks to:</sup></div>
<br>
<a href="https://www.joggr.io/?utm_source=github&utm_medium=org-readme&utm_campaign=static-docs">
<img src="https://assets.joggr.io/logos/logo.png" width="160"/>
</a>
</div>