https://github.com/tengweiherr/purge-img
A CLI tool to detect and remove unused images in your project 🏞️🧹✨
https://github.com/tengweiherr/purge-img
cli node-fs npm-package
Last synced: 25 days ago
JSON representation
A CLI tool to detect and remove unused images in your project 🏞️🧹✨
- Host: GitHub
- URL: https://github.com/tengweiherr/purge-img
- Owner: tengweiherr
- Created: 2025-04-26T14:39:36.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2025-04-27T17:42:43.000Z (27 days ago)
- Last Synced: 2025-04-29T19:54:10.723Z (25 days ago)
- Topics: cli, node-fs, npm-package
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/purge-img
- Size: 2.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
I got tired of checking for unused images as they piled up, so I built a CLI tool to detect and get rid of them.
# 🏞️ Purge IMG 🧹
A CLI tool to detect and remove unused images in your project.
https://github.com/user-attachments/assets/e16bec33-167a-41b6-89af-668debf962b1
## ⚠️ Warning
Important:
Only use this tool inside your own project repositories.
Do not run this on system folders, external drives, or outside of your intended project —
it may detect and delete images based on filename matches.
## Usage
```bash
# Scan a specific folder (relative to the current working directory) and print unused images without deleting anything
npx purge-img src/assets
# Actually remove unused images
npx purge-img src/assets -r
# Ignore specific patterns
npx purge-img src/assets -i "**/*.test.tsx"
# Show help
npx purge-img --help
```
## Supported extensions
- `.js`, `.jsx`, `.ts`, `.tsx`, `.html`, `.css`, `.scss`, `.vue`, `.svelte`, `.md`, `.mdx`, `.json`, `.yaml`, `.yml`, `.txt`
## Supported image formats
- `.png`, `.jpg`, `.jpeg`, `.svg`, `.gif`, `.webp`, `.avif`, `.apng`
## How it works
1. Scans the specified assets folder for all supported image files
2. Scans the project for source files with supported extensions
3. Checks if the image file basename is used in the supported source files (e.g., `file.png`)
4. Returns a list of unused images
## Ignore patterns
You can use the `-i` or `--ignore` flag to specify patterns to ignore. You can specify multiple patterns by using the flag multiple times.
```bash
npx purge-img src/assets -i "**/*.test.tsx"
```
You can also create an `.purgeimgignore` file in the root of your project to specify patterns to ignore.
```bash
# .purgeimgignore
**/*.test.tsx
```
## Caveats
- It doesn't differentiate files with the same name from different folders
## License
MIT