https://github.com/0xtlt/shopifythemecleaner
https://github.com/0xtlt/shopifythemecleaner
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xtlt/shopifythemecleaner
- Owner: 0xtlt
- Created: 2024-03-05T17:56:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T16:08:10.000Z (over 2 years ago)
- Last Synced: 2025-03-20T05:51:41.470Z (over 1 year ago)
- Language: Rust
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ShopifyThemeCleaner
## About
ShopifyThemeCleaner is a tool designed to clean up Shopify themes by removing unused snippet and section files. This tool helps to optimize Shopify themes by reducing clutter and potentially improving theme performance and readability.
## Features
- **Snippet Cleaning**: Removes unused snippet files from your Shopify theme.
- **Section Cleaning**: Removes unused section files from your Shopify theme.
- **Complete Clean Option**: Allows for cleaning both snippets and sections with a single command.
## Prerequisites
To use ShopifyThemeCleaner, you must have [Rust](https://www.rust-lang.org/tools/install) and [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed on your machine.
## Installation
1. Clone this repository to your local machine using:
```
git clone
```
2. Navigate to the cloned project folder.
3. Compile the project with Cargo using:
```
cargo build --release
```
4. The compiled binary will be located in `./target/release/`.
## Usage
To use ShopifyThemeCleaner, navigate to your Shopify theme folder and execute:
```
./shopify_theme_cleaner [options]
```
### Available Options
- `--clean-all`: Cleans both unused snippets and sections.
- `--clean-snippets`: Cleans only unused snippet files.
- `--clean-sections`: Cleans only unused section files.
## Next Steps
The next development phase for ShopifyThemeCleaner will involve addressing the `assets` directory, which has not yet been implemented. This addition will further enhance the theme cleaning process by removing or optimizing unused or redundant asset files.
## Contributing
Contributions are welcome! If you would like to contribute to the project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature (`git checkout -b feature/amazing-feature`).
3. Commit your changes (`git commit -am 'Add some amazing feature'`).
4. Push to the branch (`git push origin feature/amazing-feature`).
5. Open a Pull Request.