[FEAT] Example Package for Testing and Documentation

[bbengfort]

Scope of changes

Implements an example package that will be used for implementing the generator, testing, and serve as documentation.

Estimated PR Size:

• Tiny
• Small
• Medium
• Large
• Huge

Acceptance criteria

This PR will be merged without review.

Author checklist

• I have manually tested the change and/or added automation in the form of unit tests or integration tests
• I have updated the dependencies list
• I have added new test fixtures as needed to support added tests
• I have added or updated the documentation
• I have run go generate to update generated code

---

Note

Low Risk
Low risk: adds an example package and a placeholder cmd/enumify main that only prints environment variables, with no production logic or data handling changes.

Overview
Adds a new example package intended as a fixture for the upcoming enumify generator: two enum types (Day, Status) with go:generate directives and associated name tables, plus an unrelated Example struct and a small test to ensure the package builds.

Replaces cmd/enumify’s empty main with a minimal entrypoint that prints GOFILE/GOPACKAGE from the environment, and updates .gitignore to exclude generated example/*_gen.go files from version control.

^{Reviewed by Cursor Bugbot for commit 45ed293. Configure here.}

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 45ed293. Configure here.}

[cursor]

Test variable shadows imported package name

Low Severity

The local example variable shadows the imported example package, making the package inaccessible for further calls within TestExample. This is a confusing anti-pattern, especially in example code, and makes the test fragile if extended.

 

^{Reviewed by Cursor Bugbot for commit 45ed293. Configure here.}