An open API service indexing awesome lists of open source software.

https://github.com/jezreal-dev/go-reloaded


https://github.com/jezreal-dev/go-reloaded

Last synced: 11 days ago
JSON representation

Awesome Lists containing this project

README

          

# Go Reloaded β€” Text Completion, Editing & Auto-Correction

[![Go Version](https://img.shields.io/badge/go-1.22+-blue.svg)](https://golang.org/doc/)
[![Build Status](https://github.com/jmomoh-source/go-reloaded/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jmomoh-source/go-reloaded/actions/workflows/ci.yml)
![Repo Size](https://img.shields.io/github/repo-size/jmomoh-source/go-reloaded)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
![Coverage](https://img.shields.io/badge/coverage-87.5%25-brightgreen)

A Go command-line tool for text processing, correction, and formatting.
It reads an input file, applies automatic corrections (number conversions, case changes, punctuation normalization, quote formatting, article correction), and outputs a cleaned file.

---

## πŸš€ Features
- **Hexadecimal β†’ Decimal conversion**
Example: `42 (hex)` β†’ `66`
- **Binary β†’ Decimal conversion**
Example: `10 (bin)` β†’ `2`
- **Case transformations** `(up)`, `(low)`, `(cap)` with optional counts `(up, N)`
Example: `Ready, set, go (up)!` β†’ `Ready, set, GO!`
- **Punctuation normalization** (commas, ellipsis, question marks, etc.)
- **Quote formatting**
Example: `' word '` β†’ `'word'`
- **Article correction**
Example: `a untold story` β†’ `an untold story`

---

## πŸ“‚ Project Structure
```
go-reloaded/
β”œβ”€β”€ .github/workflows/
β”‚ └── ci.yml
β”œβ”€β”€ docs/
β”‚ β”œβ”€β”€ Project_Management.md
β”‚ └── WALKTHROUGH.md
β”œβ”€β”€ examples/
β”‚ β”œβ”€β”€ sample.txt
β”‚ └── result.txt
β”œβ”€β”€ textprocessor/
β”‚ β”œβ”€β”€ processor.go
β”‚ └── processor_test.go
β”œβ”€β”€ CODE_OF_CONDUCT.md
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ LICENSE
β”œβ”€β”€ README.md
β”œβ”€β”€ go.mod
└── main.go
```

---

## πŸ› οΈ Usage
Run the program with an input and output file:

```bash
go run . examples/sample.txt examples/result.txt
cat examples/result.txt
```

---

## πŸ§ͺ Testing
Run all unit tests:

```bash
go test ./... -v
```

Tests are located in `textprocessor/processor_test.go`.

---

## 🀝 Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
Please also review our [Code of Conduct](CODE_OF_CONDUCT.md).

---

## πŸŽ₯ Demo
Here’s the tool in action:

![CLI Demo](examples/demo.png)

---

## πŸ“‹ Project Board
Track progress and tasks on the [Project Board](https://github.com/jmomoh-source/go-reloaded/projects)

---

## πŸ“š Lessons Learned
- Importance of idiomatic Go practices
- Writing maintainable APIs with clear documentation
- Concurrency patterns for performance
- CI/CD pipelines for reliability

---

## πŸ”— Resources
- [Go Documentation](https://golang.org/doc/)
- Effective Go [(golang.org in Bing)](https://www.bing.com/search?q="https%3A%2F%2Fgolang.org%2Fdoc%2Feffective_go")
- [Go Concurrency Patterns](https://blog.golang.org/pipelines)

---

## πŸ“Œ Status
This project was built as part of my **Learn2Earn Fellowship** and demonstrates my ability to work with Go in a production‑style environment.