GoFr-SOC: Template Track - CLI Application

[Ayazwasee]

Hey GoFr Team,

I’ll be working on a Config Validator CLI Application as part of the GoFr Summer of Code Template Track.

This application will help developers validate their .env and config.yaml files by checking for required keys and correct types (e.g., PORT is an integer, DEBUG is a boolean). It will support both plain text and JSON output and is intended to be used locally or in CI pipelines to prevent misconfiguration issues across GoFr services.

What I Plan to Build in PR 1

1. Initialize the Go project (go.mod, main.go)
2. Add the basic validate command using Cobra
3. Accept flags:
   --json (for JSON output)
   --config (to specify the config file path)
4. Print flag values for now (logic comes later)
5. Set up folder structure: cmd/, core/, formatter/
   7.Add basic README with usage instructions

Timeline & Deliverables

Week | Deliverable

Week 1 - PR 1: Project setup + CLI skeleton
Week 1 - PR 2: .env parser + required keys validator
Week 2 - PR 3: Type-checking logic (int, bool, duration)
Week 3 - PR 4: YAML config support
Week 3 - PR 5: Output formatting (text + JSON)
Week 4 - PR 6: Final tests, README, GitHub CI (optional)

I’m excited to contribute this application to the GoFr ecosystem — happy to receive any feedback before I begin!

[coolwednesday]

Hey! I really like the idea of a config validator—excited to see where you take it.

To begin with, it’d be great if you could share details on the types of checks you plan to implement. This will help ensure the validator is robust and aligns well with GoFr's standards.

You can go ahead and start building. As you progress, if you come across any limitations or missing features in GoFr, feel free to raise them as issues under the core issue thread. We’ll prioritize quick resolutions for blockers.

Also, please add me as a collaborator on your PR so I can help with timely reviews and feedback. Looking forward to your contribution!

[Ayazwasee]

Hi! Thanks so much — I'm really looking forward to implementing this and making it truly helpful for GoFr developers!

The types checks i am going to be implementing are the following:

1. Required keys – Are all necessary keys present?
2. Empty values – Are any of them present but left empty?
3. Type correctness – Do values match their expected types?
4. Summary breakdown – Total valid vs issues
5. (Optional): YAML and .env handled uniformly, based on file extension

I am still researching regarding the 5th point. If everything went successfully I will implement that as well but currently it is not included in the final product.

[Ayazwasee]

@coolwednesday I have opened few PR's already waiting for your review.