Hofstadter Documentation
Welcome to the documentation site.
hof is a code generation framework
hof combines CUE, data, and templates to generate any file.
Reusable and modular generators can be created
to help you write and maintain large amounts of code.
The data layer helps you manage configuration and models so
you create code which is resilent to version skew.
Creators enable you to provide one-line commands to your users,
and they will get an interactive prompt for getting started with your projects.
The module system will help you manage dependencies
and make your hof projects easily available to others.
- code generation - data + template = _ (anything) - technology agnostic
- generators - reusable and modular code generation configuration
- data layer - define, manage, and migrate data models
- creators - interactive prompts for bootstrapping projects
- modules - dependency management for CUE and your hof code
There are two modes to use hof
- creating applications (green boxes)
- building reusable modules (blue boxes)
Like most languages and frameworks, there are two types of users.
Most users will build applications for some purpose, using libraries written by others.
A smaller number will build reusable modules, like the packages and libraries you use today.
hof has the same for same relationship for code generators modules.
All modules exist outside of the hof tool and just need to be a git repository.
Designed to augment your workflows
hof is a CLI tool you will add to your workflows.
We know developers have their own preferences
for tools, languages, and platforms.
hof can work with any of them.
You will typically use hof at development time,
committing the generated code to git.
hof is technology agnostic.
You can generate code for any language or technology,
and more often than not you will generate several together.
From your data models, the source of truth,
hof can generate consistent code across the stack.
hof captures common patterns and boilerplate.
Through the templates and code generation modules,
so we can remove much of the repetitive tasks and coding effort.
Updates to the data model can be replicated instantly through the stack.
hof modules span technologies.
With composable modules, we can create full-stack applications
and the infrastructure to run them by importing from the ecosystem.
Logical application features can be composed
as bigger building blocks from any language, framework, or tool.
hof continues to work as your model evolves.
Rather than a one-time bootstrapping at the beginning of development,
you can update your designs or data model and regenerate code.
Think of code generated with hof as living boilerplate or scaffolding.
You can also add custom code directly in the output
and hof will ensure it stays as you regenerate your application.
We call this High Code development.
Creating code with higher levels of design, reuse, and implementation
What can you do with hof?
Generate anything
Applications all start as files and hof generates directories of files.
You can generate the source files, configuration, deployment, and CI files needed.
If it’s made of files, you can generate it with hof.
Consolidate the data model
The same data model appears at each level of the tech stack. You should only have to write it down once, as a single-source of truth. More than just the shape, this should also include the rules.
Capture common code and application patterns
Whether it is writing api handlers, CRUD, client libraries, or data validation, there are many patterns per data model. There are also application wide patterns. When starting server setup like logging and wiring up the router.
Manage model and application versions.
Data models evolve with an application and need management. From updating the code and databased to deployment updates and supporting older clients, you can have multiple versions being referenced. You latest backend will need to handle many previous versions.
Work directly in the (re)generated code
With hof you write custom code directly in the generated output,
where it naturally belongs. Your final code should look the same.
When you change your data model or designs, hof uses diff3
to ensure your code is left in place and
Share and control modules with dependency management
Sharing models and code generation is core to hof
and central to solving problems of interoperability between
different teams and services.
Both design and generators are managed with versions
and dependency management.
Apply fleet wide fixes and updates
Deploying shared security and bug fixes across many applications should be easier. This should apply equally for improvements in our code patterns and practices.
Extensible generators and models
Both generators and models can be combined through dependencies and imports.
You can extend, override, or otherwise customize as you need.
They are separate from the tool so there is no need to change hof
to enable new technologies or patterns.