Create-Clean

Create-Clean is a versatile development utility designed to help developers clean up and optimize their projects. It provides a variety of operations, such as removing local file references in README.md, deleting unnecessary files and folders (e.g., .DS_Store, node_modules), formatting code, and compressing image resources.

Table of Contents

• Create-Clean
  • Table of Contents
  • Features
  • Usage
    • Clean README.md
      • Example Output:
    • Delete node_modules
      • Example Output:
    • Clean .DS_Store Files
      • Example Output:
    • Clean Cache Folders
      • Example Output:
    • Format Code
      • Example Output:
    • Compress Images
      • Example Output:
  • Contributing
  • License
  • Support

Features

1. Clean Local File References in README.md:

   • Removes links to local files (e.g., file://) from the README.md file.

2. Delete node_modules Folder:

   • Recursively deletes the node_modules folder to free up space.

3. Clean .DS_Store Files:

   • Finds and removes all .DS_Store files in the project directory.

4. Clean Cache Folders:

   • Deletes common cache folders like .cache and .tmp.

5. Auto-Format Code:

   • Uses Prettier to format JavaScript, TypeScript, and JSON files.

6. Compress Images:

   • Optimizes image files (.jpg, .jpeg, .png) using imagemin.

Usage

To use this tool, ensure you have Node.js installed on your system. Then, run the tool directly:

npm init clean

You will be presented with an interactive menu to select the desired operation.

Clean README.md

Removes local file references (e.g., file://) from the README.md file.

Example Output:

✔ Successfully cleaned README.md

Delete node_modules

Deletes the node_modules folder recursively.

Example Output:

✔ Successfully deleted node_modules

Clean .DS_Store Files

Finds and removes all .DS_Store files in the project directory.

Example Output:

✔ Deleted: ./someFolder/.DS_Store
✔ Successfully cleaned 1 .DS_Store files.

Clean Cache Folders

Deletes common cache folders like .cache and .tmp.

Example Output:

✔ Deleted: ./.cache
✔ Successfully cleaned 1 cache folders.

Format Code

Automatically formats JavaScript, TypeScript, and JSON files using Prettier.

Example Output:

✔ Formatted: ./index.js
✔ Successfully formatted 1 code files.

Compress Images

Optimizes image files (.jpg, .jpeg, .png) using imagemin.

Example Output:

✔ Compressed: ./images/example.jpg
✔ Successfully compressed 1 image files.

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -m "Add some feature").
4. Push the branch (git push origin feature/your-feature-name).
5. Open a pull request.

License

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

Support

If you encounter any issues or have suggestions for improvement, feel free to open an issue or contact us.

希望这份简化的 README.md 能够满足您的需求！如果有其他补充或修改需求，请随时告知。