go-transform

A flexible Go-based text transformation tool that uses a plugin architecture to process input streams. This project follows Clean Architecture principles in general and the Dependency Inversion Principle in particular and emphasizes modularity through its plugin system.

The Dependency Inversion Principle states:

1. High-level modules should not import anything from low-level modules. Both should depend on abstractions (e.g., interfaces).
2. Abstractions should not depend on details. Details (concrete implementations) should depend on abstractions.

Features

• Plugin-based architecture for extensible text transformations
• Clean separation of concerns following Clean Architecture principles
• Simple CLI interface
• Stream-based processing for efficient handling of large inputs

Prerequisites

• Go 1.23 or later
• Make

Installation

# Clone the repository
git clone https://github.com/cekrem/go-transform.git
cd go-transform

# Build the main application and plugins
make

Usage

The tool reads from standard input and writes to standard output:

# Using the default passthrough transformer
echo "Hello, World!" | ./build/transform

# Using a specific transformer
echo "Hello, World!" | ./build/transform -transformer=passthrough

Project Structure

.
├── cmd/            # Application entrypoint
├── internal/       # Internal application code ("high-level modules" depending on abstract interfaces)
├── pkg/            # Public packages providing stable and abstract interfaces
├── plugins/        # Transformer plugins: this is where you add your own plugins ("low-level modules" depending on abstract interfaces)
└── build/          # Compiled binaries and plugins

Development

Creating New Plugins

Plugins should be created in the plugins directory and implement the transformer interface. See the passthrough plugin for an example implementation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.