File Scavenger - VS Code Extension
File Scavenger is a powerful VS Code extension designed to help developers identify and manage unused files in their projects. With an intuitive interface and advanced scanning capabilities, File Scavenger ensures your workspace stays clean and efficient.
Table of Contents
- Features
- Installation
- Usage
- Configuration
- Screenshots
- Contributing
- License
- Support
- Credits
Features ✨
- Scan for Unused Files: Automatically detect files that are not referenced anywhere in your project.
- Customizable Configuration: Define file types, ignored folders, and root files to tailor the scan to your project's needs.
- Interactive Tree View: View unused files in a structured tree view for easy navigation.
- File Status Toggle: Mark files as used with a single click.
- File Decorations: Visual indicators in the file explorer show which files are unused.
- Batch Processing: Efficiently scan large projects by processing files in batches.
- Real-Time Updates: Automatically update the unused files list when files are deleted.
Installation 🛠️
Prerequisites
- Visual Studio Code: Ensure you have VS Code installed on your machine.
- Node.js: (Optional) Required if you plan to customize or contribute to the extension.
Installation Steps
Open VS Code:
- Launch Visual Studio Code on your machine.
Go to Extensions:
- Click on the Extensions icon in the Activity Bar on the side of the window or press
Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS).
Search for File Scavenger:
- In the Extensions view search bar, type "File Scavenger".
Install the Extension:
- Click the Install button next to the File Scavenger extension.
Reload VS Code:
- After installation, click Reload to activate the extension.
Verify Installation:
- Open the Command Palette (
Ctrl+Shift+P or Cmd+Shift+P) and type File Scavenger: Highlight Unused Files. If the command appears, the extension is successfully installed.
Usage 🚀
1. Scan for Unused Files
- Open the Command Palette (
Ctrl+Shift+P or Cmd+Shift+P).
- Type and select
File Scavenger: Highlight Unused Files.
- The extension will scan your workspace and display unused files in the Unused Files view.
2. View Unused Files
- After the scan, unused files will appear in the Unused Files tree view in the Explorer sidebar.
- Click on a file to open it.
3. Toggle File Status
- Right-click on a file in the Unused Files view or file explorer.
- Select
Toggle File Status to mark it as used or unused.
- Files marked as used will no longer appear in the unused files list.
4. Reset File Status
- Right-click on a file in the Unused Files view or file explorer.
- Select
Reset File State to clear its status and include it in future scans.
5. Customize Configuration
- Create a
.filescavengerrc file in the root of your workspace to customize the scan settings:
{
"fileTypes": [".js", ".ts", ".css", ".html"],
"ignoreFolders": ["node_modules", "dist"],
"ignoreRootFiles": ["README.md", "package.json"]
}
- If no configuration file is found, the extension will use default settings.
Configuration ⚙️
Default Configuration:
By default, File Scavenger scans for the following file types and ignores common folders and files:
File Types: .js,.ts,.css,.scss,.html,.json,.md, and more.
Ignored Folders: node_modules,.git,dist,build,out,bin,obj,vendor,logs,temp.
Ignored Root Files: README.md,package.json,tsconfig.json,.gitignore,.env, etc.
Custom Configuration:
To customize the scan, create a .filescavengerrc file in your workspace root with the following structure:
{
"fileTypes": [".js", ".ts", ".css"],
"ignoreFolders": ["node_modules", "dist"],
"ignoreRootFiles": ["README.md", "package.json"]
}
Screenshots 📸
Unused Files Tree View
File Decorations in Explorer
Toggle File Status
Contributing 🤝
Contributions are welcome! If you find a bug or have a feature request, contribute to File Scavenger by opening an issue on the GitHub repository.
To contribute code:
Fork the repository:
Click the Fork button on the top right of the repository.
Clone the forked repository to your local machine:
git clone https://github.com/Dhruv9051/file-scavenger.git
Create a new branch for your bug or feature:
git checkout -b feature/your-feature-name
Push changes:
Make your changes and test thoroughly.
Commit your changes and push them to your forked repository:
```bash
git add .
git commit -m "Add your commit message here"
git push origin feature/your-feature-name
```
Submit a pull request:
Go to the original repository and click New Pull Request. Provide a detailed description of your changes.
License 📜
This project is licensed under the MIT License. See the LICENSE file for details.
Support ❤️
If you find this extension helpful, consider supporting its development.
- ⭐ Star the repository on GitHub.
- 🐛 Report issues or suggest features in the Issues Section.
- 💬 Share feedback or ask questions on Email.
Credits 🙏
| |
