README
¶
CSGen
CSGen is a Golang utility package for simplifying development of code generation tools. It contains abstractions around the standard library AST packages to make using them more intuitive for developers.
Get the Package
go get github.com/cscoding21/csgen
Core Uses
The primary use-case for the library is to get a list of all the structs in a file including details about each field.
import (
"fmt"
"github.com/cscoding21/csgen"
)
//---get all of the structs within a file.
structs, err := csgen.GetStructs("test_struct.go")
if err != nil {
panic("error loading file")
}
for _, s := range structs {
fmt.Println(s.Name)
for _, f := range s.Fields {
fmt.Println(" -- ", f.Name, f.Type)
}
}
The struct object contains information about the struct's definition as well as all fields contained within.
Struct Properties
| Property | Type | Description |
|---|---|---|
| Name | string | The name of the struct |
| Type | string | The type of the struct |
| FilePath | string | The path to the file containing the struct |
| Package | string | The package the struct is contained within |
| Fields | []Field | The list of fields contained within the struct |
Additionally, a struct has a GetField(name string) method that will return an individual field object by its name.
Field Properties
| Property | Type | Description |
|---|---|---|
| Name | string | The name of the field |
| Type | string | The type of the field |
| TagString | string | The tag string for the field |
| IsPrimitive | bool | True if the field is a primitive type |
| IsPointer | bool | True if the field is defined as a pointer to value |
| IsSlice | bool | True if the field is a slice |
| IsPublic | bool | True if the field is available outside the package |
Additionally, a field has a GetTag(name string) method. This method can be used to extract the value of an individual tag from the tag string. For example, consider the tag string json:"email" csval:"req,email".
s.GetTag("json") //---returns "email"
s.GetTag("caval") //---returns "req,email"
Documentation
¶
Index ¶
- func ExecuteTemplate[T any](name string, fileTemplate string, om T) string
- func ExtractPackageName(name string) string
- func GetAST(filePath string) (*ast.File, error)
- func GetFieldIndicator(source Field, target Field) string
- func GetFile(file ...string) string
- func GetFileName(imp string, path string, name string) string
- func GetImports(filePath string) ([]string, error)
- func GetRawType(t string) string
- func IsFullyQualifiedPackage(name string) bool
- func IsPrimitive(t string) bool
- func IsPublic(t string) bool
- func IsRefType(t string) bool
- func IsSlice(t string) bool
- func NewCSGenBuilderForFile(name string, pkg string) *strings.Builder
- func ProfileNode(node ast.Node)
- func StripPackageName(name string) string
- func WriteGeneratedGoFile(name string, contents string) error
- type Field
- type Function
- type Interface
- type Struct
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExecuteTemplate ¶
ExecuteTemplate executes a template against a given object and return the output as a string
func ExtractPackageName ¶ added in v0.2.1
ExtractPackageName return the package name from a fully qualified name
func GetFieldIndicator ¶ added in v0.2.1
GetFieldIndicator for creating an assignment operations, returns an indicator for the field based on the type of the source and target
func GetFileName ¶ added in v0.2.1
GetFileName return a file name suffixed with ".gen.go" to indicate that is was generated
func GetImports ¶
GetImports returns all of the imports in a given file
func GetRawType ¶ added in v0.2.1
GetRawType return the raw type of a type, removing the pointer, reference and slice indicators
func IsFullyQualifiedPackage ¶ added in v0.2.1
IsFullyQualifiedPackage return true if the package name is fully qualified
func IsPrimitive ¶ added in v0.2.1
IsPrimitive return true if the type is a primitive
func NewCSGenBuilderForFile ¶
NewCSGenBuilderForFile returns a string buider with a common header for generated files
func ProfileNode ¶
ProfileNode get details about an unknown node based on its actual type
func StripPackageName ¶ added in v0.2.1
StripPackageName removes the package name from a fully qualified name
func WriteGeneratedGoFile ¶
WriteGeneratedGoFile create a text file with the passed in name and contents
Types ¶
type Field ¶
type Field struct {
Name string
Type string
TagString string
IsPrimitive bool
IsPointer bool
IsSlice bool
IsPublic bool
}
Field a struct that represents a single field within a struct abstraction
func GetVariables ¶
GetVariables returns a list of all variable definitions in a given file
type Function ¶
type Function struct {
Name string
Receiver *string
Arguments []Field
Returns []Field
IsPublic bool
}
Function a struct that represents a single function abstraction
func GetFunctions ¶
GetFunctions returns all of the functions in a given file
type Interface ¶
Interface a struct that represents a single interface abstraction
func GetInterfaces ¶
GetInterfaces get a list of all declared interfaces in a given file
type Struct ¶
Struct a struct that abstracts a golang struct
func GetStructByName ¶ added in v0.2.1
GetStructByName given a slice of structs, return one if it matches the name
func GetStructs ¶
GetStructs return a list of all structs in a given file
func (*Struct) ContainsField ¶ added in v0.2.1
ContainsField returns true if the struct contains a field with the passed in name
Source Files