README
¶
Value Object Generator
Overview
The Value Object Generator is a command-line tool for generating value objects based on templates and configuration files. It automates the creation of value objects following the Value Object pattern from Domain-Driven Design.
Features
- Template-Based Generation: Generate value objects based on predefined templates
- Configuration-Driven: Customize value objects using JSON configuration files
- Consistent Patterns: Ensure all value objects follow the same patterns and conventions
- Boilerplate Reduction: Reduce repetitive code when creating new value objects
- Development Tool: Streamline the development process for creating value objects
Installation
go get github.com/abitofhelp/servicelib/valueobject/cmd/generate
Quick Start
To generate a value object, run the command:
go run main.go [flags]
API Documentation
Usage
The tool reads configuration from JSON files that specify the properties and behavior of the value objects to be generated. It then creates Go files with the appropriate code for these value objects.
go run main.go [flags]
Examples
For examples of value objects generated with this tool, see the following directories:
- Value Object Examples - Examples of various value objects
Best Practices
- Use Configuration Files: Store your value object configurations in JSON files
- Follow Naming Conventions: Use consistent naming for your value objects
- Generate Related Objects Together: Generate related value objects in the same package
- Review Generated Code: Always review the generated code before committing
- Keep Templates Updated: Update templates when patterns or conventions change
Troubleshooting
Common Issues
Generation Failures
If generation fails, check that your configuration file is valid JSON and contains all required fields.
Related Components
- Value Object Package - The parent value object package
- Value Object Generator - The generator package used by this tool
- Value Object Templates - Templates used for code generation
Contributing
Contributions to this component are welcome! Please see the Contributing Guide for more information.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
Overview ¶
Package main provides a command-line tool for generating value objects.
This tool automates the creation of value objects based on templates and configuration files. It leverages the valueobject/generator package to perform the actual generation of code.
Usage:
go run main.go [flags]
The tool reads configuration from JSON files that specify the properties and behavior of the value objects to be generated. It then creates Go files with the appropriate code for these value objects, following the Value Object pattern from Domain-Driven Design.
This command-line tool is primarily used during development to:
- Generate new value object types quickly and consistently
- Ensure all value objects follow the same patterns and conventions
- Reduce boilerplate code when creating new value objects
For more details on the configuration options and templates, see the documentation in the valueobject/generator package.
Package main provides a command-line tool for generating value objects.
Source Files