Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 3.79 KB

README.md

File metadata and controls

102 lines (72 loc) · 3.79 KB
Raw


Logo

Project Cleaner

Description • Installation • Usage • About .cleaner Files • License

Guard image

Description

ProjectCleaner is a utility tool developed using the WPF-UI framework to help users clean and organize their project directories. It simplifies the process of removing unnecessary files and folders from a project, making it easier to share or archive projects effectively.

Installation

To use Project Cleaner, follow these steps:

  1. Clone the repository to your local machine.
  2. Open the solution file in Visual Studio.
  3. Build the solution to ensure all necessary dependencies are restored.
  4. Run the application within the development environment or deploy it to a target environment as needed.

Usage

  1. Launch the Project Cleaner application.
  2. Select a project directory that you want to clean.
  3. Choose a .cleaner file that contains the rules for cleaning the project.
  4. Click on the "Clean Project" button to apply the cleaning rules to the selected project directory.
  5. Use the "Zip Project" button to create a compressed backup of the cleaned project.

About .cleaner Files

.cleaner files are text files that contain rules for cleaning project directories. These rules specify patterns that are used to identify files and directories that should be removed during the cleaning process. Each rule in a .cleaner file can target specific file types, directories, or files with specific naming patterns. The tool processes these rules sequentially to perform the cleaning operations.

Structure

The structure of a .cleaner file typically consists of one rule per line. Each rule can be one of the following types:

  1. File patterns using wildcards: You can use wildcards to specify certain types of files to be removed. For example:

    *.txt
*.exe

  2. Directory patterns using regular expressions: You can specify directory patterns using regular expressions to target specific directories for removal. For instance:

    [Bb]in/
[Oo]bj/

  3. Comments: You can provide explanations or context for specific rules in the file using comments. Comments start with the # character. For example:

    # This rule removes all log files
*.log

  4. Special characters for matching: Special characters like asterisks (*) for wildcard matches and forward slashes (/) for denoting directories can be used. For example:

    # Remove all temporary files
*tmp*

  5. Mixed rules: You can combine these different types of rules in a single .cleaner file for comprehensive cleaning operations. Here's an example of a complete .cleaner file:

    # Remove all temporary files
*tmp*

# Remove all log files
*.log

# Remove directories
[Bb]in/
[Oo]bj/

License

This project is licensed under the MIT License - see the LICENSE file for details.

(Back to top)

GitHub @AlecInfo  ·