Documentation
¶
Overview ¶
Copyright © 2024-2025 Morten Hersson <mhersson@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Index ¶
- type Generator
- func (g *Generator) ExecuteTemplate(filename string) ([]byte, error)
- func (g *Generator) Exists(path string) (bool, error)
- func (g *Generator) FormatCode(path string) error
- func (g *Generator) IncrementalUpdate(fullpath string, data []byte) ([]byte, bool, error)
- func (g *Generator) WriteFile(path string, data []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct {
FS afero.Fs
Shell shell.Interface
FSM *uml.FSM
APIKind string
APIVersion string
Group string
Module string
Package string
RelativePath string
Version string
Init bool
}
func (*Generator) ExecuteTemplate ¶
func (*Generator) FormatCode ¶
Format the generated code.
func (*Generator) IncrementalUpdate ¶
IncrementalUpdate compares the generated code with the existing code. if any of the functions in the generated code are not in the existing code add them. If any functions are in the existing code and not in the generated code, and have a doc comment prefixed with '// +vectorsigma' remove them from the existing code. If any functions are in both trees, replace the existing code with the generated code if the existing code still contains a `// TODO: Impment me!` comment in the function body.