README
¶
fsm
fsm is a command line tool that generates finite state machine for Go struct.
Usage
FSM generation
Usage: fsm gen -p ./examples/transitions -s Order -f State -o order_fsm.go -t ./examples/transitions/transitions.json
--package, -p package where struct is located (default: default is current dir(.))
--struct, -s struct name
--field, -f state field of struct
--output, -o output file name (default: default srcdir/<struct>_fsm.go)
--transitions, -t path to file with transitions
--noGenerate, -g don't put //go:generate instruction to the generated code (default: false)
--graph-output, -a value path to transition graph file in dot format
This will generate finite state machine for struct Order with transitions defined in ./examples/transitions/transitions.json file. Transition graph will be generated from transitions file and output will be in dot format
Action generation
Usage: fsm actions gen --tpl examples/transitions/action.go.tpl -o examples/transitions/actions -t examples/transitions/transitions.json
--template value, --tpl value template for action
--output_dir value, -o value output dir
--transitions value, -t value path to file with transitions
This will generate actions stubs from ./examples/transitions/action.go.tpl file.
Action doc generation
Usage: fsm actions doc -o examples/transitions/actions/README.md -t examples/transitions/transitions.json
--output value, -o value output file name
--transitions value, -t value path to file with transitions
This will generate actions doc README.md from transitions file.
Further runs of the command will add only new actions and update the Transitions where action appears section.
Install
Using go
go get -u github.com/MrEhbr/fsm/cmd/fsm
Download releases
https://github.com/MrEhbr/fsm/releases
License
© 2020 [Alexey Burmistrov]
Licensed under the Apache License, Version 2.0 (LICENSE). See the COPYRIGHT file for more details.
SPDX-License-Identifier: Apache-2.0
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ToCamelCase ¶
ToCamelCase transform string to upper or lower camel case
func ToSnackCase ¶
Types ¶
type Generator ¶
type Generator struct {
Options
// contains filtered or unexported fields
}
Generator generates finite state machine
func NewGenerator ¶
NewGenerator returns a pointer to Generator
type Options ¶
type Options struct {
// InputPackage is an import path or a relative path of the package that contains the source struct
InputPackage string
// OutputFile name for output file
OutputFile string
// Struct is name of struct
Struct string
// StateField is name of struct field that indicate state
StateField string
// TransitionsFile is path to file which hold supported transitions
TransitionsFile string
// DisableGoGenerate don't put go generate
DisableGoGenerate bool
// ActionGraphOutputFile path to action graph file
ActionGraphOutputFile string
}
Options for NewGenerator constructor
type StateValue ¶
StateValue represents state field values
type Struct ¶
type Struct struct {
Name string
StateField string
StateType string
StateValues []StateValue
Transitions Transitions
}
Struct represent struct data
type Transition ¶
type Transition struct {
From stringArray `json:"from" yaml:"from"`
To string `json:"to" yaml:"to"`
Event string `json:"event" yaml:"event"`
BeforeActions []string `json:"before_actions" yaml:"before_actions"`
Actions []string `json:"actions" yaml:"actions"`
}
Transition represent fsm state transition
func (Transition) String ¶
func (t Transition) String() string
type Transitions ¶
type Transitions []Transition
Transitions slice of Transition
func (Transitions) ActionTransitions ¶
func (trs Transitions) ActionTransitions(action string) []Transition
func (Transitions) Actions ¶
func (trs Transitions) Actions() []string
Actions return unique slice of actions
func (Transitions) Events ¶
func (trs Transitions) Events() []string
func (Transitions) Graph ¶
func (trs Transitions) Graph() *graphman.Graph
Source Files
Directories