Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.13 KB
Raw

Contributing to Prefire

Contributions are welcome! To propose a change:

  1. Fork the repository
  2. Create a feature branch
  3. Submit a Pull Request

Development setup

Run make to list the development tasks. The ones you need most:

make build      # Build Prefire for the iOS Simulator
swift test      # Run the Prefire macOS tests
make test-ios   # Run the Prefire library tests on an iPhone simulator
make test       # Run the PrefireExecutable unit tests
make test-cli   # Run the PrefireCLI unit tests

CI runs the same commands, see .github/workflows/swift.yml.

The Example project shows Prefire in an Xcode app with a snapshot test target.

Internal architecture

  • PrefireCore — AST + preview parsing, caching, logic
  • PrefireGenerator — handles stencil templating + snapshot generation
  • PrefireCacheManager — unifies caching for Types and Previews
  • PrefireTestsPlugin / PrefirePlaybookPlugin — SPM/Xcode integrations
  • prefire — CLI entry point, calls shared generator code

Generated code comes from Stencil templates.