turbotask/README.md

A command-line tool that Makes Handling files quick and easy.

# TurboTask File Processing Toolkit

[![npm version](https://img.shields.io/npm/v/turbotask.svg)](https://www.npmjs.com/package/turbotask)
[![License](https://img.shields.io/npm/l/turbotask.svg)](https://github.com/yourusername/turbotask/blob/main/LICENSE)

A versatile Node.js toolkit designed to simplify file processing tasks, with a focus on efficiency and ease of use.
Currently supports File Grouping and CSS minification with plans for expanded functionality including media analysis, and more.

## 🚀 Quick Start

```bash
npm install -g turbotask
```

## ✨ Features

### Current Features

- **File Grouping**
  - Automatically organize files by file type
  - Handle nested directory processing

- **CSS Processing**
  - Minify CSS files by removing comments and whitespace
  - Process single files or entire directories
  - Maintain directory structures
  - Safe processing with validation checks

### Planned Features

- Media analysis
- More file processing capabilities (coming soon)

## 📦 Installation

### NPM (Recommended) [Stable]

```bash
npm install -g turbotask
```

### Manual Installation

```bash
# Clone the repository
git clone https://github.com/Fector101/TurboTask.git

# Navigate to the project directory
cd TurboTask/nodejs

# Install dependencies
npm install -g .
```

## 🔨 Usage Guide

### File Grouping

```bash
turbotask group [optional_main_path]
```

The argument:

1. [optional_main_path] The main Folder the code will start the scan from (default is './' the folder the code is being ran from).

#### Examples For CLI Usage

```bash
# Group files in current directory
turbotask group

# Group files in specific directory
turbotask group "C:/Users/Bob/Downloads"
```

#### Examples For In-File Usage

```javascript
const {group} = require("turbotask")

// Groups are files in downloads folder
group('C:/Users/Bob/Downloads')
  .then(details=>console.log(details))
// The resulting output will resemble:
// {
//  'Number of scanned folders': 100,
//  'Number of Moved Files': 467,
//   Errors: []
// }

// Groups are files in current file directory
group('./')
```

### CSS Whitespace Removal

```bash
turbotask noWhiteSpace <input_css_path> [optional_output_path]
```

The noWhiteSpace arguments:

1. <input_css_path> can be a CSS file or Folder with CSS Files.
2. [optional_output_path] Output directory (defaults to "TurboTask-output") can be changed to a File or Folder Path

#### Examples For CLI Usage

```bash
turbotask noWhiteSpace rough.css clean.css
```

OR

```bash
turbotask noWhiteSpace ./styles ./minified
```

#### Examples For In-File Usage

```javascript
const {noWhiteSpace} = require("turbotask")
// For Single File
noWhiteSpace('main.css','main-new.css')

// For a Folder
noWhiteSpace('./styles','./minified')
noWhiteSpace('./','./minified')

// If you dont' want to Over-Write Original Files add a output folder
noWhiteSpace('','')
```

### Error Handling

The toolkit implements comprehensive error handling:

- File existence validation
- Directory creation verification
- Read/Write operation protection
- Format-specific validation (e.g., CSS comment structure)
- Colored error messages for visibility

## 🔄 Future Development

The toolkit is designed for expansion. Planned features include:

1. **File Organization**
   - Duplicate detection

2. **Media Processing**
   - Duration analysis
   - Format conversion
   - Metadata extraction

3. **General Utilities**
   - Advanced file manipulation

## 🤝 Contributing

Contributions are welcome! The modular architecture makes it easy to add new features:

1. Add new worker modules for specific file types
2. Extend helper utilities for common operations
3. Implement new CLI commands for new features

## ⚠️ Error Codes

Common error messages and their meanings:

- `<Error - [filepath] Doesn't Exist>`: File not found
- `Failed to create directory`: Permission or path issues
- Custom error messages can be specified for writeFile operations

## 🐛 Reporting Issues

Found a bug? Please open an issue on our [GitHub Issues](https://github.com/Fector101/TurboTask/issues) page.

## 📝 Notes

- The toolkit is under active development
- New features will be added progressively
- Maintains backward compatibility with existing functionality
- Focuses on safe file operations with comprehensive error handling

## ☕ Support the Project

If you find TurboTask helpful, consider buying me a coffee! Your support helps maintain and improve the project.

<a href="https://www.buymeacoffee.com/fector101" target="_blank">
  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60">
</a>

Your support helps me to:

- Maintain and improve TurboTask
- Web interface / API services
- Add new features
- Keep the project active

## 📄 License

MIT © Fabian Joseph

## Author

- Fabian - <fector101@yahoo.com>
- GitHub: <https://github.com/Fector101/TurboTask>